Update database cluster attributes

Console

High Availability

For AlloyDB Omni and PostgreSQL database clusters, enable or disable same zone high availability. See the Configure high availability section for more information.

Data Protection

For all database cluster types, you can enable or disable Data protection:

1. Go to Data protection and click edit Edit to access the data protection settings form. If automated backups are enabled, you can also configure how long the backups are to be retained.
2. After making changes, click Save to have the updates applied to your database cluster.

Connectivity

For all database cluster types, you can choose whether the database cluster can be accessed only from inside the GDC project, or if it is accessible from outside the project as well:

1. Go to Connectivity and click edit Edit.
2. Update your connectivity configurations.

3. Click Save to apply your changes.

Instances

For all database cluster types, you can edit the primary instance properties:

1. Go to Primary Instance and click edit Edit.

2. Choose between High Performance, Standard, Minimum, or Custom configurations. The Custom option lets you choose the number of CPUs, memory, and storage for your primary instance.

3. Updating your primary instance's CPU, memory, or storage will require a restart. Select Save and Restart to apply your changes.

For all database cluster types, this form also lets you add, modify, or remove database flags. The set of flags available is predetermined by GDC. See the Configure database flags section for more information.

gdcloud CLI

Use the following command to update a database cluster: sh gdcloud database clusters update CLUSTER_NAME [options]

Replace the following:

• CLUSTER_NAME with the name of the database cluster to update.

For the full list of options, see the command reference or run sh gdcloud database clusters update --help

API

Data Protection

For all database cluster types, you can enable data protection feature by creating a BackupPlan resource for that database cluster.

apiVersion: DBENGINE_NAME.dbadmin.gdc.goog/v1
kind: BackupPlan
metadata:
  name: DBCLUSTER_NAME-backupplan
  namespace: USER_PROJECT
spec:
  dbclusterRef: DBCLUSTER_NAME
  backupRetainDays: RETENTION_DAYS

Replace the following variables:

• DBENGINE_NAME: the name of the database engine. This is one of alloydbomni,postgresql or oracle.
• DBCLUSTER_NAME: the name of the database cluster to enable data protection for.
• USER_PROJECT: the name of the user project where the database cluster will be created.
• RETENTION_DAYS: the number of days for which the AlloyDB Omni Operator retains this backup. It must be an integer between 1 and 90.

You can also configure data protection settings like retention days by editing the corresponding BackupPlan resource.

To turn off data protection for a database cluster, delete the corresponding BackupPlan resource previously created.

Console

1. In the navigation menu, select Database Service.

2. From the database cluster list, click the database cluster you want to configure database flags for.

3. In the Instances in your database cluster section, click Edit Primary.

   

4. In the Flags section, click Add a Database Flag.

5. Choose your flag and enter the value. If the value you input is not valid, the GDC console gives you instructions on how to satisfy the required range or value type.

6. Click Done.

7. To set the configuration, click Save. For some flags to take effect, you must restart the database cluster. For this case, click Save and Restart.

8. To confirm your new flag is set, return to the Instances in your database cluster section of your database cluster and verify the new flag and value are visible.

To edit your database flags, return to the Flags section and modify the existing flags. Hover over a flag component and click the delete Delete icon to remove a database flag.

gdcloud

You can configure new database flags for your cluster or reset all existing flags back to their default values:

• To configure a database flag for your database cluster, run:

  gdcloud database clusters update CLUSTER_NAME \
      --database-flags DB_FLAGS
  

  Replace the following:

  • CLUSTER_NAME: the name of the database cluster.
  • DB_FLAGS: the comma-separated list of database flags to set on the database running in the database cluster. Each database flag and value are set as a key-value pair. Flags without a value can be defined without a string following the = character.

  For example, the following command sets several database flags for the test-db-cluster:

  gdcloud database clusters update test-db-cluster \
      --database-flags max_allowed_packet=55555,skip_grant_tables=,log_output=1
  

  For a list of available database flags, see Available database flags.

• To reset all your database flags to their default settings, run:

  gdcloud database clusters update CLUSTER_NAME --clear-database-flags
  

  Replace CLUSTER_NAME with the name of the database cluster.

API

• To configure database flags for your database cluster, run:

    kubectl patch dbcluster.DBENGINE_NAME.dbadmin.gdc.goog DBCLUSTER_NAME -p '{"spec":{"primarySpec": {"parameters": DB_FLAGS}}}' --type=merge -n USER_PROJECT
  

  Replace the following variables:

  • DBENGINE_NAME: the name of the database engine. This is one of alloydbomni, postgresql, or oracle.
  • DBCLUSTER_NAME: the name of the database cluster.
  • USER_PROJECT: the name of the user project where the database cluster was created.
  • DB_FLAGS: the database configuration parameters to be added or updated. This should be JSON-formatted object of key-value pairs, where keys are the database parameter names and values are their respective settings. For example, the following sets several database flags:

  "autovacuum": "on", "autovacuum_analyze_threshold": "2147483647", "dbs.enable_anon": "on"
  

  For a list of available database flags, see Available database flags.

• To reset all your database flags to their default settings, run:

  kubectl patch dbcluster.DBENGINE_NAME.dbadmin.gdc.goog DBCLUSTER_NAME --type=json -p='[{"op": "remove", "path": "/spec/primarySpec/parameters"}]' -n USER_PROJECT
  

  Replace the following variables:

  • DBENGINE_NAME: the name of the database engine. This is one of alloydbomni, postgresql, or oracle.
  • DBCLUSTER_NAME: the name of the database cluster.
  • USER_PROJECT: the name of the user project where the database cluster was created.