Skip to content

README.md

Latest commit

 

History

History
87 lines (62 loc) · 2.8 KB

README.md

File metadata and controls

87 lines (62 loc) · 2.8 KB

PostgreSQL Provider

The PostgreSQL provider uses the official PostgreSQL image and keeps PostgreSQL SQL separate from the SQL Server scripts. The provider shares the kit's bootstrap lifecycle, but not the SQL dialect.

At a Glance

Item Value
Base image postgres:16
Published image ghcr.io/anthonypwatts/sqldockerdeploykit/database-container-postgres:main
Local port 5432
Database moviesdb
Username postgres
Password environment variable POSTGRES_PASSWORD
Bootstrap scripts providers/postgres/scripts/*.sql
Smoke query providers/postgres/smoke-query.sql

Run the Published Image

Run the published PostgreSQL image from GHCR:

docker pull ghcr.io/anthonypwatts/sqldockerdeploykit/database-container-postgres:main
docker run --name sqldockerdeploykit-postgres -d -p 5432:5432 -e "POSTGRES_PASSWORD=YourStrong!Passw0rd" ghcr.io/anthonypwatts/sqldockerdeploykit/database-container-postgres:main

Build Locally

Or build and run from the repository root:

docker build -t sqldockerdeploykit-postgres -f providers/postgres/Dockerfile .
docker run --name sqldockerdeploykit-postgres -d -p 5432:5432 -e "POSTGRES_PASSWORD=YourStrong!Passw0rd" sqldockerdeploykit-postgres

Smoke Query

Run the provider smoke query from inside the container:

docker exec sqldockerdeploykit-postgres psql -U postgres -d moviesdb -f /usr/local/share/sqldockerdeploykit/smoke-query.sql

Azure Deployment

Deploy the published PostgreSQL image to Azure Container Instances by selecting the PostgreSQL provider in the shared templates:

terraform plan -var "database_provider=postgres" -var "sa_password=YourStrong!Passw0rd"
terraform apply -var "database_provider=postgres" -var "sa_password=YourStrong!Passw0rd"

For ARM deployments, set databaseProvider to postgres. The shared password parameter is mapped to POSTGRES_PASSWORD.

Connection Details

  • Host: localhost
  • Port: 5432
  • Database: moviesdb
  • Username: postgres
  • Password environment variable: POSTGRES_PASSWORD
  • Bootstrap scripts: providers/postgres/scripts/*.sql, executed by the official PostgreSQL entrypoint on first database initialisation

Readiness

  • the image includes a Docker HEALTHCHECK using pg_isready;
  • the official PostgreSQL entrypoint runs bootstrap scripts before the server is ready for normal use.

PostgreSQL only runs files in /docker-entrypoint-initdb.d when the data directory is empty. If you mount a persistent volume, remove or recreate that volume before expecting bootstrap scripts to run again.

Run the CI-style smoke helper against a locally built image:

bash scripts/smoke-test-provider.sh postgres sqldockerdeploykit-postgres

Cleanup

docker rm -f sqldockerdeploykit-postgres