Postgres

Prerequisites

Follow installation instructions here

We strongly advise to create a dedicated user to extract your metadata.

You can follow those instructions to create the catalog user.

Run extraction script

Once the package has been installed, you should be able to run the following command in your terminal:

castor-extract-postgres [arguments]

The script will run and display logs as following:

INFO - Extracting `DATABASE` ...
INFO - Results stored to /tmp/catalog/1649083626-database.csv


...

INFO - Wrote output file: /tmp/catalog/1649083626-summary.json

Credentials

• -H, --host: hostname

• -P, --port: port number

• -d, --database: database name

• -u, --user: user

• -p, --password: password

Other arguments

• -o, --output: target folder to store the extracted files

Optional arguments

• --skip-existing: Skip files already extracted instead of replacing them

You can also get help with argument --help

Use ENV variables

If you don't want to specify arguments every time, you can set the following ENV in your .bashrc:

export CASTOR_POSTGRES_HOST=127.0.0.0
export CASTOR_POSTGRES_PORT=5439
export CASTOR_POSTGRES_DATABASE=db_name
export CASTOR_POSTGRES_USER=extraction_user
export CASTOR_POSTGRES_PASSWORD=******

export CASTOR_OUTPUT_DIRECTORY="/tmp/catalog"

Then the script can be executed without any arguments:

castor-extract-postgres

It can also be executed with partial arguments (the script looks in your ENV as a fallback):

castor-extract-postgres --output /tmp/catalog