New in version 2.3.
parameter | required | default | choices | comments |
---|---|---|---|---|
database |
no | postgres | Name of the database to connect to. | |
login_host |
no | localhost | Host running the database. | |
login_password |
no | The password used to authenticate with. | ||
login_unix_socket |
no | Path to a Unix domain socket for local connections. | ||
login_user |
no | The username used to authenticate with. | ||
name |
yes | Name of the schema to add or remove. | ||
owner |
no | Name of the role to set as owner of the schema. | ||
port |
no | 5432 | Database port to connect to. | |
state |
no | present |
|
The schema state. |
# Create a new schema with name "acme" - postgresql_schema: name: acme # Create a new schema "acme" with a user "bob" who will own it - postgresql_schema: name: acme owner: bob
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
schema | Name of the schema | success, changed | string | acme |
Note
postgresql
, libpq-dev
, and python-psycopg2
packages on the remote host before using this module.This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.