The purpose of this module is to provide a set of common operations for persistent storage of data, using a PostgreSQL database. Database operations are implemented using postgresdb with node-postgres.
The scripts folder provides a way to initialize a database to use with the
operations defined here. It uses Docker
to create a container with an empty "fluid_prefsdb" database. If you have
Docker installed, then running the startup script will download the postgresdb
docker image and launch it with the following configuration:
| Envionment variable | Default Value | Description |
|---|---|---|
POSTGRES_MAIN_CONTAINER |
postgresdb |
The main Docker container running the postgresdb interface |
PGPORT |
5432 |
Postgres TCP port for accessing the database |
PG_USER |
admin |
User that has admin privileges for all tables in the database |
PGPASSWORD |
asecretpassword |
User's password |
WARNING: The script described below uses Docker to start a container based on the Postgres docker image, and it will download the image if it is not on the system. The Docker image is about 160 MB.
Use the provided script to start up a container running PostGres and initialize
an empty fluid_prefsdb database. The script uses the configuration described
above, but the values can be overridden by setting up the appropriate
environment variables (see below for an example). The script is in the
scripts folder and is run as follows:
startDockerPostgres.shIf you wish to change, for example, the Postgres TCP port PGPORT, execute
the script as follows:
export PGPORT=5433; startDockerPostgres.shWhen you wish to shut down the database and its container, use the stop
script:
stopDockerPostgres.shThe only environment variable that the shut down script relies on is the main
container name, POSTGRES_MAIN_CONTAINER.
Documentation on database operations can be found in the
docs folder.