1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

# PostgreSQL

This is a module for [Project Forge](https://projectforge.dev). It provides an API for accessing PostgreSQL databases.

https://github.com/kyleu/projectforge/tree/master/module/postgres

### License

Licensed under [CC0](https://creativecommons.org/publicdomain/zero/1.0)

### Usage

- To configure a Postgres connection pool, call `database.OpenPostgresDatabase`, passing `PostgresParams`
- You can load the params from the environment by calling `PostgresParamsFromEnv` (with optional prefix), this will read the following by default:
  - `DB_HOST` - hostname to use, defaults to `localhost`
  - `DB_PORT` - port to use, defaults to 5432
  - `DB_USER` - username for connections
  - `DB_PASSWORD` - password for connections (optional)
  - `DB_DATABASE` - database to use
  - `DB_SCHEMA` - schema to use (optional)
  - `DB_MAX_CONNECTIONS` - max active and idle connections
  - `DB_DEBUG` - if set to `true`, will log all statements and parameters