community.postgresql.postgresql_tablespace module – Add or remove PostgreSQL tablespaces from remote hosts
Note
This module is part of the community.postgresql collection (version 3.7.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.postgresql
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.postgresql.postgresql_tablespace
.
Synopsis
Adds or removes PostgreSQL tablespaces from remote hosts.
Requirements
The below requirements are needed on the host that executes this module.
psycopg2 >= 2.5.1
Parameters
Parameter |
Comments |
---|---|
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. |
|
Sets a comment on the tablespace. To reset the comment, pass an empty string. |
|
Any additional parameters to be passed to libpg. These parameters take precedence. Default: |
|
Name of database to connect to and run queries against. |
|
Path to the tablespace directory in the file system. Ensure that the location exists and has right privileges. |
|
Host running the database. If you have connection issues when using Default: |
|
The password this module should use to establish its PostgreSQL session. Default: |
|
Path to a Unix domain socket for local connections. Default: |
|
The username this module should use to establish its PostgreSQL session. Default: |
|
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. |
|
Database port to connect to. Default: |
|
New name of the tablespace. The new name cannot begin with pg_, as such names are reserved for system tablespaces. |
|
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. |
|
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. |
|
Specifies the file name of the client SSL certificate. |
|
Specifies the location for the secret key used for the client certificate. |
|
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 Choices:
|
|
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. Choices:
|
|
Name of the tablespace to add or remove. |
|
If It makes sense to use Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: partial 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. |
Can run in check_mode and return changed status prediction without modifying target. |
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
psycopg
, a Python PostgreSQL database adapter. You must ensure thatpsycopg2 >= 2.5.1
orpsycopg3 >= 3.1.8
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
, andpython3-psycopg2
packages on the remote host before using this module.
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
comment: "Bob's tablespace"
- 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:
Key |
Description |
---|---|
Tablespace comment. Returned: success Sample: |
|
Path to the tablespace in the file system. Returned: success Sample: |
|
New tablespace name. Returned: if existent Sample: |
|
Tablespace options. Returned: success Sample: |
|
Tablespace owner. Returned: success Sample: |
|
List of queries that was tried to be executed. Returned: success Sample: |
|
Tablespace state at the end of execution. Returned: success Sample: |
|
Tablespace name. Returned: success Sample: |