salt.states.postgres_database#
Management of PostgreSQL databases#
The postgres_database module is used to create and manage Postgres databases. Databases can be set as either absent or present
frank:
postgres_database.present
- salt.states.postgres_database.absent(name, user=None, maintenance_db=None, db_password=None, db_host=None, db_port=None, db_user=None)#
Ensure that the named database is absent
- name
The name of the database to remove
- db_user
database username if different from config or default
- db_password
user password if any password for a specified user
- db_host
Database host if different from config or default
- db_port
Database port if different from config or default
- user
System user all operations should be performed on behalf of
New in version 0.17.0.
- salt.states.postgres_database.present(name, tablespace=None, encoding=None, lc_collate=None, lc_ctype=None, owner=None, owner_recurse=False, template=None, user=None, maintenance_db=None, db_password=None, db_host=None, db_port=None, db_user=None)#
Ensure that the named database is present with the specified properties. For more information about all of these options see man createdb(1)
- name
The name of the database to manage
- tablespace
Default tablespace for the database
- encoding
The character encoding scheme to be used in this database. The encoding has to be defined in the following format (without hyphen).
- encoding: UTF8
- lc_collate
The LC_COLLATE setting to be used in this database
- lc_ctype
The LC_CTYPE setting to be used in this database
- owner
The username of the database owner
- owner_recurse
Recurse owner change to all relations in the database
- template
The template database from which to build this database
- user
System user all operations should be performed on behalf of
- db_user
database username if different from config or default
- db_password
user password if any password for a specified user
- db_host
Database host if different from config or default
- db_port
Database port if different from config or default
New in version 0.17.0.