https://github.com/big-data-forge/postgres-worksheet
Preconfigured containerized environment for working with PostgreSQL database infrastructure using PgBouncer and pgAdmin with custom setup.
https://github.com/big-data-forge/postgres-worksheet
containerization docker docker-compose pgadmin pgbouncer postgres postgres-database postgres-docker postgresql postgresql-database sandbox worksheet
Last synced: about 1 month ago
JSON representation
Preconfigured containerized environment for working with PostgreSQL database infrastructure using PgBouncer and pgAdmin with custom setup.
- Host: GitHub
- URL: https://github.com/big-data-forge/postgres-worksheet
- Owner: Big-Data-Forge
- License: mit
- Created: 2025-01-05T19:10:20.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-21T14:07:41.000Z (3 months ago)
- Last Synced: 2025-01-21T15:22:27.487Z (3 months ago)
- Topics: containerization, docker, docker-compose, pgadmin, pgbouncer, postgres, postgres-database, postgres-docker, postgresql, postgresql-database, sandbox, worksheet
- Homepage:
- Size: 26.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.docker.com/)
[](https://docs.docker.com/compose/)
[](https://www.postgresql.org/)
[](https://www.pgbouncer.org/)
[](https://www.pgadmin.org/)
# Postgres worksheet
This project provides a preconfigured environment for working with PostgreSQL database infrastructure using Docker Compose.
It includes the following services:
+ [PostgreSQL](https://www.postgresql.org/) - the primary database service with custom configuration;
+ [PgBouncer](https://www.pgbouncer.org/) - a lightweight connection pooler for PostgreSQL;
+ [pgAdmin](https://www.pgadmin.org/) - a web-based PostgreSQL database management tool.
## Architecture
### Components
### Features
This preconfigured project environment provides the following features:
+ **PostgreSQL**
+ Custom configuration through a mounted `postgresql.conf` file;
+ Automated data model creation with scripts from mounted `docker-entrypoint-initdb.d` folder;
+ Persistent data model storage via volumes;
+ Resources optimal setup - CPU (2) and memory (4G);
+ Health checks to ensure the database is ready before other services start;
+ Isolated in the internal Docker network;
+ **PgBouncer**;
+ Connection pooling for database to optimize resource usage;
+ SCRAM-SHA-256 authentication for secure connections;
+ Resources optimal setup - CPU (0.5) and memory (1G);
+ Accessible via the external Docker network;
+ **pgAdmin**;
+ Persistent configurations storage via volumes;
+ Resources optimal setup - CPU (0.5) and memory (1G);
### Data model
In this project, an e-commerce data model is implemented by default to manage customers, products and related orders.
The data model is created automatically when the database is first started and is populated with synthetic records:
+ Customers - [table](config/postgresql/scripts/01-create-0001-customers-table.sql) with information about 10,000 [randomly generated](config/postgresql/scripts/02-fill-0001-customers-table.sql) customers;
+ Products - [table](config/postgresql/scripts/01-create-0002-products-table.sql) with information about 100,000 [randomly generated](config/postgresql/scripts/02-fill-0002-products-table.sql) products;
+ Orders - [table](config/postgresql/scripts/01-create-0003-orders-table.sql) with information about 1,000,000 [randomly generated](config/postgresql/scripts/02-fill-0003-orders-table.sql) orders;
## Usage
### Prerequisites
Make sure you have [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) installed on your machine.
### Setup
Project uses an `.env` file with environment variables to manage configurations and tool settings.
The file should be created using the `.env.example` file provided in the root directory using the following command:
```shell
cp .env.example .env
```
And then filled with the corresponding values:
```dotenv
POSTGRES_DB=
POSTGRES_USER=
POSTGRES_PASSWORD=
PGADMIN_DEFAULT_EMAIL=
PGADMIN_DEFAULT_PASSWORD=
POSTGRESQL_HOST=postgres
POSTGRESQL_PORT=5432
```
### Run
Build and start the database services infrastructure by running:
```shell
docker compose up -d --build
```
> [!NOTE]
> First run will take some time, as all necessary docker images will be loaded and the data model will be created and populated with synthetic records.
Check that all services are successfully started by running:
```shell
docker compose ps
```
To stop all running services, execute:
```shell
docker compose down
```
> [!NOTE]
> After stopping the services, the data will not be deleted and will be available when the services are restarted.
If you want to stop the services and remove all associated data use:
```shell
docker compose down --volumes
```
> [!WARNING]
> This command deletes all service data (e.g. data model, stored passwords and configurations).
## License
This project is licensed under the [MIT License](LICENSE).