Skip to content

rgeraskin/dump_psql_roles_grants

Repository files navigation

Dump Postgres Roles and Grants

Install

You can choose

  • plain python package dump-psql-roles-grants that requires libpq system library
  • or package dump-psql-roles-grants[binary] that have binaries included

pipx (preferred)

pipx install 'dump-psql-roles-grants[binary]'
dump_psql_roles_grants --help

brew

brew install rgeraskin/homebrew/dump-psql-roles-grants
dump_psql_roles_grants --help

pip

pip install 'dump-psql-roles-grants[binary]'
python -m dump_psql_roles_grants --help

docker

docker pull rgeraskin/dump_psql_roles_grants
docker run --name dump_psql_roles_grants --rm rgeraskin/dump_psql_roles_grants --help

Usage

  1. Generate an example config file dump_psql_roles_grants gen-example-config -o config.yaml

  2. Place instances connection info to _inputs dir

    _inputs/
    ├── dev.yaml
    ├── prod.yaml
    ├── stage.yaml
    └── test.yaml

    File format: yaml or json

    <INSTANCE NAME 1>:
      dbname: <DB TO CONNECT>
      host: <INSTANCE HOSTNAME>
      password: <PASSWORD>
      user: <USER NAME>
    
    <INSTANCE NAME X>:
      dbname: <DB TO CONNECT>
      host: <INSTANCE HOSTNAME>
      password: <PASSWORD>
      user: <USER NAME>
  3. Review config.yaml

  4. Run

    dump_psql_roles_grants --help