community.postgresql.postgresql_set – Change a PostgreSQL server configuration parameter

• Synopsis
• Requirements
• Parameters
• Notes
• See Also
• Examples
• Return Values

Synopsis

• Allows to change a PostgreSQL server configuration parameter.
• The module uses ALTER SYSTEM command and applies changes by reload server configuration.
• ALTER SYSTEM is used for changing server configuration parameters across the entire database cluster.
• It can be more convenient and safe than the traditional method of manually editing the postgresql.conf file.
• ALTER SYSTEM writes the given parameter setting to the $PGDATA/postgresql.auto.conf file, which is read in addition to postgresql.conf.
• The module allows to reset parameter to boot_val (cluster initial value) by reset=yes or remove parameter string from postgresql.auto.conf and reload value=default (for settings with postmaster context restart is required).
• After change you can see in the ansible output the previous and the new parameter value and other information using returned values and ansible.builtin.debug module.

Requirements

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

• psycopg2

Parameters

Notes

See Also

Examples

- name: Restore wal_keep_segments parameter to initial state
  community.postgresql.postgresql_set:
    name: wal_keep_segments
    reset: yes

# Set work_mem parameter to 32MB and show what's been changed and restart is required or not
# (output example: "msg": "work_mem 4MB >> 64MB restart_req: False")
- name: Set work mem parameter
  community.postgresql.postgresql_set:
    name: work_mem
    value: 32mb
  register: set

- name: Print the result if the setting changed
  ansible.builtin.debug:
    msg: "{{ set.name }} {{ set.prev_val_pretty }} >> {{ set.value_pretty }} restart_req: {{ set.restart_required }}"
  when: set.changed
# Ensure that the restart of PostgreSQL server must be required for some parameters.
# In this situation you see the same parameter in prev_val_pretty and value_pretty, but 'changed=True'
# (If you passed the value that was different from the current server setting).

- name: Set log_min_duration_statement parameter to 1 second
  community.postgresql.postgresql_set:
    name: log_min_duration_statement
    value: 1s

- name: Set wal_log_hints parameter to default value (remove parameter from postgresql.auto.conf)
  community.postgresql.postgresql_set:
    name: wal_log_hints
    value: default

- name: Set TimeZone parameter (careful, case sensitive)
  community.postgresql.postgresql_set:
    name: TimeZone
    value: 'Europe/Paris'

Return Values

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

Authors

• Andrew Klychkov (@Andersson007)