community.postgresql.postgresql_idx module – Create or drop indexes from a PostgreSQL database

Note

This module is part of the community.postgresql collection (version 3.14.2).

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_idx.

Synopsis

• Create or drop indexes from a PostgreSQL database.

Requirements

The below requirements are needed on the host that executes this module.

• psycopg2 >= 2.5.1

Parameters

Parameter	Comments
ca_cert aliases: ssl_rootcert 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.
cascade boolean	Automatically drop objects that depend on the index, and in turn all objects that depend on those objects. It used only with state=absent. Mutually exclusive with concurrent=true. Choices: false ← (default) true
columns aliases: column list / elements=string	List of index columns that need to be covered by index. Mutually exclusive with state=absent.
concurrent boolean	Enable or disable concurrent mode (CREATE / DROP INDEX CONCURRENTLY). Pay attention, if concurrent=false, the table will be locked (ACCESS EXCLUSIVE) during the building process. For more information about the lock levels see https://www.postgresql.org/docs/current/explicit-locking.html. If the building process was interrupted for any reason when cuncurrent=true, the index becomes invalid. In this case it should be dropped and created again. Mutually exclusive with cascade=true. Choices: false true ← (default)
cond string	Index conditions. Mutually exclusive with state=absent.
connect_params dictionary added in community.postgresql 2.3.0	Any additional parameters to be passed to libpg. These parameters take precedence. Default: {}
idxname aliases: name string / required	Name of the index to create or drop.
idxtype aliases: type string	Index type (like btree, gist, gin, etc.). Mutually exclusive with state=absent.
login_db aliases: db string	Name of database to connect to and where the index will be created/dropped. The db alias is deprecated and will be removed in version 5.0.0.
login_host aliases: host string	Host running the database. If you have connection issues when using localhost, try to use 127.0.0.1 instead. Default: ""
login_password string	The password this module should use to establish its PostgreSQL session. Default: ""
login_unix_socket aliases: unix_socket string	Path to a Unix domain socket for local connections. Default: ""
login_user aliases: login string	The username this module should use to establish its PostgreSQL session. Default: "postgres"
port aliases: login_port integer	Database port to connect to. Default: 5432
schema string	Name of a database schema where the index will be created.
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.
ssl_cert path added in community.postgresql 2.4.0	Specifies the file name of the client SSL certificate.
ssl_key path added in community.postgresql 2.4.0	Specifies the location for the secret key used for the client certificate.
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. Choices: "allow" "disable" "prefer" ← (default) "require" "verify-ca" "verify-full"
state string	Index state. present implies the index will be created if it does not exist. absent implies the index will be dropped if it exists. Choices: "absent" "present" ← (default)
storage_params list / elements=string	Storage parameters like fillfactor, vacuum_cleanup_index_scale_factor, etc. Mutually exclusive with state=absent.
table string	Table to create index on it. Mutually exclusive with state=absent.
tablespace string	Set a tablespace for the index. Mutually exclusive with state=absent.
trust_input boolean added in community.postgresql 0.2.0	If false, check whether values of parameters idxname, session_role, schema, table, columns, tablespace, storage_params, cond are potentially dangerous. It makes sense to use false only when SQL injections via the parameters are possible. Choices: false true ← (default)
unique boolean added in community.postgresql 0.2.0	Enable unique index. Only btree currently supports unique indexes. Choices: false ← (default) true

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying target.

Notes

Note

• The index building process can affect database performance.

• To avoid table locks on production databases, use concurrent=true (default behavior).

• 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 that psycopg2 >= 2.5.1 or psycopg3 >= 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, and python3-psycopg2 packages on the remote host before using this module.

See Also

See also

community.postgresql.postgresql_table

Create, drop, or modify a PostgreSQL table.

community.postgresql.postgresql_tablespace

Add or remove PostgreSQL tablespaces from remote hosts.

PostgreSQL indexes reference

General information about PostgreSQL indexes.

CREATE INDEX reference

Complete reference of the CREATE INDEX command documentation.

ALTER INDEX reference

Complete reference of the ALTER INDEX command documentation.

DROP INDEX reference

Complete reference of the DROP INDEX command documentation.

Examples

- name: Create btree index if not exists test_idx concurrently covering columns id and name of table products
  community.postgresql.postgresql_idx:
    login_db: acme
    table: products
    columns: id,name
    name: test_idx

- name: Create btree index test_idx concurrently with tablespace called ssd and storage parameter
  community.postgresql.postgresql_idx:
    login_db: acme
    table: products
    columns:
    - id
    - name
    idxname: test_idx
    tablespace: ssd
    storage_params:
    - fillfactor=90

- name: Create gist index test_gist_idx concurrently on column geo_data of table map
  community.postgresql.postgresql_idx:
    login_db: somedb
    table: map
    idxtype: gist
    columns: geo_data
    idxname: test_gist_idx

# Note: for the example below pg_trgm extension must be installed for gin_trgm_ops
- name: Create gin index gin0_idx not concurrently on column comment of table test
  community.postgresql.postgresql_idx:
    idxname: gin0_idx
    table: test
    columns: comment gin_trgm_ops
    concurrent: false
    idxtype: gin

- name: Drop btree test_idx concurrently
  community.postgresql.postgresql_idx:
    login_db: mydb
    idxname: test_idx
    state: absent

- name: Drop test_idx cascade
  community.postgresql.postgresql_idx:
    login_db: mydb
    idxname: test_idx
    state: absent
    cascade: true
    concurrent: false

- name: Create btree index test_idx concurrently on columns id,comment where column id > 1
  community.postgresql.postgresql_idx:
    login_db: mydb
    table: test
    columns: id,comment
    idxname: test_idx
    cond: id > 1

- name: Create unique btree index if not exists test_unique_idx on column name of table products
  community.postgresql.postgresql_idx:
    login_db: acme
    table: products
    columns: name
    name: test_unique_idx
    unique: true
    concurrent: false

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
name string	Index name. Returned: success Sample: "foo_idx"
query string	Query that was tried to be executed. Returned: success Sample: "CREATE INDEX CONCURRENTLY foo_idx ON test_table USING BTREE (id)"
schema string	Schema where index exists. Returned: success Sample: "public"
state string	Index state. Returned: success Sample: "present"
storage_params list / elements=string	Index storage parameters. Returned: success Sample: ["fillfactor=90"]
tablespace string	Tablespace where index exists. Returned: success Sample: "ssd"
valid boolean	Index validity. Returned: success Sample: true

Authors

• Andrew Klychkov (@Andersson007)

• Thomas O’Donnell (@andytom)

Collection links

• Issue Tracker
• Repository (Sources)
• Report an issue
• Communication