Criar réplicas de leitura

Esta página descreve como criar uma réplica de leitura para uma instância do Cloud SQL.

Uma réplica de leitura é uma cópia da instância principal que reflete as alterações nela quase em tempo real, em circunstâncias normais. É possível usar uma réplica de leitura para descarregar solicitações de leitura ou tráfego de análise a partir da instância principal.

Além disso, para recuperação de desastres, é possível fazer uma migração regional. Se uma réplica for uma réplica entre regiões, é possível realizar um failover para outra região. Especificamente, você pode promover uma réplica para uma instância autônoma (nesse caso, as réplicas existentes não considerariam essa instância como primária).

Para mais informações sobre como funciona a replicação, consulte Replicação no Cloud SQL.

Antes de começar

Se você estiver criando a primeira réplica para essa instância, verifique se ela atende aos requisitos das instâncias principais. Saiba mais.

Criar uma réplica de leitura

As etapas para criar uma réplica de leitura estão abaixo.

Console

  1. No console do Google Cloud, acesse a página Instâncias do Cloud SQL.

    Acesse "Instâncias do Cloud SQL"

  2. Encontre a instância em que uma réplica será criada e abra o menu more actions à direita da listagem.
  3. Selecione Criar réplica de leitura.

    Se você não vir essa opção, a instância é uma réplica. Não é possível criar uma réplica de uma réplica.

  4. Na seção Personalizar a instância da página, atualize as configurações da réplica. Comece clicando em Mostrar opções de configuração para exibir os grupos de configurações. Em seguida, expanda os grupos cujas configurações você quer revisar e personalizar. Um resumo de todas as opções selecionadas aparece à direita. A personalização dessas configurações é opcional. Os padrões são atribuídos em todos os casos em que nenhuma personalização é feita.

    Para mais detalhes sobre cada configuração, consulte a página de configurações da instância.

    Por exemplo, para permitir que outros serviços do Google Cloud, como o BigQuery, acessem dados no Cloud SQL e façam consultas nesses dados por meio de uma conexão particular, expanda o grupo Conexões e desmarque a caixa de seleção IP público.

  5. Clique em Criar réplica.

    O Cloud SQL cria um backup, se necessário, e cria a réplica. Você retorna à página da instância principal.

gcloud

Crie a réplica:

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

Você pode especificar um tamanho de nível diferente usando o parâmetro --tier, se necessário.

Você pode especificar uma região diferente usando o parâmetro --region.

Se a instância primária tiver apenas um endereço IP interno e você quiser permitir que outros serviços do Google Cloud, como o BigQuery, acessem dados no Cloud SQL e façam consultas nesses dados por meio de uma conexão interna, adicione o parâmetro --enable-google-private-path ao comando.

Crie a réplica na mesma rede VPC que a instância primária. Também é possível especificar um allocated-ip-range-name nessa rede VPC. Se nenhum intervalo for especificado, a réplica será criada em um intervalo aleatório.

Terraform

Para criar uma réplica de leitura, use um recurso do Terraform. 

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

Use o método insert do recurso de instâncias para criar a réplica de failover. As propriedades "região" e "databaseVersion" precisam ser iguais às da mestre.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • project-id: o ID do projeto
  • database-version: string de versão de enumeração (por exemplo, POSTGRES_12)
  • primary-instance-name: o nome da instância principal.
  • primary-instance-region: a região da instância principal
  • replica-region: a região da instância da réplica
  • replica-name: o nome da instância da réplica
  • machine-type: string de enumeração do tipo de máquina. Por exemplo: "db-custom-1-3840"
  • private-network: a rede autorizada que você está adicionando ou selecionando para criar uma conexão particular.

Método HTTP e URL: 

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

Corpo JSON da solicitação:

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

Para enviar a solicitação, expanda uma destas opções:

Você receberá uma resposta JSON semelhante a esta:

REST v1beta4

Use o método insert do recurso de instâncias para criar a réplica de failover. As propriedades "região" e "databaseVersion" precisam ser iguais às da mestre.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • project-id: o ID do projeto
  • database-version: string de versão de enumeração (por exemplo, POSTGRES_12)
  • primary-instance-name: o nome da instância principal.
  • primary-instance-region: a região da instância principal
  • replica-region: a região da instância da réplica
  • replica-name: o nome da instância da réplica
  • machine-type: string de enumeração do tipo de máquina. Por exemplo: "db-custom-1-3840"
  • private-network: a rede autorizada que você está adicionando ou selecionando para criar uma conexão particular.

Método HTTP e URL: 

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

Corpo JSON da solicitação:

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

  }
}

Para enviar a solicitação, expanda uma destas opções:

Você receberá uma resposta JSON semelhante a esta:

Criar uma réplica de leitura de uma instância com o Private Service Connect ativado

Para criar uma réplica de leitura de uma instância com o Private Service Connect ativado, use a gcloud CLI ou a API. É possível criar essa réplica na mesma região ou em uma região diferente da instância principal (réplica de leitura entre regiões).

A réplica de leitura não pode ser replicada de uma instância com um tipo de conectividade diferente. Por exemplo, uma instância com o Private Service Connect ativado só pode ser replicada de outra instância do Private Service Connect. Ele também não pode ser replicada de uma instância compatível com conexões de IP externas ou de uma instância configurada com acesso a serviços particulares.

gcloud

Para criar uma réplica de leitura de uma instância, use o comando gcloud sql instances create:

gcloud sql instances create REPLICA_INSTANCE_NAME \
--master-instance-name=PRIMARY_INSTANCE_NAME \
--project=PROJECT_ID \
--region=REGION_NAME \
--enable-private-service-connect \
--allowed-psc-projects=ALLOWED_PROJECTS \
--availability-type=AVAILABILITY_TYPE \
--no-assign-ip

Faça as seguintes substituições:

  • REPLICA_INSTANCE_NAME: o nome da instância da réplica.
  • PRIMARY_INSTANCE_NAME: o nome da instância principal.
  • PROJECT_ID: o ID ou número do projeto do Google Cloud que contém a instância.
  • REGION_NAME: o nome da região da instância da réplica.

  • ALLOWED_PROJECTS: uma lista de IDs ou números de projetos permitidos, separados por vírgulas. Se um projeto não estiver na lista, não será possível usá-lo para criar uma instância e ativar o Private Service Connect para ele.

    O Cloud SQL não copia os projetos permitidos da instância principal para a réplica. Para cada réplica, é preciso criar um endpoint do Private Service Connect. Se você estiver usando o proxy de autenticação do Cloud SQL ou os conectores de linguagem do Cloud SQL, será necessário criar uma zona de DNS e um registro DNS para as réplicas.

  • AVAILABILITY_TYPE: ativar a alta disponibilidade para a promovida. Para esse parâmetro, especifique um dos seguintes valores:
    • REGIONAL: ativa a alta disponibilidade e é recomendado para instâncias de produção. A instância faz o failover para outra zona na sua região selecionada.
    • ZONAL: não fornece capacidade de failover. Esse é o valor padrão.

    Para mais informações sobre como configurar e remover a alta disponibilidade de instâncias, consulte Configurar uma instância existente para alta disponibilidade e Desativar a alta disponibilidade de uma instância.

REST v1

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PRIMARY_INSTANCE_NAME: o nome da instância principal.
  • PROJECT_ID: o ID ou número do projeto do Google Cloud que contém a instância.
  • REPLICA_INSTANCE_NAME: o nome da instância da réplica.
  • REGION_NAME: o nome da região da instância da réplica.
  • MACHINE_TYPE: o tipo de máquina da instância.
  • AVAILABILITY_TYPE: ativar a alta disponibilidade para a promovida. Para esse parâmetro, especifique um dos seguintes valores:
    • REGIONAL: ativa a alta disponibilidade e é recomendado para instâncias de produção. A instância faz o failover para outra zona na sua região selecionada.
    • ZONAL: não fornece capacidade de failover. Esse é o valor padrão.

    Para mais informações sobre como configurar e remover a alta disponibilidade de instâncias, consulte Configurar uma instância para alta disponibilidade e Desativar a alta disponibilidade de uma instância.

  • ALLOWED_PROJECTS: uma lista de IDs ou números de projetos permitidos, separados por vírgulas. Se um projeto não estiver na lista, não será possível usá-lo para criar uma instância e ativar o Private Service Connect para ele.

    O Cloud SQL não copia os projetos permitidos da instância principal para a réplica. Para cada réplica, é preciso criar um endpoint do Private Service Connect. Se você estiver usando o proxy do Cloud SQL Auth ou os conectores de linguagem do Cloud SQL, será necessário criar uma zona de DNS e um registro DNS para as réplicas.

Método HTTP e URL: 

POST https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances

Corpo JSON da solicitação:

{
  "masterInstanceName": "PRIMARY_INSTANCE_NAME",
  "project": "PROJECT_ID",
  "databaseVersion": "POSTGRES_13",
  "name": "REPLICA_INSTANCE_NAME",
  "region": "REGION_NAME",
  "kind": "sql#instance",
  "settings":
  {
    "tier": "MACHINE_TYPE",
    "availabilityType": "AVAILABILITY_TYPE",
    "settingsVersion": 0,
    "ipConfiguration": {
      "ipv4Enabled": false,
      "pscConfig": {
        "allowedConsumerProjects": [ALLOWED_PROJECTS],
        "pscEnabled": true
      }
    },
    "kind": "sql#settings",
    "pricingPlan": "PER_USE",
    "replicationType": "ASYNCHRONOUS",
    "tier": "MACHINE_TYPE"
  }
}

Para enviar a solicitação, expanda uma destas opções:

Você receberá uma resposta JSON semelhante a esta:

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/instances/REPLICA_INSTANCE_NAME",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2020-01-16T02:32:12.281Z",
  "operationType": "CREATE_REPLICA",
  "name": "OPERATION_ID",
  "targetId": "REPLICA_INSTANCE_NAME",
  "selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

REST v1beta4

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • PRIMARY_INSTANCE_NAME: o nome da instância principal.
  • PROJECT_ID: o ID ou número do projeto do Google Cloud que contém a instância.
  • REPLICA_INSTANCE_NAME: o nome da instância da réplica.
  • REGION_NAME: o nome da região da instância da réplica.
  • MACHINE_TYPE: o tipo de máquina da instância.
  • AVAILABILITY_TYPE: ativar a alta disponibilidade para a promovida. Para esse parâmetro, especifique um dos seguintes valores:
    • REGIONAL: ativa a alta disponibilidade e é recomendado para instâncias de produção. A instância faz o failover para outra zona na sua região selecionada.
    • ZONAL: não fornece capacidade de failover. Esse é o valor padrão.

    Para mais informações sobre como configurar e remover a alta disponibilidade de instâncias, consulte Configurar uma instância para alta disponibilidade e Desativar a alta disponibilidade de uma instância.

  • ALLOWED_PROJECTS: uma lista de IDs ou números de projetos permitidos, separados por vírgulas. Se um projeto não estiver na lista, não será possível usá-lo para criar uma instância e ativar o Private Service Connect para ele.

    O Cloud SQL não copia os projetos permitidos da instância principal para a réplica. Para cada réplica, é preciso criar um endpoint do Private Service Connect. Se você estiver usando o proxy do Cloud SQL Auth ou os conectores de linguagem do Cloud SQL, será necessário criar uma zona de DNS e um registro DNS para as réplicas.

Método HTTP e URL: 

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances

Corpo JSON da solicitação:

{
  "masterInstanceName": "PRIMARY_INSTANCE_NAME",
  "project": "PROJECT_ID",
  "databaseVersion": "POSTGRES_13",
  "name": "REPLICA_INSTANCE_NAME",
  "region": "REGION_NAME",
  "kind": "sql#instance",
  "settings":
  {
    "tier": "MACHINE_TYPE",
    "availabilityType": "AVAILABILITY_TYPE",
    "settingsVersion": 0,
    "ipConfiguration": {
      "ipv4Enabled": false,
      "pscConfig": {
        "allowedConsumerProjects": [ALLOWED_PROJECTS],
        "pscEnabled": true
      }
    },
    "kind": "sql#settings",
    "pricingPlan": "PER_USE",
    "replicationType": "ASYNCHRONOUS",
    "tier": "MACHINE_TYPE"
  }
}

Para enviar a solicitação, expanda uma destas opções:

Você receberá uma resposta JSON semelhante a esta:

{
  "kind": "sql#operation",
  "targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/REPLICA_INSTANCE_NAME",
  "status": "PENDING",
  "user": "user@example.com",
  "insertTime": "2020-01-16T02:32:12.281Z",
  "operationType": "CREATE_REPLICA",
  "name": "OPERATION_ID",
  "targetId": "REPLICA_INSTANCE_NAME",
  "selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/operations/OPERATION_ID",
  "targetProject": "PROJECT_ID"
}

Configurar réplicas de leitura para autenticação do banco de dados do IAM

Se você ativar a sinalização cloudsql.iam_authentication na instância primária, o Cloud SQL para PostgreSQL a ativará automaticamente nas réplicas de leitura. No entanto, se você não ativar essa sinalização na instância principal, o Cloud SQL para PostgreSQL não a ativará nas réplicas de leitura. Não é possível usar as réplicas para autenticação do banco de dados do IAM.

Para configurar uma réplica de leitura para autenticação do banco de dados do IAM, siga estas instruções:

  1. No console do Google Cloud, acesse a página Instâncias do Cloud SQL.

    Acesse Instâncias do Cloud SQL

  2. Para abrir a página Visão geral de uma instância, clique no nome da instância.
  3. No bloco de configuração, procure a sinalização cloudsql.iam_authentication. Se a sinalização não estiver na lista, a ativação da sinalização na réplica de leitura não será necessária. Se a sinalização estiver na lista, você precisará ativá-la na réplica de leitura. Se você precisar ativar a sinalização na réplica de leitura, prossiga para a próxima etapa.
  4. Selecione Réplicas no menu de navegação do SQL.
  5. Clique no nome da réplica que você quer editar.
  6. Clique em Editar.
  7. Na seção Opções de configuração, expanda Sinalizações.
  8. Selecione + Adicionar item.
  9. Insira cloudsql.iam_authentication como o nome da sinalização. Verifique se Ativado está selecionado para essa sinalização.
  10. Clique em Save.

Criar réplicas em cascata

Nesta seção, descrevemos como criar e gerenciar réplicas em cascata. Para saber mais sobre como as réplicas em cascata funcionam, consulte Réplicas em cascata.

Antes de começar

A instância principal precisa ter uma réplica de leitura. Para mais informações sobre como criar instâncias principais, consulte Criar uma réplica de leitura.

Etapas para criar uma réplica em cascata

Console

  1. No console do Google Cloud, acesse a página Instâncias do Cloud SQL.

    Acesse "Instâncias do Cloud SQL"

  2. Clique na guia Réplicas da réplica que atuará como mãe da réplica que você quer criar.
  3. Clique em Criar réplica.
  4. Na página Criar réplica de leitura, atualize o ID da instância e todas as outras opções de configuração, incluindo nome, região e zona.
  5. Clique em Criar.

    O Cloud SQL cria uma réplica. Você retorna à página da instância da réplica mãe.

  6. Siga as etapas de 4 a 6 para cada nova réplica em cascata que você queira criar.

gcloud

  1. Crie a nova réplica especificando sua réplica principal como a instância principal usando a sinalização --master-instance-name:

    gcloud sql instances create REPLICA_NAME \
      --master-instance-name=PARENT_REPLICA_NAME \
    Substitua:
    • REPLICA_NAME: o ID exclusivo da réplica que você está criando
    • PARENT_REPLICA_NAME: o nome da réplica mãe

  2. Após a criação da réplica, é possível ver que as alterações feitas na instância principal são replicadas por todas as réplicas na cadeia de réplicas em cascata.

curl

  1. Para criar uma réplica sob a réplica mãe, edite o exemplo de código JSON a seguir e salve-o em um arquivo chamado request.json: 

    {
  "masterInstanceName": "PARENT_REPLICA_NAME",
  "project": "PROJECT_ID",
  "name": "REPLICA_NAME",
  "region": "REPLICA_REGION",
  "settings":
    {
      "tier": "MACHINE_TYPE",
    }
}
  2. Execute este comando: 
    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"

Resolver problemas

Problema Solução de problemas
A réplica de leitura não começou a ser replicada na criação. Provavelmente há um erro mais específico nos arquivos de registro. Inspecione os registros no Cloud Logging para encontrar o erro real.
Não foi possível criar a réplica de leitura: erro invalidFlagValue. Uma das sinalizações na solicitação é inválida. Pode ser uma sinalização fornecida explicitamente ou uma que foi definida como um valor padrão.

Primeiro, verifique se o valor da sinalização max_connections é maior ou igual ao valor na instância principal.

Se a sinalização max_connections estiver definida corretamente, inspecione os registros no Cloud Logging para encontrar o erro real.
Não foi possível criar a réplica de leitura: erro desconhecido. Provavelmente há um erro mais específico nos arquivos de registro. Inspecione os registros no Cloud Logging para encontrar o erro real.

Se o erro for: set Service Networking service account as servicenetworking.serviceAgent role on consumer project, desative e reative o Service Networking API. Essa ação cria a conta de serviço necessária para continuar com o processo.
O disco está cheio. O tamanho do disco da instância principal pode ficar cheio durante a criação da réplica. Edite a instância principal com upgrade para um tamanho de disco maior.
O espaço em disco aumenta significativamente. Um slot que não está sendo usado ativamente para rastrear dados faz com que o PostgreSQL mantenha os segmentos de WAL indefinidamente, fazendo com que o espaço em disco aumente indefinidamente. Se você usar os recursos de replicação e decodificação lógica no Cloud SQL, os slots de replicação serão criados e descartados automaticamente. Os slots de replicação não utilizados podem ser detectados consultando a visualização do sistema pg_replication_slots e filtrando a coluna active. Os slots não utilizados podem ser descartados para remover segmentos WAL usando o comando pg_drop_replication_slot.
A instância da réplica está usando memória demais. A réplica usa memória temporária para armazenar em cache as operações de leitura solicitadas com frequência, o que pode fazer com que ela use mais memória do que a instância principal.

Reinicie a instância da réplica para recuperar o espaço de memória temporário.
Replicação interrompida. O limite máximo de armazenamento foi atingido e o aumento automático de armazenamento não está ativado.

Edite a instância para ativar automatic storage increase.
O atraso da replicação é consistentemente alto. A carga de gravação é alta demais para a réplica processar. O atraso de replicação ocorre quando a linha de execução SQL em uma réplica não consegue acompanhar a linha de execução de E/S. Alguns tipos de consultas ou cargas de trabalho podem causar um atraso de replicação temporário ou permanente para um determinado esquema. Estas são algumas das causas comuns do atraso de replicação:
  • Consultas lentas na réplica. Encontre e corrija esses problemas.
  • Todas as tabelas precisam ter uma chave primária/exclusiva. Cada atualização em uma tabela sem uma chave exclusiva/principal resulta em varreduras completas na tabela da réplica.
  • Consultas como DELETE ... WHERE field < 50000000 causam atraso de replicação com base em linha, já que um grande número de atualizações é acumulado na réplica.

Algumas soluções possíveis incluem:

  • Editar a instância para aumentar o tamanho da réplica.
  • Reduza a carga no banco de dados.
  • Envia o tráfego de leitura para a réplica de leitura.
  • Inclua as tabelas em um índice.
  • Identifique e corrija consultas de gravação lentas.
  • Recrie a réplica.
Erros ao recriar índices no PostgreSQL 9.6. Você recebe um erro do PostgreSQL informando que é necessário recriar um índice específico. Isso só pode ser feito na instância principal. Se você criar uma nova instância de réplica, em breve receberá o mesmo erro novamente. Os índices de hash não são propagados para réplicas nas versões do PostgreSQL abaixo de 10.

Se você precisar usar índices de hash, faça upgrade para o PostgreSQL 10+. Caso contrário, se você também quiser usar réplicas, não use índices de hash no PostgreSQL 9.6.
A consulta na instância principal está sempre em execução. Após a criação de uma réplica, a consulta SELECT * from pg_stat_activity where state = 'active' and pid = XXXX and username = 'cloudsqlreplica' deve ser executada continuamente em sua instância principal.
A criação da réplica falha com o tempo limite. Transações não confirmadas de longa duração na instância primária podem causar falha na criação da réplica de leitura.

Recrie a réplica depois de interromper todas as consultas em execução.
Se a instância principal e a réplica tiverem tamanhos de vCPU diferentes, poderá haver problemas de desempenho de consultas porque o otimizador de consultas considera os tamanhos de vCPU.

Para resolver esse problema, siga estas etapas:

  1. Ative a flag log_duration e defina o parâmetro log_statement como ddl. Assim, você terá acesso às consultas e ao ambiente de execução no banco de dados. No entanto, dependendo da carga de trabalho, isso pode causar problemas de desempenho.
  2. Na instância principal e na réplica de leitura, execute explain analyze para as consultas.
  3. Compare o plano de consulta e verifique as diferenças.

Se for uma consulta específica, modifique a consulta. Por exemplo, é possível mudar a ordem das mesclagens para ver se o desempenho melhora.

A seguir