README
¶
Persistence Layer and Database Schema
This document outlines the data storage architecture, migration workflows, and seeding strategies for the PostgreSQL primary transactional database.
PostgreSQL Configuration
The system utilizes PostgreSQL 17-alpine as its primary OLTP store, configured for high-availability using a primary-replica topology.
Logical Schema Organization
- Authentication: Identity stores, role-based access control (RBAC), and session metadata.
- Core Transactions: Atomic records of all financial events including status, type, and cross-reference identifiers.
- Balances: Real-time ledger accounting for all user and merchant entities.
Migration Framework
Schema evolutions are managed using the goose migration tool. All migrations are version-controlled and idempotent.
To apply migrations locally:
just migrate
Migrations are located in pkg/database/migrations/.
Data Seeding Strategy
For performance testing and development parity, a high-volume seeding engine is implemented.
- Go Seeders: Programmatic data generation located in
pkg/database/seeder/. - SQL Seeds: A high-fidelity
seeder.sqlcontaining a baseline of 100+ users and 1,500+ heterogeneous records.
To seed the database:
just seeder
Connection Pooling
PgBouncer is utilized for server-side connection pooling to prevent saturation of the PostgreSQL backend during high-concurrency event bursts. All microservices connect to PostgreSQL via the pgbouncer service endpoint.
Documentation
¶
Index ¶
- func IsUniqueViolation(err error) bool
- func NewClient(logger logger.LoggerInterface) (*pgxpool.Pool, error)
- func NewClientA(logger logger.LoggerInterface) (*pgxpool.Pool, error)
- func NewClientB(logger logger.LoggerInterface) (*pgxpool.Pool, error)
- func NewClientC(logger logger.LoggerInterface) (*pgxpool.Pool, error)
- func NewClientD(logger logger.LoggerInterface) (*pgxpool.Pool, error)
- func NewClientWithPrefix(logger logger.LoggerInterface, prefix string) (*pgxpool.Pool, error)
- func RunMigrations(log logger.LoggerInterface, path string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsUniqueViolation ¶
IsUniqueViolation reports whether err is a PostgreSQL unique constraint violation (SQLSTATE 23505).
func NewClientA ¶
func NewClientA(logger logger.LoggerInterface) (*pgxpool.Pool, error)
func NewClientB ¶
func NewClientB(logger logger.LoggerInterface) (*pgxpool.Pool, error)
func NewClientC ¶
func NewClientC(logger logger.LoggerInterface) (*pgxpool.Pool, error)
func NewClientD ¶
func NewClientD(logger logger.LoggerInterface) (*pgxpool.Pool, error)
func NewClientWithPrefix ¶
func RunMigrations ¶
func RunMigrations(log logger.LoggerInterface, path string) error
RunMigrations executes database migrations using goose. path: directory containing migration files.
Types ¶
This section is empty.
Source Files
Directories