Configure AlloyDB Omni database parameters

Select a documentation version:

To configure a database parameter for AlloyDB Omni, you can update Grand Unified Configuration (GUC) parameters in either of the following:

  • The postgresql.conf file for environments running AlloyDB Omni on a VM.

Update a parameter in containerized AlloyDB Omni

In an AlloyDB Omni running on a VM, you can update a parameter by editing the postgresql.conf file as follows:

  1. Locate the postgresql.conf configuration file for your installation of AlloyDB Omni.

  2. Use a text editor to add or update a database flag in postgresql.conf.

    For example, to enforce password expiration, set the following flag in the postgresql.conf file:

    password.enforce_expiration = ON

  3. After your database flags are added or edited, reload the postgresql.conf file for the changes to take effect. For example, if you installed AlloyDB Omni using Docker, run the following to restart your Docker instance and reload postgresql.conf:

    docker restart CONTAINER-NAME

For more information, see Setting parameters in PostgreSQL documentation.

Audit database parameters using the web UI

You can audit active database flags and identify customized parameters that differ from default engine values using the Database flags page in the AlloyDB Omni web user interface.

To audit database parameters in the web UI, complete the following steps:

  1. Connect to the web UI and select your cluster.
  2. In the navigation menu, click Database flags.
  3. Use the following controls to search and filter parameters:
    • Search for flags: Enter a keyword (for example, max) to filter parameters by name.
    • Show modified flags: Select this checkbox to display only parameters whose active values differ from their default engine values. Customized values are also highlighted in yellow in the Current value column.
    • Collapse all or Expand all: Collapse or expand the parameter category groups (such as Google AlloyDB Options, Client Connection Defaults / Locale and Formatting, Client Connection Defaults / Other Defaults, and Client Connection Defaults / Shared Library Preloading).
  4. Review the parameter table columns within each category group:
    • Setting: The name of the database parameter.
    • Type: The data type of the parameter (for example, INTEGER).
    • Current value: The active value of the parameter on the instance (highlighted in yellow if modified from the default).
    • Default value: The default engine value for the parameter.
    • Restart required: Indicates whether modifying the parameter requires a database restart (true or false).
    • Source: The configuration source of the current value (for example, default).