community.postgresql.postgresql_schema – Add or remove PostgreSQL schema
community.postgresql.postgresql_schema – Add or remove PostgreSQL schema
Note
This plugin is part of the community.postgresql collection (version 1.0.0).
To install it use: ansible-galaxy collection install community.postgresql
.
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
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
ca_cert string |
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.
| |
cascade_drop boolean |
|
Drop schema with CASCADE to remove child objects. |
database string |
Default: "postgres" |
Name of the database to connect to and add or remove the schema.
|
login_host string |
Host running the database. | |
login_password string |
The password used to authenticate with. | |
login_unix_socket string |
Path to a Unix domain socket for local connections. | |
login_user string |
Default: "postgres" |
The username used to authenticate with. |
name string / required |
Name of the schema to add or remove.
| |
owner string |
Name of the role to set as owner of the schema. | |
port integer |
Default: 5432 |
Database port to connect to.
|
session_role string |
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. | |
ssl_mode string |
|
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 |
state string |
|
The schema state. |
trust_input boolean added in 0.2.0 of community.postgresql |
|
If It makes sense to use |
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 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
- 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
- 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: yes
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
queries list / elements=string |
always |
List of executed queries.
Sample: ['CREATE SCHEMA "acme"'] |
schema string |
success, changed |
Name of the schema.
Sample: acme |
Authors
- Flavien Chantelot (@Dorn-) <[email protected]>
- Thomas O’Donnell (@andytom)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/postgresql/postgresql_schema_module.html