community.postgresql.postgresql_db module – Add or remove PostgreSQL databases from a remote host
Note
This module is part of the community.postgresql collection (version 2.3.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.postgresql
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.postgresql.postgresql_db
.
Synopsis
Add or remove PostgreSQL databases from a remote host.
Requirements
The below requirements are needed on the host that executes this module.
psycopg2
Parameters
Parameter |
Comments |
---|---|
Specifies the name of a file containing SSL certificate authority (CA) certificate(s). If the file exists, the server’s certificate will be verified to be signed by one of these authorities. |
|
Specifies the database connection limit. Default: |
|
Any additional parameters to be passed to libpg. These parameters take precedence. Default: |
|
Provides additional arguments when state is Cannot be used with dump-file-format-related arguments like ``–format=d``. |
|
Encoding of the database. Default: |
|
Used to forcefully drop a database when the state is Choices:
|
|
Collation order (LC_COLLATE) to use in the database must match collation order of template database unless Default: |
|
Character classification (LC_CTYPE) to use in the database (e.g. lower, upper, …). Must match LC_CTYPE of template database unless Default: |
|
Host running the database. If you have connection issues when using Default: |
|
The password this module should use to establish its PostgreSQL session. Default: |
|
Path to a Unix domain socket for local connections. Default: |
|
The username this module should use to establish its PostgreSQL session. Default: |
|
The value specifies the initial database (which is also called as maintenance DB) that Ansible connects to. Default: |
|
Name of the database to add or remove. |
|
Name of the role to set as owner of the database. Default: |
|
Database port to connect (if needed). Default: |
|
Switch to session_role after connecting. The specified session_role must be a role that the current login_user is a member of. Permissions checking for SQL commands is carried out as though the session_role were the one that had logged in originally. |
|
Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server. See https://www.postgresql.org/docs/current/static/libpq-ssl.html for more information on the modes. Default of Choices:
|
|
The database state.
The format of the backup will be detected based on the target name. Supported compression formats for dump and restore include Supported formats for dump and restore include Restore program is selected by target file format: .
If the database If the database If both the databases exist as well as when they have the same value, an error will be raised. When state=rename, in addition to the Choices:
|
|
The tablespace to set for the database https://www.postgresql.org/docs/current/sql-alterdatabase.html. If you want to move the database back to the default tablespace, explicitly set this to pg_default. Default: |
|
File to back up or restore from. Used when state is Default: |
|
Additional arguments for pg_dump or restore program (pg_restore or psql, depending on target’s format). Used when state is Default: |
|
Template used to create the database. Default: |
|
If It makes sense to use Choices:
|
Notes
Note
State
dump
andrestore
don’t require psycopg2 since version 2.8.Supports
check_mode
.The default authentication assumes that you are either logging in as or sudo’ing to the
postgres
account on the host.To avoid “Peer authentication failed for user postgres” error, use postgres user as a become_user.
This module uses psycopg2, a Python PostgreSQL database adapter. You must ensure that psycopg2 is installed on the host before using this module.
If the remote host is the PostgreSQL server (which is the default case), then PostgreSQL must also be installed on the remote host.
For Ubuntu-based systems, install the postgresql, libpq-dev, and python-psycopg2 packages on the remote host before using this module.
The ca_cert parameter requires at least Postgres version 8.4 and psycopg2 version 2.4.3.
See Also
See also
- CREATE DATABASE reference
Complete reference of the CREATE DATABASE command documentation.
- DROP DATABASE reference
Complete reference of the DROP DATABASE command documentation.
- pg_dump reference
Complete reference of pg_dump documentation.
- pg_restore reference
Complete reference of pg_restore documentation.
- community.postgresql.postgresql_tablespace
Add or remove PostgreSQL tablespaces from remote hosts.
- community.postgresql.postgresql_info
Gather information about PostgreSQL servers.
- community.postgresql.postgresql_ping
Check remote PostgreSQL server availability.
Examples
- name: Create a new database with name "acme"
community.postgresql.postgresql_db:
name: acme
# Note: If a template different from "template0" is specified,
# encoding and locale settings must match those of the template.
- name: Create a new database with name "acme" and specific encoding and locale # settings
community.postgresql.postgresql_db:
name: acme
encoding: UTF-8
lc_collate: de_DE.UTF-8
lc_ctype: de_DE.UTF-8
template: template0
# Note: Default limit for the number of concurrent connections to
# a specific database is "-1", which means "unlimited"
- name: Create a new database with name "acme" which has a limit of 100 concurrent connections
community.postgresql.postgresql_db:
name: acme
conn_limit: "100"
- name: Dump an existing database to a file
community.postgresql.postgresql_db:
name: acme
state: dump
target: /tmp/acme.sql
- name: Dump an existing database to a file excluding the test table
community.postgresql.postgresql_db:
name: acme
state: dump
target: /tmp/acme.sql
dump_extra_args: --exclude-table=test
- name: Dump an existing database to a file (with compression)
community.postgresql.postgresql_db:
name: acme
state: dump
target: /tmp/acme.sql.gz
- name: Dump a single schema for an existing database
community.postgresql.postgresql_db:
name: acme
state: dump
target: /tmp/acme.sql
target_opts: "-n public"
- name: Dump only table1 and table2 from the acme database
community.postgresql.postgresql_db:
name: acme
state: dump
target: /tmp/table1_table2.sql
target_opts: "-t table1 -t table2"
- name: Dump an existing database using the directory format
community.postgresql.postgresql_db:
name: acme
state: dump
target: /tmp/acme.dir
# Note: In the example below, if database foo exists and has another tablespace
# the tablespace will be changed to foo. Access to the database will be locked
# until the copying of database files is finished.
- name: Create a new database called foo in tablespace bar
community.postgresql.postgresql_db:
name: foo
tablespace: bar
# Rename the database foo to bar.
# If the database foo exists, it will be renamed to bar.
# If the database foo does not exist and the bar database exists,
# the module will report that nothing has changed.
# If both the databases exist, an error will be raised.
- name: Rename the database foo to bar
community.postgresql.postgresql_db:
name: foo
state: rename
target: bar
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of commands which tried to run. Returned: always Sample: |
Collection links
Issue Tracker Repository (Sources) Report an issue Communication