community.postgresql.postgresql_schema module – Add or remove PostgreSQL schema
Note
This module is part of the community.postgresql collection (version 3.6.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_schema
.
Synopsis
Add or remove PostgreSQL schema.
Requirements
The below requirements are needed on the host that executes this module.
psycopg2 >= 2.5.1
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. |
|
Drop schema with CASCADE to remove child objects. Choices:
|
|
Sets a comment on the schema. To reset the comment, pass an empty string. |
|
Any additional parameters to be passed to libpg. These parameters take precedence. Default: |
|
Name of the database to connect to and add or remove the schema. 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: |
|
Name of the schema to add or remove. |
|
Name of the role to set as owner of the schema. Default: |
|
Database port to connect to. 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. |
|
Specifies the file name of the client SSL certificate. |
|
Specifies the location for the secret key used for the client certificate. |
|
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 schema state. Choices:
|
|
If It makes sense to use Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in check_mode and return changed status prediction without modifying target. |
Notes
Note
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
psycopg
, a Python PostgreSQL database adapter. You must ensure thatpsycopg2 >= 2.5.1
orpsycopg3 >= 3.1.8
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
, andpython3-psycopg2
packages on the remote host before using this module.
See Also
See also
- PostgreSQL schemas
General information about PostgreSQL schemas.
- CREATE SCHEMA reference
Complete reference of the CREATE SCHEMA command documentation.
- ALTER SCHEMA reference
Complete reference of the ALTER SCHEMA command documentation.
- DROP SCHEMA reference
Complete reference of the DROP SCHEMA command documentation.
Examples
- name: Create a new schema with name acme in test database
community.postgresql.postgresql_schema:
db: test
name: acme
comment: 'My test schema'
- name: Create a new schema acme with a user bob who will own it
community.postgresql.postgresql_schema:
name: acme
owner: bob
- name: Drop schema "acme" with cascade
community.postgresql.postgresql_schema:
name: acme
state: absent
cascade_drop: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of executed queries. Returned: success Sample: |
|
Name of the schema. Returned: success Sample: |