Instalação do ambiente Snowflake Data Clean Rooms

Antes de começar

  • If the Snowflake Data Clean Room environment is not installed for your account: Follow the installation instructions on this page.

  • If you have received an email invitation to join a clean room: Follow the link to open the clean rooms UI, where you can join and use a clean room. Note that you must provide the email address where you received the invitation.

  • If the SDCR environment is installed for your account, and you want access to it: Ask a clean rooms administrator for access to the API, the UI, or both.

Visão geral

Snowflake Data Clean Rooms (SDCR) can be used in two different environments:

  • The clean rooms UI: A graphical, no-code, browser-based environment that makes it easy to create and run analyses.

  • The clean rooms API: A set of stored procedures you can use to create and manage clean rooms and run analyses.

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

Account, installer, and user requirements

When you install the SDCR environment, you install it for all potential users in the Snowflake account. However, access to the clean room environment must be granted to users explicitly by a clean rooms administrator.

Aqui estão os requisitos para instalar Snowflake Data Clean Rooms em sua conta Snowflake:

Se você não atender a todos esses requisitos e precisar fazer o upgrade, entre em contato com o suporte Snowflake.

Parâmetros de nível de conta não aceitos

Snowflake Data Clean Rooms does not support certain account-level parameter values. The following table shows the required values for these parameters:

Nome do parâmetro

Valor exigido

Notas

DEFAULT_DDL_COLLATION

Nenhum valor aceito, deve ser nulo

Agrupamento no nível da conta não é aceito.

QUOTED_IDENTIFIERS_IGNORE_CASE

false

Para verificar um parâmetro na sua conta, execute o seguinte comando SQL, substituindo o nome do parâmetro por <parameter_name>:

SHOW PARAMETERS LIKE '<parameter_name>' IN ACCOUNT;
Copy

Por exemplo:

SHOW PARAMETERS LIKE 'DEFAULT_DDL_COLLATION' IN ACCOUNT;
Copy

Requisitos da função

Here are the role requirements for the person installing the SDCR environment:

  • You must have an ACCOUNTADMIN role in a Snowflake account in order to install the SDCR environment in that account.

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

Install the SDCR environment

Follow these steps to install a SDCR environment in your Snowflake account.

You must always install the native app (step 1), but after that you can enable the clean rooms API for code usage (step 2), the clean rooms UI for browser usage (step 3), or both. We recommend installing both the UI and the API to support both coders and non-coders in your organization.

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. No menu de navegação, selecione Catalog » Apps » Snowflake Data Clean Rooms » Launch app. Isso abre uma planilha com 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. Complete the UI setup. This step configures a service user [*] that the clean rooms UI uses to communicate with 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.

  • Ative as atualizações automáticas da versão da sala limpa. Ative a atualização automática do ambiente da API das salas limpas sempre que o Snowflake lançar uma nova versão. Você também pode instalar as atualizações manualmente, mas recomendamos ativar as atualizações automáticas.

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

Solution: Ensure that the IP addresses associated with the clean rooms UI are allowed by your network policies. For a list of these IP addresses, see Clean rooms UI hosting locations and IP addresses.

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

Clean rooms alters the authentication controls, network policies, and other attributes of the service user. You will not be able to use this user yourself after you give it to the clean rooms environment.