Instalação do ambiente Snowflake Data Clean Rooms¶
Antes de começar¶
Um ambiente de Clean Room é instalado na conta Snowflake para todos os usuários dessa conta.
Os usuários de uma conta recebem acesso ao ambiente de Clean Room por um administrador de clean rooms.
Se o ambiente de Clean Room não estiver instalado em sua conta: siga as instruções de instalação nesta página.
Se você recebeu um convite por e-mail para participar de uma clean room: siga o link e forneça seu e-mail e uma nova senha, se solicitado. Isso abrirá o aplicativo da Web de clean rooms, no qual você pode entrar e usar uma clean room. Observe que você deve fornecer o endereço de e-mail em que recebeu o convite. A senha será específica para sua conta de clean rooms; recomendamos não reutilizar a senha do Snowflake.
Se o ambiente de Clean Room estiver instalado em sua conta e você quiser acessá-lo: solicite a um administrador de clean rooms acesso à API, à UI ou a ambas.
Visão geral¶
As Snowflake Data Clean Rooms são compostas por dois ambientes:
A UI de clean rooms: um ambiente sem código, baseado em navegador, que facilita aos usuários a criação ou execução de análises.
A Clean Room API: acesso a um conjunto de procedimentos armazenados usados para criar e gerenciar clean rooms e executar análises.
Esses ambientes oferecem recursos semelhantes, mas não exatamente equivalentes. Um administrador de clean rooms instala um ou ambos os componentes em uma conta Snowflake e pode conceder aos usuários acesso a cada ambiente individualmente.
Requisitos para instalar Snowflake Data Clean Rooms¶
Requisitos de conta e usuário¶
Aqui estão os requisitos para instalar Snowflake Data Clean Rooms em sua conta Snowflake:
A conta deve ter a edição do Snowflake exigida:
Para criar clean rooms, você deve ter a Enterprise Edition ou superior.
Para participar e usar uma clean room criada em outra conta, você deve ter a Standard Edition ou superior.
A conta deve permitir a autenticação por par de chaves, que é usada pela conta de serviço para autenticação.
Você deve aceitar os termos de compartilhamento de dados. Caso você não tenha aceitado os Termos de funcionalidade de compartilhamento de dados controlados pelo cliente da Snowflake, entre em contato com o suporte Snowflake. As Snowflake Data Clean Rooms alavancam as listagens, que fazem parte do serviço Snowflake e estão sujeitas aos seus termos de serviço com a Snowflake, incluindo os Termos da funcionalidade de compartilhamento de dados controlados pelo cliente da Snowflake e a Política de uso aceitável da Snowflake.
Você não deve definir um :doc:`agrupamento </sql-reference/collation>` padrão em nível de conta. Você pode verificar o estado do agrupamento executando o seguinte comando:
SHOW PARAMETERS LIKE 'DEFAULT_DDL_COLLATION' IN ACCOUNT;
(UI de clean rooms somente) A conta Snowflake deve ser uma conta de capacidade: é uma conta que tem um compromisso de capacidade inicial. As contas Snowflake sob demanda não podem acessar a UI de clean rooms.
(UI de clean rooms somente) Você deve usar a autenticação multifator (MFA) com um aplicativo autenticador compatível.
Se você não atender a todos esses requisitos e precisar fazer o upgrade, entre em contato com o suporte Snowflake.
Requisitos do instalador¶
Aqui estão os requisitos para a pessoa que instala o ambiente de Clean Room:
Você deve ter uma função ACCOUNTADMIN em uma conta Snowflake para instalar o ambiente de Clean Room nessa conta.
O usuário com a função ACCOUNTADMIN deve ter um nome, sobrenome e e-mail válidos definidos para seu objeto de usuário. Para verificar, execute DESCRIBE USER.
Instale o ambiente Clean Room.¶
Siga estas etapas para instalar um ambiente de Clean Room em sua conta Snowflake.
Você deve sempre instalar o aplicativo nativo (etapa 1), mas depois disso pode ativar a UI de clean rooms para uso de navegador, a API de Clean Room para uso de código ou ambas. Recomendamos instalar a UI e a API para oferecer suporte a codificadores e não codificadores em sua organização.
1. Instale o aplicativo nativo¶
Instale o aplicativo nativo em código ou a partir do marketplace:
- Se você não quiser concordar com os termos do provedor do marketplace e do consumidor:
Execute o seguinte código em sua conta Snowflake:
USE ROLE ACCOUNTADMIN; CALL system$accept_legal_terms('DATA_EXCHANGE_LISTING', 'GZSTZTP0KKO'); CREATE APPLICATION SAMOOHA_BY_SNOWFLAKE FROM LISTING 'GZSTZTP0KKO';
- Se você concordar com os termos do provedor do marketplace e do consumidor:
Defina sua função atual como ACCOUNTADMIN
Instale o aplicativo Snowflake Data Clean Rooms do Snowflake Marketplace
Selecione Get e aceite as opções padrão.
A instalação leva alguns minutos.
2. Instale a API de Clean Room¶
O API de Clean Room é usada para a criação programática e o uso de clean rooms.
Veja a seguir as etapas para instalar a API de Clean Room em sua conta Snowflake:
Após instalar o aplicativo nativo, inicie-o no Snowflake: Data products » Apps » Snowflake Data Clean Rooms » Launch app. Isso abre uma planilha com os comandos SQL.
Execute os comandos SQL para instalar a API de Clean Room, com as seguintes observações:
Se você renomeou o aplicativo nativo durante a instalação, será necessário modificar o script conforme indicado nos comentários do script.
Se quiser revisar o script de instalação completo antes de executá-lo, descomente a linha do script
DRY_RUN=TRUE
e execute todos os comandos até essa linha, inclusive, para ver o conteúdo do script. Observe que você não deve executar manualmente o script de instalação exposto por esse comando, pois isso pode resultar em uma instalação incompleta.Observe que a instalação leva alguns minutos.
Confirme que você pode acessar a API:
USE ROLE samooha_app_role; USE WAREHOUSE app_wh; CALL SAMOOHA_BY_SNOWFLAKE_LOCAL_DB.LIBRARY.CHECK_MOUNT_STATUS();
Se isso retornar FALSE, consulte a seção de solução de problemas abaixo.
Conceda acesso à API a outros usuários de sua conta Snowflake:
Para adicionar usuários com capacidades completas para criar e gerenciar clean rooms, execute
GRANT ROLE SAMOOHA_APP_ROLE to USER USER
Para adicionar usuários com permissões apenas de execução pelo consumidor, crie uma ou mais funções do Snowflake e conceda aos usuários acesso a essa função. Em seguida, conceda acesso de execução a clean rooms específicas chamando
consumer.grant_run_on_cleanrooms_to_role
.
(Opcional) Instale a UI de clean rooms para permitir o acesso sem código às suas clean rooms ou a outros recursos, como consultas agendadas.
3. Habilite a UI de clean rooms¶
A UI de clean rooms oferece um ambiente fácil e sem código para gerenciar sua conta de clean rooms, criar clean rooms e executar análises. Ele também oferece algumas funcionalidades adicionais não disponíveis na Clean Room API, como consultas programadas, ativação de terceiros e modelos predefinidos úteis.
Veja como habilitar a UI de clean rooms em sua conta Snowflake:
Configure suas políticas de rede para permitir que a UI de clean rooms acesse sua conta Snowflake. (Necessário somente se sua conta Snowflake usar uma política de redes para controlar o tráfego de rede.)
Crie um usuário de serviço. Esse usuário de serviço é usado pela UI de clean rooms para se comunicar com o Snowflake.
Faça login no Snowsight com suas credenciais de administrador do Snowflake e crie um usuário de serviço conforme mostrado abaixo. Forneça uma senha e um endereço de e-mail que você possa acessar. Recomendamos que você use uma lista de distribuição em vez de um e-mail pessoal.
-- Create the service user account. USE ROLE USERADMIN; CREATE USER <SERVICE-USER-USERNAME> PASSWORD='<SERVICE-USER-PASSWORD>' FIRST_NAME='DCR' LAST_NAME='Service User' EMAIL='<SERVICE-USER-EMAIL-ADDRESS>';
Salve o nome de usuário e a senha do serviço fora do Snowsight, pois você os usará durante o processo de instalação.
Saia do usuário atual no Snowsight e, em seguida, entre novamente na mesma conta Snowflake, mas com as credenciais do usuário do serviço.
Abra o perfil e selecione Resend verification email.
Abra o e-mail de verificação e siga o link para verificar o endereço de e-mail do usuário de serviço. Não é necessário fazer login no Snowsight novamente com as credenciais do usuário do serviço. Você pode ver os detalhes do usuário do serviço na UI de clean rooms na página Admin » Snowflake Admin, em Snowflake.
Conclua a configuração da UI. Esta etapa aplica sua política de redes ao usuário de serviço, migra o usuário de serviço da autenticação por senha para a autenticação por par de chaves e concede SAMOOHA_APP_ROLE ao usuário de serviço. Siga estas etapas para concluir a configuração básica da UI:
Faça login na UI de clean rooms com suas credenciais Snowflake.
Abra Admin » Snowflake Admin » Connect to Snowflake account.
Digite o nome de usuário da sua conta de serviço e selecione Save.
Agora você pode usar a UI de clean rooms.
Configure o ambiente da UI de clean rooms¶
Depois de instalar o aplicativo nativo, a API e a UI, você deve configurar o ambiente e adicionar usuários:
Adicione administradores e usuários à UI de clean room. Os administradores gerenciam o ambiente no dia a dia e podem executar muitas ações, como gerenciar colaboradores e configurar conectores de terceiros. Os usuários podem criar ou participar de clean rooms e executar análises.
Adicionar desenvolvedores. Conceda o acesso à API aos desenvolvedores em sua conta Snowflake para que eles possam criar ou consumir clean rooms em sua conta.
Habilite o preenchimento automático entre nuvens. Por padrão, as clean rooms podem ser compartilhadas apenas com consumidores na mesma região de nuvem subjacente que o criador da clean room. Se quiser permitir que os provedores compartilhem clean rooms com consumidores em uma região de nuvem diferente, você deve ativar o preenchimento automático entre nuvens para sua conta.
Registre os conjuntos de dados disponíveis na UI. Um colaborador que usa a UI de clean room pode importar para sua clean room apenas os dados que foram pré-registrados por um administrador de UI de clean rooms.
Solução de problemas de instalação¶
Use esta seção para solucionar problemas que você possa ter após concluir as etapas deste tópico.
- Sintoma: privilégios insuficientes
Solução: certifique-se de que os endereços IP associados ao aplicativo Web sejam permitidos por suas políticas de rede. Para uma lista desses endereços IP, consulte Configuração de políticas de rede.
- Sintoma: a instalação foi bem-sucedida, mas o aplicativo da web não está funcionando corretamente.
Solução n.º 1: use o comando DESCRIBE USER para verificar novamente se o usuário do Snowflake que você usou para configurar o Snowflake tem um nome, sobrenome e e-mail válidos. Caso o usuário não tenha algum deles, execute o comando ALTER USER para especificá-los.
Solução n.º 2: tente desinstalar o Snowflake Native App para Snowflake Data Clean Rooms e reinstalá-lo.
Para desinstalar o aplicativo, consulte Desinstalação de um Snowflake Native App. Se você instalou o aplicativo com o nome padrão, ele se chama SAMOOHA_BY_SNOWFLAKE.
Para reinstalar o aplicativo:
No painel de navegação esquerdo, selecione Snowflake Admin.
Selecione Login to Snowflake, e autentique como um usuário Snowflake com a função ACCOUNTADMIN.
Use o comando DESCRIBE USER para confirmar se o usuário do Snowflake com a função ACCOUNTADMIN que você acabou de usar para autenticação tem um nome, sobrenome e e-mail válidos. Caso o usuário não tenha algum deles, execute o comando ALTER USER para especificá-los.
Para instalar o Snowflake Native App, selecione Install.
Aceite o nome padrão do aplicativo durante o processo de instalação.