Medic Postgres

An extension pack for using medic with Postgres.

This provides a set of checks and shell scripts for managing separate postgres instances per project. It is built to work with medic, though its scripts may be used in isolation.

Installation

brew tap synchronal/tap
brew install medic-ext-postgres

Example Brewfile:

tap 'synchronal/tap'

brew  'synchronal/tap/medic'
brew  'synchronal/tap/medic-ext-postgres'

Usage

[doctor]

checks = [
  # ...
  { check = "postgres", command = "running", args = { remedy = "bin/dev/db-start", user = "${USER}"} },
  { check = "postgres", command = "role-exists", args = { role = "postgres", user = "${USER}" } },
  { check = "postgres", command = "data-directory", args = { data-directory = "./priv/postgres/data", remedy = "bin/dev/db-restart" } },
  { check = "postgres", command = "database-exists", args = { dbname = "my_app_dev", remedy = "mix ecto.reset" } },
  # ...
]

Configuration

The checks that work with medic-rs are configured via arguments and/or environment variables, and can work in concert with tools such as direnv.

The shell scripts can be configured via the following environment vairables:

• PGDATA - the Postgres data directory, as used by pg_ctl. Takes precedence over PG_ROOT. When set without PG_ROOT, the log file goes in its parent directory.
• PG_ROOT - the parent of the data directory ($PG_ROOT/data) and log file ($PG_ROOT/logfile). Defaults to ./priv/postgres.
• PGPORT - the port on which to start Postgres. This defaults to 5432.

Usage with environment variable managers

When used with a combination of mise and direnv, mise wins out in the shell, and always sets PGDATA when used in combination with its postgres extension.

To set the data directory when mise is in the shell, the environment may be set with .config/mise.toml:

[env]
PGDATA = "{{env.PWD}}/priv/postgres/data"

medic-check-postgres

Checks for whether a Postgres database is set up for development.

All checks take the following arguments:

• dbname - string - name of the database to connect to when accessing Postgres.
• connect-timeout - integer - seconds to wait before failing to connect.
• host - string - defaults to localhost or to the value of PGHOST.
• password - string - defaults to postgres or to the value of PGPASSWORD.
• port - integer - defaults to 5432 or to the value of PGPORT.
• sslmode - string - defaults to prefer.
• user - string - defaults to postgres or the value of PGUSER.
• remedy - string - an optional remedy which will override any default remedies.

data-directory

Where is the data directory for the given Postgres instances?

Required arguments:

• data-directory - absolute or relative path to the expected data directory. Defaults to PGDATA.

medic-check-postgres data-directory --data-directory <path>

database-exists

Does the given database exist?

Required arguments:

• dbname

medic-check-postgres database-exists --dbname <name>

role-exists

Does the give role exists in the database?

Required arguments:

• role - the name of the role that should be present.

medic-check-postgres role-exists --role <name>

running

Is postgres running on the given port? Note that this connects to the database in order to run its check, so must be given valid credentials.

medic-check-postgres running

shell scripts

This package also includes a number of shell scripts.

• medic-pg-start
• medic-pg-stop
• medic-pg-restart
• medic-pg-list