Create read replicas

Console

1. In the Google Cloud Console, go to the Cloud SQL Instances page.

   Go to Cloud SQL Instances

2. Find the instance you want to create a replica for, and open its more actions menu at the far right of its listing.

   

3. Select Create read replica.

   If you do not see that choice, the instance is a replica; you cannot create a replica of a replica.

4. Click Create.

   You are returned to the instance page for the master.

gcloud

Create the replica:

gcloud sql instances create REPLICA_NAME \
--master-instance-name=MASTER_INSTANCE_NAME
  

You can specify a different tier size using the --tier parameter, if needed.

You can specify a different region using the --region parameter.

If the primary instance has a private IP address only, add the --no-assign-ip parameter to the command.

You must create the replica in the same VPC network as the primary instance. You can also specify an allocated-ip-range-name in that VPC network. If no range is specified, the replica is created in a random range.

REST v1beta4

Use the insert method of the instances resource to create the read replica. The region and databaseVersion properties must be the same as the master.

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

• project-id: The project ID
• database-version: Enum version string (for example, SQLSERVER_2017_ENTERPRISE)
• primary-instance-name: The name of the primary instance
• primary-instance-region: The region of the primary instance
• replica-region: The region of the replica instance
• replica-name: The name of the replica instance
• machine-type: Enum string of the machine type. For example: "db-custom-1-3840"

HTTP method and URL:

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

Request JSON body:

{
  "masterInstanceName": "primary-instance-name",
  "project": "project-id",
  "databaseVersion": "database-version",
  "name": "replica-name",
  "region": "replica-region",
  "settings":
  {
    "tier": "machine-type",
    "settingsVersion": 0,
  }
}

To send your request, expand one of these options:

curl -X POST \
-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"

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

Invoke-WebRequest `
  -Method POST `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -InFile request.json `
  -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/instances" | 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": "user@example.com",
  "insertTime": "2020-01-21T22:43:37.981Z",
  "operationType": "CREATE_REPLICA",
  "name": "operation-id",
  "targetId": "instance-id",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/project-id/operations/operation-id",
  "targetProject": "project-id"
}