ALTER FAILOVER GROUP¶

Sintaxe¶

Conta de origem

ALTER FAILOVER GROUP [ IF EXISTS ] <name> RENAME TO <new_name>

ALTER FAILOVER GROUP [ IF EXISTS ] <name> SET
  [ OBJECT_TYPES = <object_type> [ , <object_type> , ... ] ]
  [ ALLOWED_DATABASES = <db_name> [ , <db_name> , ... ] ]
  [ ALLOWED_SHARES = <share_name> [ , <share_name> , ... ] ]
  [ REPLICATION_SCHEDULE = '{ <num> MINUTE | USING CRON <expr> <time_zone> }' ]
  [ ENABLE_ETL_REPLICATION = { TRUE | FALSE } ]

ALTER FAILOVER GROUP [ IF EXISTS ] <name> SET
  OBJECT_TYPES = INTEGRATIONS [ , <object_type> , ... ]
  ALLOWED_INTEGRATION_TYPES = <integration_type_name> [ , <integration_type_name> ... ]
  [ REPLICATION_SCHEDULE = '{ <num> MINUTE | USING CRON <expr> <time_zone> }' ]

ALTER FAILOVER GROUP [ IF EXISTS ] <name>
  ADD <db_name> [ , <db_name> ,  ... ] TO ALLOWED_DATABASES

ALTER FAILOVER GROUP [ IF EXISTS ] <name>
  MOVE DATABASES <db_name> [ , <db_name> ,  ... ] TO FAILOVER GROUP <move_to_fg_name>

ALTER FAILOVER GROUP [ IF EXISTS ] <name>
  REMOVE <db_name> [ , <db_name> ,  ... ] FROM ALLOWED_DATABASES

ALTER FAILOVER GROUP [ IF EXISTS ] <name>
  ADD <share_name> [ , <share_name> ,  ... ] TO ALLOWED_SHARES

ALTER FAILOVER GROUP [ IF EXISTS ] <name>
  MOVE SHARES <share_name> [ , <share_name> ,  ... ] TO FAILOVER GROUP <move_to_fg_name>

ALTER FAILOVER GROUP [ IF EXISTS ] <name>
  REMOVE <share_name> [ , <share_name> ,  ... ] FROM ALLOWED_SHARES

ALTER FAILOVER GROUP [ IF EXISTS ] <name>
  ADD <org_name>.<target_account_name> [ , <org_name>.<target_account_name> ,  ... ] TO ALLOWED_ACCOUNTS
  [ IGNORE EDITION CHECK ]

ALTER FAILOVER GROUP [ IF EXISTS ] <name>
  REMOVE <org_name>.<target_account_name> [ , <org_name>.<target_account_name> ,  ... ] FROM ALLOWED_ACCOUNTS

Conta de destino

ALTER FAILOVER GROUP [ IF EXISTS ] <name> REFRESH

ALTER FAILOVER GROUP [ IF EXISTS ] <name> PRIMARY

ALTER FAILOVER GROUP [ IF EXISTS ] <name> SUSPEND

ALTER FAILOVER GROUP [ IF EXISTS ] <name> RESUME

Parâmetros¶

Conta de origem

name

Especifica o identificador do grupo de failover.

RENAME TO new_name

new_name

Especifica o novo identificador do grupo de failover. O novo identificador não pode ser usado se o identificador já estiver sendo usado para uma replicação ou grupo de failover diferente.

Para obter mais detalhes, consulte Requisitos para identificadores.

SET ...

Especifica propriedades a serem definidas para o grupo de failover (separadas por espaços em branco, vírgulas ou novas linhas).

OBJECT_TYPES = object_type [ , object_type , ... ]

Redefina a lista de tipos de objeto para os quais você está permitindo replicação e failover da conta de origem para a(s) conta(s) de destino.

Nota

Para banco de dados e objetos compartilhados:

• Se DATABASES ou SHARES estiverem incluídos na lista OBJECT_TYPES e permanecerem na lista OBJECT_TYPES após a lista ser redefinida, a respectiva lista de objetos permitidos (ALLOWED_DATABASES ou ALLOWED_SHARES) permanecerá inalterada.

• Se a lista OBJECT_TYPES for redefinida para adicionar ou remover DATABASES, a lista ALLOWED_DATABASES será definida como NULL.

• Se a lista OBJECT_TYPES for redefinida para adicionar ou remover SHARES, a lista ALLOWED_SHARES será definida como NULL.

• Use as cláusulas ADD, MOVE e REMOVE para modificar a lista de bancos de dados ou objetos de compartilhamento permitidos.

Os seguintes tipos de objetos são suportados:

ACCOUNT PARAMETERS

Todos os parâmetros no nível da conta. Isso inclui parâmetros da conta e parâmetros que podem ser configurados para sua conta.

DATABASES

Adicionar objetos de banco de dados à lista de tipos de objetos. Se os objetos do banco de dados já tiverem sido incluídos na lista de tipos de objetos especificados, a lista ALLOWED_DATABASES permanecerá inalterada. Para modificar a lista de bancos de dados, use as cláusulas ADD, MOVE ou REMOVE.

INTEGRATIONS

Atualmente, somente segurança, API, armazenamento, acesso externo [#] e certos tipos de integrações de notificação são suportadas. Para obter mais detalhes, consulte Replicação de integrações.

Se objetos de integração estiverem incluídos na lista de tipos de objetos especificados, o parâmetro ALLOWED_INTEGRATION_TYPES deve ser definido.

NETWORK POLICIES

Todas as políticas de rede na conta de origem.

RESOURCE MONITORS

Todos os monitores de recursos na conta de origem.

ROLES

Todas as funções na conta de origem. A replicação de funções inclui implicitamente todas as concessões para os tipos de objetos incluídos no grupo de replicação. Por exemplo, se ROLES é o único tipo de objeto que é replicado, apenas hierarquias de funções (ou seja, funções concedidas a outras funções) são replicadas para contas de destino. Se o tipo de objeto USERS também estiver incluído, concessões de funções aos usuários também serão replicadas.

SHARES

Adicionar objetos de compartilhamento à lista de tipos de objetos. Se os objetos do banco de compartilhamento já tiverem sido incluídos na lista de tipos de objetos especificados, a lista ALLOWED_SHARES permanecerá inalterada. Para modificar a lista de compartilhamentos, use as cláusulas ADD, MOVE ou REMOVE.

USERS

Todos os usuários na conta de origem.

WAREHOUSES

Todos os warehouses na conta de origem.

2

O recurso de integração de acesso externo está atualmente em versão preliminar. O suporte para esse recurso está disponível para contas no AWS e Azure, exceto a região Gov.

ALLOWED_DATABASES = db_name [ , db_name , ... ]

Especifica o banco de dados ou lista de bancos de dados para os quais você está permitindo replicação e failover da conta de origem para a conta de destino. Para que você possa definir esse parâmetro, a lista OBJECT_TYPES deve incluir DATABASES.

db_name

Especifica o identificador do banco de dados.

ALLOWED_SHARES = share_name [ , share_name , ... ]

Especifica o compartilhamento ou a lista de compartilhamentos para os quais você está permitindo replicação e failover da conta de origem para a conta de destino. Para que você possa definir esse parâmetro, a lista OBJECT_TYPES deve incluir SHARES.

share_name

Especifica o identificador do compartilhamento.

Nota

Se as listas ALLOWED_DATABASES ou ALLOWED_SHARES forem modificadas, todos os objetos que estavam anteriormente na lista e foram removidos serão descartados em qualquer conta de destino com um grupo de failover secundário vinculado quando ocorrer a próxima operação de atualização.

ALLOWED_INTEGRATION_TYPES = integration_type_name [ , integration_type_name , ... ]

Tipo(s) de integrações para as quais você está permitindo replicação e failover da conta de origem para a conta de destino.

Essa propriedade requer que a lista OBJECT_TYPES inclua INTEGRATIONS para definir este parâmetro.

Os seguintes tipos de integração são suportados:

SECURITY INTEGRATIONS

Especifica as integrações de segurança.

Essa propriedade requer que a lista OBJECT_TYPES inclua ROLES.

API INTEGRATIONS

Especifica as integrações de API.

A integração de API requer uma configuração adicional depois que a integração de API for replicada para a conta de destino. Para obter mais informações, consulte Atualização do serviço remoto para integrações de API.

STORAGE INTEGRATIONS

Especifica as integrações de armazenamento.

EXTERNAL ACCESS INTEGRATIONS

Especifica integrações de acesso externo.

Recurso em versão preliminar — Aberto

Um suporte preliminar para esse recurso está disponível para contas no AWS e Azure, exceto a região Gov.

Para obter mais informações, consulte Replicação de procedimentos armazenados e funções definidas pelo usuário (UDFs).

NOTIFICATION INTEGRATIONS

Especifica as integrações de notificação.

Apenas alguns tipos de integrações de notificação são replicados. Para obter mais detalhes, consulte Replicação de integrações.

REPLICATION_SCHEDULE ...

Especifica o cronograma para atualizar grupos de failover secundários.

• USING CRON expr time_zone

  Especifica uma expressão cron e um fuso horário para a atualização do grupo secundário. Oferece suporte a um subconjunto de sintaxe de utilitário cron padrão.

  Para uma lista de fusos horários, consulte a lista de fusos horários do banco de dados tz (no Wikipedia).

  A expressão cron consiste nos seguintes campos:

  # __________ minute (0-59)
  # | ________ hour (0-23)
  # | | ______ day of month (1-31, or L)
  # | | | ____ month (1-12, JAN-DEC)
  # | | | | __ day of week (0-6, SUN-SAT, or L)
  # | | | | |
  # | | | | |
    * * * * *
  

  Os seguintes caracteres especiais são suportados:

  *

  Curinga. Especifica qualquer ocorrência do campo.

  L

  Significa “último”. Quando usado no campo do dia da semana, permite especificar construções como “a última sexta-feira” (“5L”) de um determinado mês. No campo do dia do mês, ele especifica o último dia do mês.

  /n

  Indica a enésima instância de uma determinada unidade de tempo. Cada quanta de tempo é computada independentemente. Por exemplo, se 4/3 estiver especificado no campo do mês, a atualização está programada para abril, julho e outubro (ou seja, a cada 3 meses, começando com o quarto mês do ano). O mesmo cronograma é mantido nos anos seguintes. Ou seja, a atualização não está programada para ser executada em janeiro (3 meses após a execução de outubro).

  Nota

  • Atualmente, a expressão cron avalia apenas em relação ao fuso horário especificado. Alterar o valor do parâmetro TIMEZONE para a conta (ou definir o valor no nível do usuário ou da sessão) não altera o fuso horário para a atualização.

  • A expressão cron define todos os tempos de execução válidos para a atualização. O Snowflake tenta atualizar grupos secundários com base nesse cronograma; no entanto, qualquer tempo de execução válido é ignorado se uma execução anterior não tiver sido concluída antes do próximo tempo de execução válido começar.

  • Quando tanto um dia específico do mês como um dia da semana são incluídos na expressão cron, a atualização é programada em dias que satisfaçam o dia do mês ou o dia da semana. Por exemplo, SCHEDULE = 'USING CRON 0 0 10-20 * TUE,THU UTC' programa uma atualização no horário 0AM em qualquer dia de 10 a 20 e também em qualquer terça-feira ou quinta-feira fora dessas datas.

• num MINUTE

  Especifica um intervalo (em minutos) de tempo de espera entre as atualizações. Aceita apenas números inteiros positivos.

  Também oferece suporte à sintaxe num M.

  Para evitar ambiguidade, um tempo de intervalo base é definido:

  • Quando o objeto é criado (usando CREATE <objeto>) ou

  • Quando um intervalo diferente é definido (usando ALTER <objeto> … SET REPLICATION_SCHEDULE)

  O tempo de intervalo base inicia o contador de intervalo a partir da hora atual do relógio. Por exemplo, se um valor INTERVAL de 10 estiver definido e a atualização for habilitada às 9:03h AM, a atualização será executada às 9:13h AM, 9:23h AM e assim por diante. Note que fazemos o melhor para assegurar precisão absoluta, mas apenas garantimos que as atualização não sejam executadas antes que seu intervalo definido ocorra (por exemplo, no exemplo atual, a tarefa poderia ser executada primeiro às 9:14h AM, mas definitivamente não será executada às 9:12h AM).

  Nota

  O valor máximo suportado é 11520 (8 dias). Se o cronograma de replicação tiver um valor num MINUTE maior, a operação de atualização nunca será executada.

ENABLE_ETL_REPLICATION = TRUE | FALSE

Recurso obsoleto

Este parâmetro agora está obsoleto. Para ativar a replicação ETL, você deve ativar o pacote 2024_01 BCR. Para obter mais informações, consulte os requisitos para a replicação ETL.

ADD db_name [ , db_name ,  ... ] TO ALLOWED_DATABASES

Especifica uma lista separada por vírgulas de bancos de dados adicionais para permitir a replicação e o failover. Para adicionar bancos de dados, DATABASES deve ser incluído na lista de tipos de objetos especificados. Se a lista de tipos de objetos ainda não inclui DATABASES, você deve adicioná-lo.

db_name

Especifica o identificador do banco de dados.

MOVE DATABASES db_name [ , db_name ,  ... ] TO FAILOVER GROUP move_to_fg_name

Especifica uma lista separada por vírgulas de bancos de dados para passar de um grupo de failover para outro grupo de failover. O grupo de failover para o qual os bancos de dados estão sendo movidos deve incluir DATABASES na lista de tipos de objetos especificados.

db_name

Especifica o identificador do banco de dados.

move_to_fg_name

Especifica o identificador do grupo de failover para o qual os bancos de dados estão sendo movidos.

REMOVE db_name [ , db_name ,  ... ] FROM ALLOWED_DATABASES

Especifica uma lista separada por vírgulas de bancos de dados a serem removidos da lista de bancos de dados habilitados para replicação e failover.

Nota

Quando você remove um banco de dados de um grupo de failover primário, o banco de dados é descartado em qualquer conta de destino com um grupo de failover secundário vinculado quando ocorre a próxima operação de atualização.

Para evitar a eliminação de bancos de dados na conta de destino, você pode eliminar o grupo de failover secundário antes da próxima vez que o grupo de failover primário modificado for replicado para a conta de destino. Quando você descarta o grupo de failover secundário, os bancos de dados secundários somente leitura incluídos no grupo tornam-se bancos de dados autônomos de leitura e gravação na conta de destino.

ADD share_name [ , share_name ,  ... ] TO ALLOWED_SHARES

Especifica uma lista separada por vírgulas de compartilhamentos adicionais para os quais deve-se habilitar a replicação e o failover. Para adicionar compartilhamentos, SHARES deve ser incluído na lista de tipos de objetos especificados. Se a lista de tipos de objetos ainda não inclui SHARES, você deve adicioná-lo.

share_name

Especifica o identificador do compartilhamento.

MOVE SHARES share_name [ , share_name ,  ... ] TO FAILOVER GROUP move_to_fg_name

Especifica uma lista separada por vírgulas de compartilhamentos para passar de um grupo de failover para outro grupo de failover. O grupo de failover para o qual os compartilhamentos estão sendo movidos deve incluir SHARES na lista de tipos de objetos especificados.

share_name

Especifica o identificador do compartilhamento.

move_to_fg_name

Especifica o identificador do grupo de failover para o qual os compartilhamentos estão sendo movidos.

REMOVE share_name [ , share_name ,  ... ] FROM ALLOWED_SHARES

Especifica uma lista separada por vírgulas de compartilhamentos a serem removidos da lista de compartilhamentos habilitados para replicação e failover.

Nota

Quando você remove um compartilhamento de um grupo de failover primário, o compartilhamento é descartado em qualquer conta de destino com um grupo de failover secundário quando ocorre a próxima operação de atualização.

ADD org_name.target_account_name [ , org_name.target_account_name ,  ... ] TO ALLOWED_ACCOUNTS

Especifica uma lista separada por vírgulas de contas de destino a adicionar ao grupo de failover primário para permitir a replicação e o failover de objetos especificados na conta de origem para a conta de destino. Grupos de failover secundários nas contas de destino dessa lista podem ser promovidos para servir como o grupo primário de failover em caso de failover.

org_name

Nome de sua organização no Snowflake.

target_account_name

Conta de destino na qual você está habilitando a replicação dos objetos especificados.

REMOVE org_name.target_account_name [ , org_name.target_account_name ,  ... ] FROM ALLOWED_ACCOUNTS

Especifica uma lista separada por vírgulas de contas de destino a remover do grupo de failover primário para desativar a replicação de objetos especificados na conta de origem para a conta de destino. A remoção de uma conta de destino desativa o failover da conta atual para essa conta de destino.

org_name

Nome de sua organização no Snowflake.

target_account_name

Conta de destino na qual você está desativando a replicação dos objetos especificados.

IGNORE EDITION CHECK

Permite replicar objetos para as contas no seguinte cenário:

O grupo de failover primário está em uma conta Business Critical (ou superior) e um contrato de parceiro comercial assinado está em vigor para armazenar dados PHI na conta segundo as regulamentações HIPAA e HITRUST. No entanto, nenhum contrato desse tipo está em vigor para uma ou mais contas aprovadas para replicação, independentemente de serem contas Business Critical (ou superiores).

Este cenário é proibido por padrão.

Conta de destino

name

Especifica o identificador do grupo de failover.

REFRESH

Atualiza os objetos na conta de destino (atual) a partir da conta de origem.

PRIMARY

Promover um grupo de failover secundário e seus objetos especificados na conta de destino (atual) para a conta primária (em caso de failover).

SUSPEND

Suspender a atualização programada do grupo de failover secundário (se o grupo primário de failover tiver atualizações programadas usando a propriedade REPLICATION_SCHEDULE).

RESUME

Retomar a atualização programada do grupo de failover secundário (se o grupo primário de failover tiver atualizações programadas usando a propriedade REPLICATION_SCHEDULE).

Notas de uso¶

• Os seguintes privilégios mínimos são necessários:

  • Para atualizar um grupo de failover secundário usando ALTER FAILOVER GROUP … REFRESH, a função principal ativa deve ter o privilégio OWNERSHIP ou REPLICATE sobre o grupo de failover.

  • Para executar um failover em um grupo de failover secundário usando ALTER FAILOVER GROUP … PRIMARY, uma função deve ter o privilégio OWNERSHIP ou FAILOVER sobre o grupo de failover.

  • Para fazer quaisquer outras mudanças no grupo de failover, somente uma função com o privilégio OWNERSHIP no grupo pode executar esse comando SQL.

  • Para adicionar um banco de dados a um grupo de failover, a função ativa deve ter o privilégio MONITOR sobre o banco de dados.

  • Para adicionar um compartilhamento a um grupo de failover, a função ativa deve ter o privilégio OWNERSHIP sobre o compartilhamento.

• Identificadores de grupos de failover e grupos de replicação em uma conta devem ser únicos.

• Objetos que não sejam bancos de dados e compartilhamentos precisam estar no mesmo grupo de failover.

• Um banco de dados só pode ser adicionado a um grupo de failover.

• Compartilhamentos de entrada (compartilhamentos de provedores) não podem ser adicionados a um grupo de replicação ou failover.

• Promover um grupo de failover secundário para um primário (em caso de failover) falhará se uma atualização estiver em andamento.

• Se uma atualização estiver em andamento quando o cronograma de replicação for atualizado, a atualização continuará até a conclusão e a próxima atualização utilizará o novo cronograma.

• No failover, as atualizações programadas em todos os grupos de failover secundários são suspensas. ALTER FAILOVER GROUP ... RESUME deve ser executado em cada secundário para retomar as atualizações automáticas.

• Para mover bancos de dados ou compartilhamentos de um grupo de failover (o grupo de origem) para outro grupo de failover (o grupo de destino):

  • Ambos os grupos devem ser do mesmo tipo: FAILOVER GROUP.

  • Se o último banco de dados do grupo de origem for movido para outro grupo, a propriedade allowed_databases para o grupo de origem é definida como NULL. O mesmo comportamento se aplica aos compartilhamentos.

  • Se o grupo de destino não tiver o tipo de objeto que está sendo movido (databases ou shares) na lista object_types, ele deverá ser explicitamente adicionado ao grupo de destino antes de você mover os objetos.

• Se os objetos de banco de dados ou de compartilhamento forem removidos de um grupo de failover primário (usando o parâmetro REMOVE ou o parâmetro SET para modificar as listas ALLOWED_DATABASES ou ALLOWED_SHARES), esses objetos serão descartados em qualquer conta de destino quando ocorrer a próxima operação de atualização.

  Para evitar a eliminação desses objetos na conta de destino, você pode eliminar o grupo de failover secundário antes da próxima vez que o grupo de failover primário modificado for replicado para a conta de destino.

• Para obter a lista de contas em sua organização que estão habilitadas para replicação, use o comando SHOW REPLICATION ACCOUNTS.

• Para obter a lista de grupos de failover em sua organização, use SHOW FAILOVER GROUPS.

• Em relação aos metadados:

  Atenção

  Os clientes devem garantir que nenhum dado pessoal (exceto para um objeto do usuário), dados sensíveis, dados controlados por exportação ou outros dados regulamentados sejam inseridos como metadados ao usar o serviço Snowflake. Para obter mais informações, consulte Campos de metadados no Snowflake.

Exemplos¶

ALTER FAILOVER GROUP myfg ADD myorg.myaccount3 TO ALLOWED_ACCOUNTS;

ALTER FAILOVER GROUP myfg SET
  OBJECT_TYPES = USERS, ROLES, WAREHOUSES, RESOURCE MONITORS, DATABASES
  ALLOWED_DATABASES = db1;

ALTER FAILOVER GROUP myfg
  ADD db2, db3 TO ALLOWED_DATABASES;

ALTER FAILOVER GROUP myfg
  MOVE DATABASES db3 TO FAILOVER GROUP myfg2;

ALTER FAILOVER GROUP myfg
  SET ALLOWED_DATABASES = NULL;

ALTER FAILOVER GROUP myfg
  REMOVE databases FROM OBJECT_TYPES;

ALTER FAILOVER GROUP myfg
  SET REPLICATION_SCHEDULE = '15 MINUTE';

ALTER FAILOVER GROUP myfg REFRESH;

ALTER FAILOVER GROUP myfg PRIMARY;

ALTER FAILOVER GROUP myfg SUSPEND;