community.postgresql.postgresql_tablespace – Add or remove PostgreSQL tablespaces from remote hosts¶
Note
This plugin is part of the community.postgresql collection (version 1.2.0).
To install it use: ansible-galaxy collection install community.postgresql
.
To use it in a playbook, specify: community.postgresql.postgresql_tablespace
.
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.
aliases: ssl_rootcert |
|
db
string
|
Name of database to connect to and run queries against.
aliases: login_db |
|
location
path
|
Path to the tablespace directory in the file system.
Ensure that the location exists and has right privileges.
aliases: path |
|
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.
|
owner
string
|
Name of the role to set as an owner of the tablespace.
If this option is not specified, the tablespace owner is a role that creates the tablespace.
|
|
port
integer
|
Default: 5432
|
Database port to connect to.
aliases: login_port |
rename_to
string
|
New name of the tablespace.
The new name cannot begin with pg_, as such names are reserved for system tablespaces.
|
|
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.
|
|
set
dictionary
|
Dict of tablespace options to set. Supported from PostgreSQL 9.0.
For more information see https://www.postgresql.org/docs/current/sql-createtablespace.html.
When reset is passed as an option's value, if the option was set previously, it will be removed.
|
|
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
prefer matches libpq default. |
state
string
|
|
Tablespace state.
state=present implies the tablespace must be created if it doesn't exist.
state=absent implies the tablespace must be removed if present. state=absent is mutually exclusive with location, owner, i(set).
See the Notes section for information about check mode restrictions.
|
tablespace
string
/ required
|
Name of the tablespace to add or remove.
aliases: name |
|
trust_input
boolean
added in 0.2.0 of community.postgresql
|
|
If
no , check whether values of parameters tablespace, location, owner, rename_to, session_role, settings_list are potentially dangerous.It makes sense to use
no only when SQL injections via the parameters are possible. |
Notes¶
Note
state=absent and state=present (the second one if the tablespace doesn’t exist) do not support check mode because the corresponding PostgreSQL DROP and CREATE TABLESPACE commands can not be run inside the transaction block.
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 tablespaces
General information about PostgreSQL tablespaces.
- CREATE TABLESPACE reference
Complete reference of the CREATE TABLESPACE command documentation.
- ALTER TABLESPACE reference
Complete reference of the ALTER TABLESPACE command documentation.
- DROP TABLESPACE reference
Complete reference of the DROP TABLESPACE command documentation.
Examples¶
- name: Create a new tablespace called acme and set bob as an its owner
community.postgresql.postgresql_tablespace:
name: acme
owner: bob
location: /data/foo
- name: Create a new tablespace called bar with tablespace options
community.postgresql.postgresql_tablespace:
name: bar
set:
random_page_cost: 1
seq_page_cost: 1
- name: Reset random_page_cost option
community.postgresql.postgresql_tablespace:
name: bar
set:
random_page_cost: reset
- name: Rename the tablespace from bar to pcie_ssd
community.postgresql.postgresql_tablespace:
name: bar
rename_to: pcie_ssd
- name: Drop tablespace called bloat
community.postgresql.postgresql_tablespace:
name: bloat
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Flavien Chantelot (@Dorn-)
Antoine Levy-Lambert (@antoinell)
Andrew Klychkov (@Andersson007)