Interface PostgresInstanceOptions

Postgres does not allow binaries to be run by root. In case you're running in root-only environments, such as Docker containers, you may need to create an extra user on your system in order to be able to call the binaries.

NOTE: This WILL irreversibly modify your host system. The effects are somewhat minor, but it's still recommend to only use this in Docker containers.

Defaults to false.

The location where the data should be persisted to. Defaults to: ./data/db

Pass any additional flags to the initdb process. You can find all available flags here: https://www.postgresql.org/docs/current/app-initdb.html. Flags should be passed as a string array, e.g. ["--debug"] or ["--locale=en-GB"]

Defaults to []

Pass in a custom error logging handler. This will catch and stderr results coming in from the postgres and initdb processes. Defaults to console.error

Pass in a custom logging handler. This will relay and console messages that are generated by the postgres and initdb processes. Defaults to console.log

Whether to overwrite the databaseDir if it exist. Defaults to false.

The password for logging into the Postgres database. Defaults to password

Whether all data should be left in place when the database is shut down. Defaults to true.

The port where the Postgres database should be listening. Defaults to a random port

Pass any additional flags to the postgres process. You can find all available flags here: https://www.postgresql.org/docs/current/app-postgres.html. Flags should be passed as a string array, e.g. ["--debug"] or ["--locale=en-GB"].

Defaults to [].

The username for logging into the Postgres database. Defaults to postgres