community / community.postgresql / 3.4.0 / module / postgresql_schema Add or remove PostgreSQL schema Authors: Flavien Chantelot (@Dorn-) <contact@flavien.io>, Thomas O'Donnell (@andytom)community.postgresql.postgresql_schema (3.4.0) — module
Install with ansible-galaxy collection install community.postgresql:==3.4.0
collections: - name: community.postgresql version: 3.4.0
Add or remove PostgreSQL schema.
- 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
name: aliases: - schema description: - Name of the schema to add or remove. required: true type: str port: aliases: - login_port default: 5432 description: - Database port to connect to. type: int owner: default: '' description: - Name of the role to set as owner of the schema. type: str state: choices: - absent - present default: present description: - The schema state. type: str ca_cert: aliases: - ssl_rootcert description: - 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. type: str comment: description: - Sets a comment on the schema. - To reset the comment, pass an empty string. type: str version_added: 3.3.0 version_added_collection: community.postgresql ssl_key: description: - Specifies the location for the secret key used for the client certificate. type: path version_added: 2.4.0 version_added_collection: community.postgresql database: aliases: - db - login_db default: postgres description: - Name of the database to connect to and add or remove the schema. type: str ssl_cert: description: - Specifies the file name of the client SSL certificate. type: path version_added: 2.4.0 version_added_collection: community.postgresql ssl_mode: choices: - allow - disable - prefer - require - verify-ca - verify-full default: prefer description: - Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server. - See U(https://www.postgresql.org/docs/current/static/libpq-ssl.html) for more information on the modes. - Default of C(prefer) matches libpq default. type: str login_host: aliases: - host default: '' description: - Host running the database. - If you have connection issues when using C(localhost), try to use C(127.0.0.1) instead. type: str login_user: aliases: - login default: postgres description: - The username this module should use to establish its PostgreSQL session. type: str trust_input: default: true description: - If C(false), check whether values of parameters I(schema), I(owner), I(session_role) are potentially dangerous. - It makes sense to use C(false) only when SQL injections via the parameters are possible. type: bool version_added: 0.2.0 version_added_collection: community.postgresql cascade_drop: default: false description: - Drop schema with CASCADE to remove child objects. type: bool session_role: description: - 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. type: str connect_params: default: {} description: - Any additional parameters to be passed to libpg. - These parameters take precedence. type: dict version_added: 2.3.0 version_added_collection: community.postgresql login_password: default: '' description: - The password this module should use to establish its PostgreSQL session. type: str login_unix_socket: aliases: - unix_socket default: '' description: - Path to a Unix domain socket for local connections. type: str
queries: description: List of executed queries. returned: success sample: - CREATE SCHEMA "acme" type: list schema: description: Name of the schema. returned: success sample: acme type: str