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 the database cluster manifest (DBCluster) for environments running AlloyDB Omni on a Kubernetes cluster. For a list of supported flags, see Supported database flags.

Update a parameter in AlloyDB Omni on a Kubernetes cluster

You can configure database parameters using the parameters field in the primarySpec section of your database cluster manifest:

spec:
  primarySpec:
    parameters:
      "PARAMETER_NAME": "PARAMETER_VALUE"
      ...

Replace the following:

  • PARAMETER_NAME: the name of the parameter—for example, autovacuum.
  • PARAMETER_VALUE: the value of the parameter—for example, off.

Some parameters require you to restart your cluster for the changes to take effect. You can obtain a list of parameters that require a restart from pg_catalog.pg_settings. Any parameter with pg_catalog.pg_settings.context = 'postmaster' requires a restart.

To update database parameters, run the following command:

kubectl patch dbclusters.alloydbomni.dbadmin.goog dbcluster-sample -p '{"spec":{"primarySpec":{"parameters": {"PARAMETER_NAME": "PARAMETER_VALUE"}}}}' --type=merge

Parameter settings are located in the status part of the currentParameters field.

To view database parameters, run the following command:

kubectl get dbclusters.alloydbomni.dbadmin.goog dbcluster-sample -o jsonpath={.status.primary.currentParameters}

The output is similar to the following:

{"autovacuum":"off","max_connections":"3000"}

If AlloyDB Omni can't apply your requested updates, then the output lists the current and requested values separately. For example, this difference can occur if you apply a nonexistent parameter or set a string value for an integer parameter.