ALTER BACKUP SET

Modifica as propriedades de um conjunto de backups. Esta operação pode ser uma das seguintes opções:

  • Fazer um novo backup que se torne parte do conjunto de backups.

  • Remover um backup antigo do conjunto de backups.

  • Suspender ou retomar os backups agendados e a exclusão de backups agendados especificados pela política de backup.

  • Aplicar uma política de backup a um conjunto de backups que ainda não tem uma política.

  • Adicionar ou remover uma retenção legal de um backup específico dentro do conjunto de backups.

  • Renaming the backup set.

  • Especificar ou remover um comentário do conjunto de backups.

Consulte também:

CREATE BACKUP SET, DROP BACKUP SET, SHOW BACKUP SETS

Sintaxe

ALTER BACKUP SET <name> ADD BACKUP

ALTER BACKUP SET <name> APPLY BACKUP POLICY <policy_name> [ FORCE ]

ALTER BACKUP SET <name> SUSPEND BACKUP [ { CREATION | EXPIRATION } ] POLICY

ALTER BACKUP SET <name> RESUME BACKUP [ { CREATION | EXPIRATION } ] POLICY

ALTER BACKUP SET <name> DELETE BACKUP IDENTIFIER '<backup_id>'

ALTER BACKUP SET <name> MODIFY BACKUP IDENTIFIER '<backup_id>' { ADD | REMOVE } LEGAL HOLD

ALTER BACKUP SET <name> RENAME TO <new_name>

ALTER BACKUP SET <name> SET COMMENT = '<string_literal>'

ALTER BACKUP SET <name> UNSET COMMENT

ALTER BACKUP SET <name> SET TAG <tag_name> = '<tag_value>' [ , <tag_name> = '<tag_value>' ... ]

ALTER BACKUP SET <name> UNSET TAG <tag_name> [ , <tag_name> ... ]
Copy

Parâmetros

name

Especifica o identificador do conjunto de backups.

Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas. Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.

Para obter mais informações, consulte Requisitos para identificadores.

ADD BACKUP

Crie manualmente um backup no conjunto. Se a política de backup não incluir um cronograma para fazer novos backups, é assim que você vai fazer um novo backup da tabela, do esquema ou do banco de dados incluído no conjunto de backups. Também é possível fazer novos backups no conjunto de backups a qualquer momento, mesmo quando os backups acontecem regularmente.

APPLY BACKUP POLICY policy_name [ FORCE ]

Especifica a política de backup que será anexada ao conjunto de backups.

A opção FORCE substitui uma política existente em um conjunto de backups. Você poderá usá-la apenas se a política antiga não tiver um bloqueio de retenção.

Importante

Aplicar uma política de backup com um bloqueio de retenção a um conjunto de backups é uma ação irreversível. Devido às garantias rigorosas necessárias para a conformidade regulatória, depois de inserir um bloqueio de retenção em um conjunto de backups, não será possível revogar o bloqueio. O suporte Snowflake também não pode revogar esse bloqueio de retenção. Planeje com cuidado antes de definir um bloqueio de retenção em um conjunto de backups com um longo período de expiração, para evitar cobranças inesperadas de armazenamento para conjuntos de backups não excluíveis e para os esquemas e bancos de dados que os contêm.

Se uma organização Snowflake for excluída, ela deixará de ser um cliente Snowflake. Nesse caso, o Snowflake exclui todos os backups, incluindo aqueles com bloqueios de retenção. A exclusão de uma organização Snowflake requer o envolvimento do suporte Snowflake. Não é algo que um administrador possa fazer por acidente.

SUSPEND BACKUP [ { CREATION | EXPIRATION } ] POLICY

Suspender uma política de backup no conjunto de backups. Você pode suspender a política de backup inteira ou apenas as operações de criação ou expiração. Quando você especifica SUSPEND BACKUP POLICY sem as palavras-chave CREATION ou EXPIRATION, o Snowflake suspende os aspectos tanto de criação quanto de expiração da política. Para obter mais informações, consulte Suspensão da política de backup em um conjunto de backups.

RESUME BACKUP [ { CREATION | EXPIRATION } ] POLICY

Retomar uma política de backup suspensa no conjunto. Você pode retomar a política de backup inteira ou apenas as operações de criação ou expiração. Quando você especifica RESUME BACKUP POLICY sem as palavras-chave CREATION ou EXPIRATION, o Snowflake retoma os aspectos tanto de criação quanto de expiração da política. Para obter mais informações, consulte Retomada da política de backup em um conjunto de backups.

DELETE BACKUP IDENTIFIER 'backup_id'

Excluir um backup do conjunto de backups definido por ID. O ID do backup é um valor de UUID no formato retornado pela função UUID_STRING. O Snowflake permite excluir apenas o backup mais antigo do conjunto de backups. Para obter mais informações, consulte Exclusão do backup de um conjunto de backups.

MODIFY BACKUP IDENTIFIER 'backup_id' { ADD | REMOVE } LEGAL HOLD

Adiciona ou remove uma retenção legal de um backup especificado dentro do conjunto de backups. Para obter mais informações sobre retenções legais de backups WORM, consulte Retenção legal. Para exemplos de uso desta cláusula, consulte Adicionar e remover retenções legais.

RENAME TO new_name

Specifies a new identifier for the backup set; must be unique for your account.

Para obter mais informações, consulte Requisitos para identificadores.

SET COMMENT = 'string_literal'

Associar um comentário ao conjunto de backups.

TAG tag_name = 'tag_value' [ , tag_name = 'tag_value' , ... ]

Especifica o nome da tag e o valor da cadeia de caracteres dela.

O valor de tag é sempre uma cadeia de caracteres, e o número máximo de caracteres do valor da tag é 256.

Para obter informações sobre como especificar tags em uma instrução, consulte Tag quotas.

UNSET ...

Especifica uma ou mais propriedades e/ou parâmetros a serem removidos da definição do conjunto de backups, o que os redefine aos padrões:

  • property_name

  • param_name

    • COMMENT

    • TAG tag_name [ , tag_name ... ]

Você pode redefinir várias propriedades/parâmetros com uma única instrução ALTER; no entanto, cada propriedade/parâmetro deve ser separado por uma vírgula. Além disso, ao reiniciar uma propriedade/parâmetro, você especifica apenas o nome; não é necessário nenhum valor.

Requisitos de controle de acesso

A função usada para executar essa operação deve ter, no mínimo, os seguintes privilégios:

Privilégio

Descrição

OWNERSHIP

A função usada para modificar um conjunto de backups deve ter o privilégio OWNERSHIP no conjunto de backups.

APPLY BACKUP RETENTION LOCK

Se a política de backups aplicada a um conjunto de backups incluir um bloqueio de retenção, a função usada para aplicar a política deverá ter esse privilégio na conta.

APPLY LEGAL HOLD

Esse privilégio de conta permite adicionar ou remover uma retenção legal de um backup. Esse privilégio só é necessário para as cláusulas ADD LEGAL HOLD e REMOVE LEGAL HOLD. Por padrão, a função ACCOUNTADMIN tem este privilégio.

APPLY

Somente um usuário com esse privilégio na política de backup pode usar o comando ALTER BACKUP SET com a cláusula APPLY BACKUP POLICY para adicionar a política de backup a um conjunto de backups que já existe.

Esses privilégios são exigidos na função primária atualmente ativa, não em uma função secundária.

Para instruções sobre como criar uma função personalizada com um conjunto específico de privilégios, consulte Criação de funções personalizadas.

Para informações gerais sobre concessões de funções e privilégios para executar ações de SQL em objetos protegíveis, consulte Visão geral do controle de acesso.

Notas de uso

  • 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.

Importante

Se a política de backup tiver um bloqueio de retenção aplicado e houver algum backup não expirado no conjunto de backups, você não poderá excluir o conjunto de backups. Nesse caso, você deve aguardar até que todos os backups no conjunto expirem. Esta restrição aplica-se até mesmo a funções privilegiadas como ACCOUNTADMIN, e para suporte Snowflake. Por esse motivo, tenha cuidado ao especificar o bloqueio de retenção e um longo período de expiração em uma política de backup.

Exemplos

Adicionar manualmente um backup ao conjunto t1_backups:

ALTER BACKUP SET t1_backups
  ADD BACKUP;
Copy

Atualizar a política de backup do conjunto t1_backups:

ALTER BACKUP SET t1_backups
  APPLY BACKUP POLICY daily_backup_policy;
Copy

Suspender uma política de backup no conjunto t1_backup:

ALTER BACKUP SET t1_backups
  SUSPEND BACKUP POLICY;
Copy

Retomar uma política de backup no conjunto t1_backups:

ALTER BACKUP SET t1_backups
  RESUME BACKUP POLICY;
Copy

Rename the backup set t1_backups to table1_backups:

ALTER BACKUP SET t1_backups
  RENAME TO table1_backups;
Copy

Para encontrar o identificador do backup que será usado com as cláusulas ADD LEGAL HOLD e REMOVE LEGAL HOLD, normalmente você usa o comando SHOW BACKUPS para listar os backups elegíveis e seus horários de criação. O exemplo a seguir mostra como você pode listar os backups apropriados, adicionar uma retenção legal a um backup específico e, posteriormente, remover essa retenção legal. Substitua o próprio nome da função, o nome do conjunto de backups e o identificador do backup.

USE ROLE my_legal_hold_role; -- use a role that has the APPLY LEGAL HOLD privilege
SHOW BACKUPS IN BACKUP SET my_db_backup_set
  ->> SELECT "created_on", "backup_id" FROM $1 WHERE "is_under_legal_hold" = 'N';
ALTER BACKUP SET my_db_backup_set
  MODIFY BACKUP IDENTIFIER '790d1ee4-88b2-451f-9ccc-eacd1e93a134'
  ADD LEGAL HOLD;

USE ROLE my_legal_hold_role; -- use a role that has the APPLY LEGAL HOLD privilege
SHOW BACKUPS IN BACKUP SET my_db_backup_set
  ->> SELECT "created_on", "backup_id" FROM $1 WHERE "is_under_legal_hold" = 'Y';
ALTER BACKUP SET my_db_backup_set
  MODIFY BACKUP IDENTIFIER '790d1ee4-88b2-451f-9ccc-eacd1e93a134'
  REMOVE LEGAL HOLD;
Copy