salt.modules.postgres

Module to provide Postgres compatibility to salt.

In order to connect to Postgres, certain configuration is required in /etc/salt/minion on the relevant minions. Some sample configs might look like:

postgres.host: 'localhost'
postgres.port: '5432'
postgres.user: 'postgres'
postgres.pass: ''
postgres.db: 'postgres'

Members

check_or_die

salt.modules.postgres.check_or_die(command)

Simple convienence function for modules to use for gracefully blowing up if a required tool is not available in the system path.

Lazily import salt.modules.cmdmod to avoid any sort of circular dependencies.

db_create

salt.modules.postgres.db_create(name, user=None, host=None, port=None, tablespace=None, encoding=None, local=None, lc_collate=None, lc_ctype=None, owner=None, template=None)

Adds a databases to the Postgres server.

CLI Example:

salt '*' postgres.db_create 'dbname'

salt '*' postgres.db_create 'dbname' template=template_postgis

db_exists

salt.modules.postgres.db_exists(name, user=None, host=None, port=None)

Checks if a database exists on the Postgres server.

CLI Example:

salt '*' postgres.db_exists 'dbname'

db_list

salt.modules.postgres.db_list(user=None, host=None, port=None)

Return a list of databases of a Postgres server using the output from the psql -l query.

CLI Example:

salt '*' postgres.db_list

db_remove

salt.modules.postgres.db_remove(name, user=None, host=None, port=None)

Removes a databases from the Postgres server.

CLI Example:

salt '*' postgres.db_remove 'dbname'

user_create

salt.modules.postgres.user_create(username, user=None, host=None, port=None, createdb=False, createuser=False, encrypted=False, password=None)

Creates a Postgres user.

CLI Examples:

salt '*' postgres.user_create 'username' user='user' host='hostname' port='port' password='password'

version

salt.modules.postgres.version()

Return the version of a Postgres server using the output from the psql --version cmd.

CLI Example:

salt '*' postgres.version

Parent topic

Table Of Contents

Previous topic

salt.modules.pip

Next topic

salt.modules.ps