Configure database flags

Console

1. In the Google Cloud console, select the project that contains the Cloud SQL instance for which you want to set a database flag.
2. Open the instance and click Edit.
3. Go to the Flags section.
4. To set a flag that has not been set on the instance before, click Add item, choose the flag from the drop-down menu, and set its value.
5. Click Save to save your changes.
6. Confirm your changes under Flags on the Overview page.

gcloud

Edit the instance:

gcloud sql instances patch INSTANCE_NAME --database-flags=FLAG1=VALUE1,FLAG2=VALUE2

This command will overwrite all database flags previously set. To keep those and add new ones, include the values for all flags you want set on the instance; any flag not specifically included is set to its default value. For flags that don't take a value, specify the flag name followed by an equals sign ("=").

For example, to set the log_connections and log_min_error_statement flags, you can use the following command:

gcloud sql instances patch INSTANCE_NAME \   --database-flags=log_connections=on,log_min_error_statement=error

Terraform

To add database flags, use a Terraform resource.

resource "google_sql_database_instance" "instance" {   name             = "postgres-instance"   region           = "us-central1"   database_version = "POSTGRES_14"   settings {     database_flags {       name  = "log_connections"       value = "on"     }     database_flags {       name  = "log_min_error_statement"       value = "error"     }     tier = "db-custom-2-7680"   }   # set `deletion_protection` to true, will ensure that one cannot accidentally delete this instance by   # use of Terraform whereas `deletion_protection_enabled` flag protects this instance at the GCP level.   deletion_protection = false }

Apply the changes

To apply your Terraform configuration in a Google Cloud project, complete the steps in the following sections.

Prepare Cloud Shell

1. Launch Cloud Shell.

2. Set the default Google Cloud project where you want to apply your Terraform configurations.

   You only need to run this command once per project, and you can run it in any directory.

   export GOOGLE_CLOUD_PROJECT=PROJECT_ID

   Environment variables are overridden if you set explicit values in the Terraform configuration file.

Prepare the directory

Each Terraform configuration file must have its own directory (also called a root module).

1. In Cloud Shell, create a directory and a new file within that directory. The filename must have the .tf extension—for example main.tf. In this tutorial, the file is referred to as main.tf.

   mkdir DIRECTORY && cd DIRECTORY && touch main.tf

2. If you are following a tutorial, you can copy the sample code in each section or step.

   Copy the sample code into the newly created main.tf.

   Optionally, copy the code from GitHub. This is recommended when the Terraform snippet is part of an end-to-end solution.

3. Review and modify the sample parameters to apply to your environment.
4. Save your changes.
5. Initialize Terraform. You only need to do this once per directory.

   terraform init

   Optionally, to use the latest Google provider version, include the -upgrade option:

   terraform init -upgrade

Apply the changes

1. Review the configuration and verify that the resources that Terraform is going to create or update match your expectations:

   terraform plan

   Make corrections to the configuration as necessary.

2. Apply the Terraform configuration by running the following command and entering yes at the prompt:

   terraform apply

   Wait until Terraform displays the "Apply complete!" message.

3. Open your Google Cloud project to view the results. In the Google Cloud console, navigate to your resources in the UI to make sure that Terraform has created or updated them.

Delete the changes

To delete your changes, do the following:

1. To disable deletion protection, in your Terraform configuration file set the deletion_protection argument to false.

   deletion_protection =  "false"

2. Apply the updated Terraform configuration by running the following command and entering yes at the prompt:

   terraform apply

3. Remove resources previously applied with your Terraform configuration by running the following command and entering yes at the prompt:

   terraform destroy

REST v1

To set a flag for an existing database:

Before using any of the request data, make the following replacements:

• project-id: The project ID
• instance-id: The instance ID

HTTP method and URL:

PATCH https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id

Request JSON body:

 {   "settings":   {     "databaseFlags":     [       {         "name": "flag_name",         "value": "flag_value"       }     ]   } } 

To send your request, expand one of these options:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

 {   "kind": "sql#operation",   "targetLink": "https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id",   "status": "PENDING",   "user": "[email protected]",   "insertTime": "2020-01-21T22:43:37.981Z",   "operationType": "UPDATE",   "name": "operation-id",   "targetId": "instance-id",   "selfLink": "https://sqladmin.googleapis.com/v1/projects/project-id/operations/operation-id",   "targetProject": "project-id" } 

If there are existing flags configured for the database, modify the previous command to include them. The PATCH command overwrites the existing flags with the ones specified in the request.

REST v1beta4

To set a flag for an existing database:

Before using any of the request data, make the following replacements:

• project-id: The project ID
• instance-id: The instance ID

HTTP method and URL:

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id

Request JSON body:

 {   "settings":   {     "databaseFlags":     [       {         "name": "flag_name",         "value": "flag_value"       }     ]   } } 

To send your request, expand one of these options:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

 {   "kind": "sql#operation",   "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id",   "status": "PENDING",   "user": "[email protected]",   "insertTime": "2020-01-21T22:43:37.981Z",   "operationType": "UPDATE",   "name": "operation-id",   "targetId": "instance-id",   "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/operations/operation-id",   "targetProject": "project-id" } 

If there are existing flags configured for the database, modify the previous command to include them. The PATCH command overwrites the existing flags with the ones specified in the request.

Console

1. In the Google Cloud console, select the project that contains the Cloud SQL instance for which you want to clear all flags.
2. Open the instance and click Edit.
3. Open the Database flags section.
4. Click the X next to all of the flags shown.
5. Click Save to save your changes.

gcloud

Clear all flags to their default values on an instance:

gcloud sql instances patch INSTANCE_NAME \ --clear-database-flags

You are prompted to confirm that the instance will be restarted.

REST v1

To clear all flags for an existing instance:

Before using any of the request data, make the following replacements:

• project-id: The project ID
• instance-id: The instance ID

HTTP method and URL:

PATCH https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id

Request JSON body:

 {   "settings":   {     "databaseFlags": []   } } 

To send your request, expand one of these options:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

 {   "kind": "sql#operation",   "targetLink": "https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id",   "status": "PENDING",   "user": "[email protected]",   "insertTime": "2020-01-21T22:43:37.981Z",   "operationType": "UPDATE",   "name": "operation-id",   "targetId": "instance-id",   "selfLink": "https://sqladmin.googleapis.com/v1/projects/project-id/operations/operation-id",   "targetProject": "project-id" } 

REST v1beta4

To clear all flags for an existing instance:

Before using any of the request data, make the following replacements:

• project-id: The project ID
• instance-id: The instance ID

HTTP method and URL:

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id

Request JSON body:

 {   "settings":   {     "databaseFlags": []   } } 

To send your request, expand one of these options:

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

 {   "kind": "sql#operation",   "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id",   "status": "PENDING",   "user": "[email protected]",   "insertTime": "2020-01-21T22:43:37.981Z",   "operationType": "UPDATE",   "name": "operation-id",   "targetId": "instance-id",   "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/operations/operation-id",   "targetProject": "project-id" } 

Console

1. In the Google Cloud console, select the project that contains the Cloud SQL instance for which you want to see the database flags that have been set.
2. Select the instance to open its Instance Overview page.

   The database flags that have been set are listed under the Database flags section.

gcloud

Get the instance state:

gcloud sql instances describe INSTANCE_NAME

In the output, database flags are listed under the settings as the collection databaseFlags. For more information about the representation of the flags in the output, see Instances Resource Representation.

REST v1

To list flags configured for an instance:

Before using any of the request data, make the following replacements:

• project-id: The project ID
• instance-id: The instance ID

HTTP method and URL:

GET https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id

To send your request, expand one of these options:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://sqladmin.googleapis.com/v1/projects/project-id/instances/instance-id" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

 {   "settings":   {     "authorizedGaeApplications": [],     "tier": "machine-type",     "kind": "sql#settings",     "availabilityType": "REGIONAL",     "pricingPlan": "PER_USE",     "replicationType": "SYNCHRONOUS",     "activationPolicy": "ALWAYS",     "ipConfiguration":     {       "privateNetwork": "projects/project-id/global/networks/default",       "authorizedNetworks": [],       "ipv4Enabled": false     },     "locationPreference":     {       "zone": "zone",       "kind": "sql#locationPreference"     },     "databaseFlags": [       {         "name": "general_log",         "value": "on"       }     ],     "dataDiskType": "PD_SSD",     "maintenanceWindow":     {       "kind": "sql#maintenanceWindow",       "hour": 0,       "day": 0     },     "backupConfiguration":     {       "startTime": "03:00",       "kind": "sql#backupConfiguration",       "enabled": true,       "binaryLogEnabled": true     },     "settingsVersion": "54",     "storageAutoResizeLimit": "0",     "storageAutoResize": true,     "dataDiskSizeGb": "10"   } } 

In the output, look for the databaseFlags field.

REST v1beta4

To list flags configured for an instance:

Before using any of the request data, make the following replacements:

• project-id: The project ID
• instance-id: The instance ID

HTTP method and URL:

GET https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id

To send your request, expand one of these options:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id"

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances/instance-id" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

 {   "settings":   {     "authorizedGaeApplications": [],     "tier": "machine-type",     "kind": "sql#settings",     "availabilityType": "REGIONAL",     "pricingPlan": "PER_USE",     "replicationType": "SYNCHRONOUS",     "activationPolicy": "ALWAYS",     "ipConfiguration":     {       "privateNetwork": "projects/project-id/global/networks/default",       "authorizedNetworks": [],       "ipv4Enabled": false     },     "locationPreference":     {       "zone": "zone",       "kind": "sql#locationPreference"     },     "databaseFlags": [       {         "name": "general_log",         "value": "on"       }     ],     "dataDiskType": "PD_SSD",     "maintenanceWindow":     {       "kind": "sql#maintenanceWindow",       "hour": 0,       "day": 0     },     "backupConfiguration":     {       "startTime": "03:00",       "kind": "sql#backupConfiguration",       "enabled": true,       "binaryLogEnabled": true     },     "settingsVersion": "54",     "storageAutoResizeLimit": "0",     "storageAutoResize": true,     "dataDiskSizeGb": "10"   } } 

In the output, look for the databaseFlags field.