postgresql_schema – Add or remove PostgreSQL schema¶
Parameters¶
Notes¶
Note
- The default authentication assumes that you are either logging in as or sudo’ing to the postgresaccount 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
  postgresql_schema:
    db: test
    name: acme
- name: Create a new schema acme with a user bob who will own it
  postgresql_schema:
    name: acme
    owner: bob
- name: Drop schema "acme" with cascade
  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
                                       | always | List of executed queries. Sample: ['CREATE SCHEMA "acme"'] | 
| schema 
                  string
                                       | success, changed | Name of the schema. Sample: acme | 
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Flavien Chantelot (@Dorn-) <contact@flavien.io>
- Thomas O’Donnell (@andytom)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
