This directory contains most of the "runbooks" and documentation on how to use this repository.
You probably want to start with the starting guide. Then,
learn how to play with postgres in the build guide.
- Nix tree structure - Overview of the Nix directory structure
- Development Workflow - Complete development and testing workflow
- Build PostgreSQL - Building PostgreSQL from source
- Receipt Files - Understanding build receipts
- Start Client/Server - Running PostgreSQL client and server
- Docker - Docker integration and usage
- Multigres image - Building the multigres Docker image
- Docker Image Size Analyzer - Tool to analyze the Docker image sizes
- Formatting and pre-commit hooks - Code formatting with treefmt and git hooks
- Create a New pgrx Extension - How to set up a new cargo pgrx extension
- Updating pgrx Extensions - How to upgrade the cargo pgrx extensions
- Adding New Packages - How to add new PostgreSQL extensions
- Update Extensions - How to update existing extensions
- Update Nix Dependecies - How to update the Nix dependencies
- New Major PostgreSQL - Adding support for new PostgreSQL versions
- Site Profile - The site profile deployed to instances
- Adding Tests - How to add tests for extensions
- Migration Tests - Testing database migrations
- Testing PG Upgrade Scripts - Testing PostgreSQL upgrades
- Docker Image testing - How to test the docker images against the pg_regress test suite.
- Nix Build Matrix - Understand how the CI Nix build matrix works
- References - Useful links and resources
The docs are Markdown in nix/docs, rendered with mkdocs. Run serve-nix-doc in a development shell to preview them at http://localhost:8000. The configuration is in nix/mkdocs.yml.