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 ingressar em uma sala limpa: Siga o link, insira seu e-mail e uma nova senha, se direcionado. Depois disso, a UI de salas limpas será aberta, e você poderá ingressar e usar uma sala limpa. Observe que você deve fornecer o mesmo endereço de e-mail pelo qual recebeu o convite. A senha será específica para sua conta de salas limpas. Não recomendamos reutilizar sua senha 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 API de salas limpas: acesso a um conjunto de procedimentos armazenados usados para criar e gerenciar salas limpas 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.

  • Não há suporte para contas de leitor, porque elas não permitem o compartilhamento de dados necessário para instalar e executar o aplicativo de salas limpas.

  • 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ê sempre deve instalar o app nativo (etapa 1); mas, depois disso, poderá habilitar a UI de salas limpas para uso do navegador, a API de salas limpas para uso do código ou ambas. Recomendamos instalar tanto a UI quanto a API para oferecer suporte a codificadores e não codificadores em sua organização.

1. Instale o aplicativo nativo

Instale o aplicativo nativo do marketplace:

  1. Defina sua função atual como ACCOUNTADMIN

  2. Instale o aplicativo Snowflake Data Clean Rooms do Snowflake Marketplace

  3. Selecione Get e aceite as opções padrão.

A instalação leva alguns minutos.

2. Instale a API de salas limpas

A API de salas limpas é usada para criação e uso programáticos de salas limpas.

Estas são as etapas para instalar a API de salas limpas em sua conta Snowflake:

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

  2. Execute os comandos SQL para instalar a API de salas limpas, 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.

  3. 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();
    
    Copy

    Se isso retornar FALSE, consulte a seção de solução de problemas abaixo.

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

  5. (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 salas limpas oferece um ambiente fácil e sem código para gerenciar sua conta de salas limpas, criar salas limpas e executar análises. Ela também oferece algumas funcionalidades adicionais não disponível na API de salas limpas, como consultas agendadas, ativação de terceiro e modelos predefinidos úteis.

Veja como habilitar a UI de clean rooms em sua conta Snowflake:

  1. 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.)

  2. Preencha a configuração da UI. Essa etapa configura um usuário de serviço [*] que a UI de salas limpas usa para se comunicar com o Snowflake.

    1. Faça login na UI de clean rooms com suas credenciais Snowflake.

    2. Abra Admin » Snowflake Admin » Connect to Snowflake account.

    3. Em Enable the Data Clean Rooms UI, escolha Quick Setup ou Manual Setup:

      • Quick Setup: cria um usuário de serviço para você. Especifique um nome de usuário de serviço exclusivo para esta conta.

      • Manual Setup: se você mesmo quer criar o usuário de serviço ou reutilizar um existente, selecione essa opção. Observe que as salas limpas assumem o controle do usuário de serviço e o modificam, portanto, certifique-se de que o usuário de serviço não seja usado para mais nada. Saiba mais como criar um usuário de serviço.

    4. Insira seu nome de usuário de serviço exclusivo e selecione Finish.

  3. Configure seu ambiente de salas limpas conforme descrito na próxima seção.

Configuração do ambiente de salas limpas

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 da UI de salas limpas. Os administradores gerenciam o ambiente no dia a dia e podem realizar muitas ações, como gerenciar colaboradores e configurar conectores de terceiro. Os usuários podem criar ou ingressar em salas limpas 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 salas limpas somente pode importar os dados que foram pré-registrados por um administrador da UI de salas limpas para a sala limpa dele.

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 à UI de salas limpas sejam permitidos em 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 a UI de salas limpas não está funcionando adequadamente.

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:

    1. Login na UI de salas limpas.

    2. No painel de navegação esquerdo, selecione Snowflake Admin.

    3. Selecione Login to Snowflake, e autentique como um usuário Snowflake com a função ACCOUNTADMIN.

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

    5. Para instalar o Snowflake Native App, selecione Install.

    6. Aceite o nome padrão do aplicativo durante o processo de instalação.

Criação manual de um usuário de serviço da UI

Ao instalar a UI de salas limpas, é possível deixar a instalação criar o usuário de serviço para você ou fornecer um usuário de serviço que você cria. Veja como criar um usuário de serviço na Snowsight:

Faça login na Snowsight com suas credenciais de administrador Snowflake e crie um usuário, conforme mostrado no seguinte exemplo SQL:

-- Create the user.
-- Clean rooms will set the type to SERVICE for you.

USE ROLE USERADMIN;
CREATE USER <SERVICE-USER-USERNAME>;
Copy

Importante

As salas limpas alteram os controles de autenticação, as políticas de rede e outros atributos desse usuário. Você não poderá usar esse usuário por conta própria depois de fornecê-lo ao ambiente de salas limpas.