リードレプリカを作成する

MySQL | PostgreSQL | SQL Server

このページでは、Cloud SQL インスタンスのリードレプリカを作成する方法について説明します。

リードレプリカとは、プライマリインスタンスのコピーのことで、プライマリへの変更が通常の状況下で、ほぼリアルタイムで反映されます。リードレプリカは、プライマリインスタンスからの読み取りリクエストやアナリティクストラフィックをオフロードするために使用します。

また、障害復旧では、リージョンを移行することもできます。レプリカがクロスリージョンレプリカの場合は、別のリージョンにフェイルオーバーできます。たとえば、レプリカをスタンドアロンインスタンスに昇格できます（この場合、このインスタンスは既存のレプリカのプライマリとは見なされません）。

レプリケーションの仕組みについて詳しくは、Cloud SQL のレプリケーションをご覧ください。

始める前に

このインスタンスのレプリカを初めて作成する場合は、インスタンスがプライマリインスタンスの要件を満たしていることを確認してください。詳細

リードレプリカを作成する

リードレプリカを作成する手順は次のとおりです。

コンソール

Google Cloud コンソールで Cloud SQL の [インスタンス] ページに移動します。

Cloud SQL の [インスタンス] に移動
レプリカを作成するインスタンスを探して、リストの右端にある [more actions] メニューを開きます。
[リードレプリカを作成] を選択します。
この選択肢が表示されない場合、そのインスタンスはレプリカです。レプリカのレプリカを作成することはできません。
このページの [インスタンスのカスタマイズ] セクションで、レプリカの設定を更新します。最初に [構成オプションを表示] をクリックして、設定のグループを表示します。次に、目的のグループを開いて設定を確認し、カスタマイズします。選択したすべてのオプションの [サマリー] が右側に表示されます。これらの設定のカスタマイズはオプションです。カスタマイズを行わない場合、デフォルト値が割り当てられます。

各設定の詳細については、インスタンスの設定ページをご覧ください。

たとえば、BigQuery などの他の Google Cloud サービスが Cloud SQL のデータにアクセスし、プライベート接続でこのデータに対してクエリを実行できるようにするには、[接続] グループを開き、[パブリック IP] チェックボックスをオフにします。
[レプリカを作成する] をクリックします。
Cloud SQL により、必要に応じてバックアップが作成され、レプリカが作成されます。プライマリのインスタンスページに戻ります。

gcloud

レプリカを作成します。

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

必要な場合は、--tier パラメータを使用して異なる階層サイズを指定できます。

--region パラメータを使用して別のリージョンを指定できます。

プライマリインスタンスにプライベート IP アドレスしかなく、BigQuery などの他の Google Cloud サービスが Cloud SQL のデータにアクセスし、プライベート接続でこのデータに対してクエリを実行できるようにする場合、その後に --enable-google-private-path パラメータをコマンドに追加します。

レプリカは、プライマリインスタンスと同じ VPC ネットワーク内に作成する必要があります。同じ VPC ネットワークで allocated-ip-range-name を指定することもできます。範囲が指定されていない場合、レプリカはランダムな範囲で作成されます。

Terraform

リードレプリカを作成するには、Terraform リソースを使用します。

cloud_sql/postgres_instance_replica/main.tf

GitHub で表示フィードバック

resource "google_sql_database_instance" "read_replica" {
  name                 = "postgres-replica-instance-name"
  master_instance_name = google_sql_database_instance.primary.name
  region               = "europe-west4"
  database_version     = "POSTGRES_14"

  settings {
    tier              = "db-custom-2-7680"
    availability_type = "ZONAL"
    disk_size         = "100"
  }
  # 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
}

REST v1

インスタンスリソースの insert メソッドを使用してリードレプリカを作成します。リージョンと databaseVersion プロパティはマスターと同じにする必要があります。

リクエストのデータを使用する前に、次のように置き換えます。

project-id: プロジェクト ID
database-version: バージョンの列挙型文字列（POSTGRES_12 など）
primary-instance-name: プライマリインスタンスの名前
primary-instance-region: プライマリインスタンスのリージョン
replica-region: レプリカインスタンスのリージョン
replica-name: レプリカインスタンスの名前
machine-type: マシンタイプの列挙型文字列。例: 「db-custom-1-3840」
private-network: プライベート接続を作成するために追加または選択している承認済みネットワーク。

ipv4Enabled パラメータ値を false に設定したのは、Cloud SQL インスタンスをパブリック IP アドレスではなく、プライベート IP アドレスと関連付けたいからです。

HTTP メソッドと URL:

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

リクエストの本文（JSON）:

{
  "masterInstanceName": "primary-instance-name",
  "project": "project-id",
  "databaseVersion": "database-version",
  "name": "replica-name",
  "region": "replica-region",
  "settings":
  {
    "tier": "machine-type",
    "settingsVersion": 0,
    "ipConfiguration": {
    object (IpConfiguration)
  },
  {
  "ipv4Enabled": false,
  "privateNetwork": private-network,
  "requireSsl": boolean,
  "authorizedNetworks": [
    {
      object (AclEntry)
    }
  ],
  "allocatedIpRange": string
    }
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザーアカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

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/v1/projects/project-id/instances"

PowerShell（Windows）

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$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/v1/projects/project-id/instances" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

レスポンス

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/v1/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/v1/projects/project-id/operations/operation-id",
  "targetProject": "project-id"
}

REST v1beta4

リクエストのデータを使用する前に、次のように置き換えます。

project-id: プロジェクト ID
database-version: バージョンの列挙型文字列（POSTGRES_12 など）
primary-instance-name: プライマリインスタンスの名前
primary-instance-region: プライマリインスタンスのリージョン
replica-region: レプリカインスタンスのリージョン
replica-name: レプリカインスタンスの名前
machine-type: マシンタイプの列挙型文字列。例: 「db-custom-1-3840」
private-network: プライベート接続を作成するために追加または選択している承認済みネットワーク。

HTTP メソッドと URL:

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

リクエストの本文（JSON）:

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

    "ipConfiguration": {
    object (IpConfiguration)
  },
  {
  "ipv4Enabled": false,
  "privateNetwork": private-network,
  "requireSsl": boolean,
  "authorizedNetworks": [
    {
      object (AclEntry)
    }
  ],
  "allocatedIpRange": string
    }

  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

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"

PowerShell（Windows）

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$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

次のような JSON レスポンスが返されます。

レスポンス

{
  "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"
}

IAM データベース認証のリードレプリカを構成する

プライマリインスタンスで cloudsql.iam_authentication フラグを有効にすると、Cloud SQL for PostgreSQL はリードレプリカでフラグを自動的に有効にします。ただし、プライマリインスタンスでこのフラグを有効にしない場合、Cloud SQL for PostgreSQL はリードレプリカで有効にしません。IAM データベース認証にレプリカを使用することはできません。

IAM データベース認証のリードレプリカを構成するには:

Google Cloud Console で Cloud SQL の [インスタンス] ページに移動します。

Cloud SQL の [インスタンス] に移動
インスタンスの [概要] ページを開くには、インスタンス名をクリックします。
[構成] タイルで、cloudsql.iam_authentication フラグを探します。フラグがリストにない場合は、リードレプリカでフラグを有効にする必要はありません。フラグがリストにある場合は、リードレプリカでフラグを有効にする必要があります。リードレプリカでフラグを有効にする必要がある場合は、次の手順に進みます。
SQL ナビゲーションメニューから [レプリカ] を選択します。
編集するレプリカの名前をクリックします。
[編集] をクリックします。
[構成オプション] セクションで、[フラグ] を開きます。
[+ 追加] を選択します。
フラグ名として「cloudsql.iam_authentication」と入力します。このフラグに対して [オン] が選択されていることを確認します。
[保存] をクリックします。

カスケードレプリカを作成する

このセクションでは、カスケードレプリカの作成と管理の方法ついて説明します。カスケードレプリカの仕組みについては、レプリカのカスケードをご覧ください。

始める前に

プライマリインスタンスにはリードレプリカが必要です。プライマリインスタンスの作成の詳細については、リードレプリカを作成するをご覧ください。

カスケードレプリカの作成手順

コンソール

Google Cloud コンソールで Cloud SQL の [インスタンス] ページに移動します。

Cloud SQL の [インスタンス] に移動
作成するレプリカの親として機能するレプリカ用の [レプリカ] タブをクリックします。
[レプリカを作成する] をクリックします。
[リードレプリカを作成する] ページで、インスタンス ID とその他の構成オプション（名前、リージョン、ゾーンなど）を更新します。
[作成] をクリックします。
Cloud SQL がレプリカを作成します。親レプリカのインスタンスページに戻ります。
作成する新しいカスケードレプリカごとに手順 4～6 を行います。

gcloud

新しいレプリカを作成するには、--master-instance-name フラグを使用してプライマリレプリカをプライマリインスタンスとして指定します。
```
gcloud sql instances create REPLICA_NAME \
      --master-instance-name=PARENT_REPLICA_NAME \
```
次のように置き換えます。
- REPLICA_NAME: 作成するレプリカの一意の ID
- PARENT_REPLICA_NAME: 親レプリカの名前

レプリカが作成されると、プライマリインスタンスに対して行われた変更がカスケードレプリカチェーン内のすべてのレプリカで複製されることがわかります。

curl

親レプリカの下にレプリカを作成するには、次の JSON コードサンプルを編集し、request.json というファイルに保存します。

{
  "masterInstanceName": "PARENT_REPLICA_NAME",
  "project": "PROJECT_ID",
  "name": "REPLICA_NAME",
  "region": "REPLICA_REGION",
  "settings":
    {
      "tier": "MACHINE_TYPE",
    }
}

次のコマンドを実行します。

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/v1/projects/PROJECT_ID/instances"

トラブルシューティング

問題	トラブルシューティング
作成時にリードレプリカがレプリケーションを開始しなかった。	ログファイルに、より具体的なエラーが記録されている可能性があります。Cloud Logging のログを調べて、実際のエラーを確認します。
リードレプリカを作成できない - invalidFlagValue エラー。	リクエスト内のフラグのいずれかが無効です。これは、明示的に指定されたフラグか、デフォルト値に設定されたフラグである可能性があります。まず、`max_connections` フラグの値がプライマリの値以上であることを確認します。 `max_connections` フラグが適切に設定されている場合、Cloud Logging のログを調べて、実際のエラーを確認します。
リードレプリカを作成できない - 不明なエラー。	ログファイルに、より具体的なエラーが記録されている可能性があります。Cloud Logging のログを調べて、実際のエラーを確認します。エラーが `set Service Networking service account as servicenetworking.serviceAgent role on consumer project` の場合は、`Service Networking API` を無効にしてから再度有効にします。この措置で、プロセスを続行するために必要なサービスアカウントが作成されます。
ディスクに空きがない。	レプリカの作成中にプライマリインスタンスのディスクの空きがなくなる可能性があります。プライマリインスタンスを編集して、より大きなディスクサイズにアップグレードします。
ディスク容量が大幅に増加します。	データの追跡に使用されていないスロットでは、PostgreSQL が WAL セグメントに無期限に維持するため、ディスク容量は無期限に増加します。Cloud SQL で論理レプリケーションと論理デコーディング機能を使用すると、レプリケーションスロットが自動的に作成、削除されます。`pg_replication_slots` システムビューにクエリを実行し、`active` 列でフィルタリングすると、未使用のレプリケーションスロットを検出できます。未使用のスロットを削除することで、`pg_drop_replication_slot` コマンドで WAL セグメントを削除できます。
レプリカインスタンスのメモリ使用量が多すぎる。	レプリカは一時メモリを使用して頻繁にリクエストされる読み取りオペレーションをキャッシュに保存するため、プライマリインスタンスより多くのメモリを使用する可能性があります。レプリカインスタンスを再起動して、一時メモリ領域を再利用します。
レプリケーションが停止した。	ストレージの上限に達しており、ストレージの自動増量が有効になっていません。インスタンスを編集して `automatic storage increase` を有効にします。
レプリケーションラグが常に大きい。	書き込みの負荷が大きすぎてレプリカで処理できません。レプリケーションラグは、レプリカの SQL スレッドで IO スレッドに対応できない場合に発生します。クエリやワークロードによっては、特定のスキーマで一時的または永続的に高いレプリケーションラグが発生することがあります。レプリケーションラグの一般的な原因は次のとおりです。レプリカのクエリが遅い。遅いクエリを見つけて修正します。すべてのテーブルに一意キーまたは主キーが必要です。一意のキーまたは主キーのないテーブルを更新するたびに、レプリカでテーブル全体がスキャンされます。 `DELETE ... WHERE field < 50000000` などのクエリでは、レプリカに膨大な数の更新が蓄積されるため、行ベースのレプリケーションでレプリケーションラグが発生します。考えられる解決策は次のとおりです。インスタンスを編集してレプリカのサイズを増やします。データベースの負荷を軽減します。リードレプリカにリードトラフィックを送信します。テーブルをインデックスに登録します。遅い書き込みクエリを特定して修正します。レプリカを再作成します。
PostgreSQL 9.6 でインデックスを再構築する際のエラー。	特定のインデックスを再構築する必要があることを示す PostgreSQL のエラーが発生します。これは、プライマリインスタンスでのみ行うことができます。新しいレプリカインスタンスを作成すると、すぐに同じエラーが発生します。バージョン 10 より前の PostgreSQL ではハッシュインデックスはレプリカに伝播されません。ハッシュインデックスを使用する必要がある場合は、PostgreSQL 10 以降にアップグレードしてください。レプリカも使用する場合は、PostgreSQL 9.6 でハッシュインデックスを使用しないでください。
プライマリインスタンスでのクエリは常に実行中です。	レプリカの作成後、クエリ `SELECT * from pg_stat_activity where state = 'active' and pid = XXXX and username = 'cloudsqlreplica'` はプライマリインスタンスで継続的に実行されます。
レプリカの作成がタイムアウトで失敗する。	プライマリインスタンスで長時間 commit されていないトランザクションが実行されると、リードレプリカの作成に失敗することがあります。実行中のクエリをすべて停止してからレプリカを再作成します。

次のステップ

レプリカの管理について学習します。
クロスリージョンレプリカについて学習する。

リードレプリカを作成する

始める前に

リードレプリカを作成する

コンソール

gcloud

Terraform

REST v1

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

レスポンス

REST v1beta4

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

レスポンス

IAM データベース認証のリードレプリカを構成する

カスケード レプリカを作成する

始める前に

カスケード レプリカの作成手順

コンソール

gcloud

curl

トラブルシューティング

次のステップ

カスケードレプリカを作成する

カスケードレプリカの作成手順