Snowflake Data Clean Rooms: Guia de referência da API do consumidor¶
O conteúdo a seguir detalha todos as APIs de desenvolvedor fornecidas pelas Snowflake Data Clean Rooms para consumidores. Todas as funções residem dentro do seguinte esquema:
samooha_by_snowflake_local_db.consumer
Configuração do ambiente¶
Execute os seguintes comandos para configurar o ambiente Snowflake antes de usar as APIs de desenvolvedor para trabalhar com uma Snowflake Data Clean Room. Se você não tiver a função SAMOOHA_APP_ROLE, entre em contato com o administrador de sua conta.
use role samooha_app_role;
use warehouse app_wh;
Atribua um nome para a sala limpa que o provedor compartilhou com você:
set cleanroom_name = 'Test Cleanroom 1';
Instalação da sala limpa¶
Instale a sala limpa que o provedor compartilhou por meio dos seguintes comandos:
consumidor.install_cleanroom¶
Descrição: Instala a sala limpa na conta do consumidor com o provedor associado e a sala limpa selecionada.
Entrada: cleanroom_name (cadeia de caracteres), provider_account_locator (cadeia de caracteres)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.consumer.install_cleanroom($cleanroom_name, '<PROVIDER_ACCOUNT_LOCATOR>');
consumer.is_enabled¶
Descrição: Após a instalação da sala limpa, o provedor leva cerca de 1 minuto para concluir a configuração e habilitá-la. Esta função permite ao usuário verificar o status da sala limpa e ver se ela está habilitada ou não. O sinalizador geralmente muda para Verdadeiro cerca de 1 minuto após a instalação da sala limpa.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: está habilitado (booliano)
Exemplo:
call samooha_by_snowflake_local_db.consumer.is_enabled($cleanroom_name);
consumer.uninstall_cleanroom¶
Descrição: Desinstala a sala limpa na conta do consumidor. Isso remove todos os bancos de dados associados à sala limpa, incluindo o banco de dados da sala limpa compartilhada. Observe que a sala limpa sempre pode ser instalada novamente com consumer.install_cleanroom.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.consumer.uninstall_cleanroom($cleanroom_name);
Configuração da análise de execução do provedor¶
library.is_provider_run_enabled¶
Descrição: Verifica se esta sala limpa tem Provider Run Analysis habilitado. Observação: a aprovação explícita ainda precisa ser dada chamando consumer.enable_templates_for_provider_run (consulte abaixo).
Entrada: cleanroom_name (cadeia de caracteres)
Saída: mensagem habilitada (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.is_provider_run_enabled($cleanroom_name)
biblioteca.is_consumer_run_enabled¶
Descrição: Verifica se esta sala limpa tem Consumer Run Analysis habilitado. Este sinalizador determina se o consumidor da sala limpa (instalador) pode executar análises ou atuar como um colaborador de dados.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: mensagem habilitada (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.is_consumer_run_enabled($cleanroom_name)
consumer.enable_templates_for_provider_run¶
Descrição: Se uma sala limpa tiver Provider Run Analysis habilitado (ou seja, o provedor da sala limpa marcou a sala limpa para permitir que os provedores executem a análise), este procedimento deve ser chamado pelo consumidor para habilitá-lo. Este procedimento é necessário para conceder aprovação explícita, modelo por modelo, aos provedores que desejam executar análises.
O parâmetro booliano final permite que o consumidor habilite a privacidade diferencial para as análises do provedor, se definido como TRUE.
Entrada: cleanroom_name (cadeia de caracteres), template_names (matriz), enable_differential_privacy (booliano)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.consumer.enable_templates_for_provider_run($cleanroom_name, ['prod_overlap_analysis'], FALSE);
Registro e cancelamento de registro de dados¶
Use o comando a seguir para registrar e cancelar o registro de bancos de dados, esquemas e objetos. Tabelas e exibições devem ser registradas antes de poderem ser vinculadas à sala limpa. Se você registrar um banco de dados ou esquema, todos os objetos naquele banco de dados ou esquema serão registrados.
consumer.register_db¶
Descrição: Ao adicionar um banco de dados à sala limpa, você pode vincular qualquer conjunto de dados do banco de dados. Se não for chamado, as concessões terão que ser feitas para samooha_app_role individualmente.
Entrada: db_name (cadeia de caracteres)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.consumer.register_db('SAMOOHA_SAMPLE_DATABASE');
library.register_schema¶
Descrição: semelhante a register_db
, mas opera em nível de esquema. Uma matriz ou cadeia de caracteres representando o nome do esquema totalmente qualificado pode ser passado, e seleções de concessão para a função SAMOOHA_APP_ROLE são feitas, permitindo que o usuário vincule os objetos no esquema à sala limpa.
Se você quiser registrar um esquema de acesso gerenciado (ou seja, um esquema criado com o parâmetro WITH MANAGED ACCESS), use library.register_managed_access_schema
.
Entrada: schema_name (array)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.register_schema(['SAMOOHA_SAMPLE_DATABASE.DEMO']);
library.register_managed_access_schema¶
Descrição: semelhante a register_schema
, mas registra um esquema que foi criado com o parâmetro WITH MANAGED ACCESS. Uma matriz ou cadeia de caracteres representando o nome do esquema totalmente qualificado pode ser passado, e seleções de concessão para a função SAMOOHA_APP_ROLE são feitas, permitindo que o usuário vincule os objetos no esquema à sala limpa.
Entrada: schema_name (array)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.register_managed_access_schema(['SAMOOHA_SAMPLE_DATABASE.DEMO']);
library.register_table_or_view¶
Descrição: registra tabelas e exibições de todos os tipos.
Entrada: object_names (array), is_view (boolean), is_iceberg (boolean), is_external (boolean), is_under_managed_access_schema (boolean)
Saída mensagem de sucesso (string)
Exemplos
Para registrar uma tabela:
call samooha_by_snowflake_local_db.library.register_table_or_view(
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],
false,
false,
false,
false);
Para registrar uma tabela Iceberg:
call samooha_by_snowflake_local_db.library.register_table_or_view(
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],
false,
true,
false,
false);
library.register_table¶
Descrição: Semelhante a register_db
, mas opera ao nível de tabela. Uma matriz ou cadeia de caracteres representando o nome da tabela totalmente qualificado pode ser passada, e serão concedidos privilégios de seleção à função SAMOOHA_APP_ROLE são criadas, permitindo que o usuário vincule a tabela à sala limpa.
Se você quiser registrar tabelas em um esquema de acesso gerenciado (ou seja, um esquema criado com o parâmetro WITH MANAGED ACCESS), use library.register_managed_access_table
.
Entrada: table_name (matriz)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.register_table(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.register_managed_access_table¶
Descrição: semelhante a register_table
, mas registra tabelas que foram criadas com o parâmetro WITH MANAGED ACCESS. Uma matriz ou cadeia de caracteres representando o nome da tabela totalmente qualificado pode ser passada, e serão concedidos privilégios de seleção à função SAMOOHA_APP_ROLE são criadas, permitindo que o usuário vincule a tabela à sala limpa.
Entrada: table_name (matriz)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.register_managed_access_table(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.register_view¶
Descrição: semelhante a register_db
, mas opera em nível de exibição. Uma matriz ou cadeia de caracteres representando o nome da exibição totalmente qualificado pode ser passada, e seleções de concessão para a função SAMOOHA_APP_ROLE são feitas, permitindo que o usuário link a exibição à sala limpa.
Se você quiser registrar exibições em um esquema de acesso gerenciado (ou seja, um esquema criado com o parâmetro WITH MANAGED ACCESS), use library.register_managed_access_view
.
Entrada: view_name (array)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.register_view(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.register_managed_access_view¶
Descrição: semelhante a register_view
, mas registra exibições que foram criadas com o parâmetro WITH MANAGED ACCESS. Uma matriz ou cadeia de caracteres representando o nome da exibição totalmente qualificado pode ser passada, e seleções de concessão para a função SAMOOHA_APP_ROLE são feitas, permitindo que o usuário link a exibição à sala limpa.
Entrada: view_name (array)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.register_managed_access_view(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.unregister_db¶
Descrição: Inverte o procedimento register_db
e remove as concessões ao nível de banco de dados concedidas à função SAMOOHA_APP_ROLE e ao aplicativo nativo de Snowflake Data Clean Room. Isso também remove qualquer banco de dados do menu suspenso de UI.
Entrada: db_name (cadeia de caracteres)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.unregister_db('SAMOOHA_SAMPLE_DATABASE');
library.unregister_schema¶
Descrição: cancela o registro de um esquema, o que impede que os usuários vinculem suas tabelas e exibições à sala limpa.
Se você quiser cancelar o registro de um esquema de acesso gerenciado (ou seja, um esquema criado com o parâmetro WITH MANAGED ACCESS), use library.unregister_managed_access_schema
.
Entrada: schema_name (array)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.unregister_schema(['SAMOOHA_SAMPLE_DATABASE.DEMO']);
library.unregister_managed_access_schema¶
Descrição: semelhante a unregister_schema
, mas cancela o registro em um esquema que foi criado com o parâmetro WITH MANAGED ACCESS.
Entrada: schema_name (array)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.unregister_managed_access_schema(['SAMOOHA_SAMPLE_DATABASE.DEMO']);
library.unregister_table_or_view¶
Descrição: cancela o registro de tabelas e exibições de todos os tipos.
Entrada: object_names (array), is_view (boolean), is_iceberg (boolean), is_external (boolean), is_under_managed_access_schema (boolean)
Saída mensagem de sucesso (string)
Exemplos
Para cancelar o registro de uma tabela:
call samooha_by_snowflake_local_db.library.unregister_table_or_view(
['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS'],
false,
false,
false,
false);
library.unregister_table¶
Descrição: semelhante a unregister_db
, mas opera em nível de tabela. Uma matriz ou cadeia de caracteres representando o nome da tabela totalmente qualificado pode ser passada para cancelar o registro das tabelas. Os usuários não podem vincular tabelas não registradas a uma sala limpa.
Se você quiser cancelar o registro de tabelas em um esquema de acesso gerenciado (ou seja, um esquema criado com o parâmetro WITH MANAGED ACCESS), use library.unregister_managed_access_table
.
Entrada: table_name (matriz)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.unregister_table(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.unregister_managed_access_table¶
Descrição: semelhante a unregister_table
, mas cancela o registro de tabelas em um esquema de acesso gerenciado (ou seja, um esquema criado com o parâmetro WITH MANAGED ACCESS).
Entrada: table_name (matriz)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.unregister_managed_access_table(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.unregister_view¶
Descrição: semelhante a unregister_db
, mas opera em nível de exibição. Uma matriz ou cadeia de caracteres representando o nome de exibição totalmente qualificado pode ser passada para cancelar o registro das exibições. Os usuários não podem vincular exibições não registradas a uma sala limpa.
Se você quiser cancelar o registro de exibições em um esquema de acesso gerenciado (ou seja, um esquema criado com o parâmetro WITH MANAGED ACCESS), use library.unregister_managed_access_view
.
Entrada: view_name (array)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.unregister_view(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
library.unregister_managed_access_view¶
Descrição: semelhante a unregister_view
, mas cancela o registro de exibições em um esquema de acesso gerenciado (ou seja, um esquema criado com o parâmetro WITH MANAGED ACCESS).
Entrada: view_name (array)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.library.unregister_managed_access_view(['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
Como adicionar conjuntos de dados¶
consumer.link_datasets¶
Descrição: Um usuário pode vincular uma tabela Snowflake à sala limpa e compartilhá-la criando uma exibição segura da tabela a partir da sala limpa.
Entrada: cleanroom_name (cadeia de caracteres), tables_list (matriz)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.consumer.link_datasets($cleanroom_name, ['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS']);
Definição de políticas de segurança para Provider Run Analysis¶
consumer.set_join_policy¶
Descrição: Especifica em quais colunas o provedor tem permissão para executar uma junção ao executar modelos na sala limpa, quando estiver usando Provider Run Analysis. Observe que a política de coluna é somente substituição, portanto, se a função for chamada novamente, a política de coluna definida anteriormente será completamente substituída pela atual.
Observe que as verificações são realizadas analisando a consulta SQL a ser executada nos dados para quaisquer colunas não autorizadas. Consultas com curingas podem não ser detectadas usando essas verificações, e ainda assim é preciso ter cautela ao projetar o modelo de análise.
Entrada: cleanroom_name (cadeia de caracteres), table_and_col_names (matriz)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.consumer.set_join_policy($cleanroom_name, ['SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:EMAIL', 'SAMOOHA_SAMPLE_DATABASE.DEMO.EXPOSURES:EMAIL']);
consumer.set_column_policy¶
Descrição: Define em quais colunas de dados o provedor pode realizar operações. Isso só deve ser chamado depois que o modelo for adicionado. Esta também é uma função de modelo, portanto as entradas precisam estar no formato template_name:full_table_name:column_name. Observe que a política de coluna é somente substituição, portanto, se a função for recuperada, a política de coluna definida anteriormente será completamente substituída pela atual.
A política de coluna não deve ser chamada em colunas de identidade como e-mail. Ela deve ser usada somente em colunas agregadas e agrupadas.
Observe que as verificações são realizadas analisando a consulta SQL a ser executada nos dados para quaisquer colunas não autorizadas. Consultas com curingas podem não ser detectadas usando essas verificações, e ainda assim é preciso ter cautela ao projetar o modelo de análise.
As verificações são realizadas em argumentos SQL Jinja chamados dimensions ou measure_columns. Certifique-se de usar essas tags para habilitar essa verificação.
Entrada: cleanroom_name (cadeia de caracteres), analysis_and_table_and_columns (matriz)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.consumer.set_column_policy($cleanroom_name,
['prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:STATUS',
'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:AGE_BAND',
'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.CUSTOMERS:DAYS_ACTIVE',
'prod_overlap_analysis:SAMOOHA_SAMPLE_DATABASE.DEMO.EXPOSURES:CAMPAIGN']);
Modelos¶
Os comandos a seguir permitem que os usuários trabalhem com modelos disponíveis na sala limpa.
consumer.view_template_definition¶
Descrição: As definições do modelo de sala limpa estão disponíveis para ajudar a determinar quais parâmetros precisam ser passados ao modelo.
Nota
Observe que todos os procedimentos do Samooha são criptografados e não podem ser visualizados por padrão. No entanto, todos os modelos personalizados que você adicionar ficarão visíveis para você.
Entrada: cleanroom_name (cadeia de caracteres), template_name (cadeia de caracteres)
Saída: A definição do modelo (cadeia de caracteres)
Exemplo:
call samooha_by_snowflake_local_db.consumer.view_template_definition($cleanroom_name, 'prod_overlap_analysis');
consumer.get_arguments_from_template¶
Descrição: Define como os dados devem ser organizados e quais dados são necessários para cada modelo para garantir que a saída seja facilmente digerível.
Entrada: cleanroom_name (cadeia de caracteres), template_name (cadeia de caracteres)
Saída: Lista de argumentos e especificações (tabela)
Exemplo:
call samooha_by_snowflake_local_db.consumer.get_arguments_from_template($cleanroom_name, 'prod_overlap_analysis');
Encadeamentos de modelos¶
Os comandos a seguir permitem que os usuários trabalhem com cadeias de modelos disponíveis na sala limpa. Para obter informações gerais sobre o uso de cadeias de modelos, consulte Como usar APIs do desenvolvedor para executar modelos sequencialmente.
consumer.view_added_template_chains¶
Descrição: exibe as cadeias de modelos atualmente ativas na sala limpa.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: as cadeias de modelos adicionadas (tabela)
Exemplo:
call samooha_by_snowflake_local_db.consumer.view_added_template_chains($cleanroom_name);
consumer.view_template_chain_definition¶
Descrição: retorna os atributos de uma cadeia de modelos.
Entrada: cleanroom_name (string), template_chain_name (string)
Saída: a definição da cadeia de modelos (string)
Exemplo:
call samooha_by_snowflake_local_db.consumer.view_template_chain_definition($cleanroom_name, 'insights_chain');
consumer.get_arguments_from_template_chain¶
Descrição: retorna os argumentos esperados para todos os modelos na cadeia de modelos.
Entrada: cleanroom_name (string), template__chain_name (string)
Saída: Lista de argumentos e especificações (tabela)
Exemplo:
call samooha_by_snowflake_local_db.consumer.get_arguments_from_template_chain($cleanroom_name, 'insights_chain');
Execução de análises e ativações¶
Os comandos a seguir executam uma análise ou ativação específica com base no modelo especificado.
consumer.run_analysis¶
Descrição: executa uma análise usando um modelo ou cadeia de modelos. As tabelas de consumidores e provedores precisam ser especificadas separadamente e certas entradas podem ficar vazias se não forem necessárias. O modelo ou cadeia de modelos executa a lógica que foi configurada para a análise específica e retorna os dados unidos como uma tabela. A única entrada opcional é “epsilon”, ou seja, quanto do orçamento de privacidade diferencial a consulta precisa consumir. O valor padrão é 0,1, se ele não for especificado.
Entrada: cleanroom_name (string), {template_name | template_chain_name} (string), consumer_tables (array), provider_tables (array), analysis_arguments (object)
Saída: Saída de cálculos de modelo (tabela)
Exemplo:
call samooha_by_snowflake_local_db.consumer.run_analysis(
$cleanroom_name, -- cleanroom
'prod_overlap_analysis', -- template name
['SAMOOHA_SAMPLE_DATABASE.MYDATA.CONVERSIONS'], -- Consumer tables
['SAMOOHA_SAMPLE_DATABASE.DEMO.EXPOSURES'], -- Provider tables
object_construct( -- Rest of the custom arguments needed for the template
'dimensions', ['p.CAMPAIGN'], -- always use p. to refer to fields in provider tables, and c. to refer to fields in consumer tables. Use p2, p3, etc. for more than one provider table and c2, c3, etc. for more than one consumer table.
'measure_column', ['p.EXP_COST'],
'measure_type', ['COUNT'],
'where_clause', 'p.EMAIL=c.EMAIL'
)
);
consumer.run_activation¶
Descrição: executa um modelo que envia os resultados de volta ao provedor para ativação.
Para obter mais informações sobre como ativar os resultados de volta para o provedor, consulte Como usar APIs do desenvolvedor para ativar os resultados para o provedor.
Entrada: cleanroom_name (string), segment_name (string), template_name (string), consumer_tables (array), provider_tables (array), activation_arguments (object)
Saída: mensagem de sucesso
Exemplo:
call samooha_by_snowflake_local_db.consumer.run_activation(
$cleanroom_name,
'my_activation_segment',
'activation_custom_template',
['consumer_source_table'],
['provider_source_table'],
object_construct( -- Custom arguments needed for the template
'dimensions', ['p.CAMPAIGN'], -- always use p. to refer to fields in provider tables, and c. to refer to fields in consumer tables. Use p2, p3, etc. for more than one provider table and c2, c3, etc. for more than one consumer table.
'where_clause', 'p.EMAIL=c.EMAIL'
));
Modelos definidos pelo consumidor¶
As seguintes APIs permitem que você adicione modelos definidos pelo consumidor a uma sala limpa. Para obter mais informações, consulte Como usar a API do desenvolvedor para adicionar modelos definidos pelo consumidor.
consumer.create_template_request¶
Descrição: envia uma solicitação ao provedor de uma sala limpa solicitando que ele aprove um modelo personalizado para que ele possa ser adicionado à sala limpa.
Entrada: cleanroom_name (string), template_name (string), template_definition (string)
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
CALL samooha_by_snowflake_local_db.consumer.create_template_request('dcr_cleanroom',
'my_analysis',
$$
SELECT
identifier({{ dimensions[0] | column_policy }})
FROM
identifier({{ my_table[0] }}) c
INNER JOIN
identifier({{ source_table[0] }}) p
ON
c.identifier({{ consumer_id }}) = identifier({{ provider_id | join_policy }})
{% if where_clause %} where {{ where_clause | sqlsafe | join_and_column_policy }} {% endif %};
$$);
consumer.list_template_requests¶
Descrição: lista as solicitações que o consumidor fez para adicionar um modelo a uma sala limpa.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: request_id(string), provider_identifier(string), template_name(string), template_definition(string), request_status(string), reason(string)
Exemplo:
CALL samooha_by_snowflake_local_db.consumer.list_template_requests('dcr_cleanroom');
Métodos de obtenção de metadados de sala limpa¶
Os métodos a seguir mostram as propriedades relevantes da sala limpa:
consumer.describe_cleanroom¶
Descrição: Cria um resumo de texto com todas as informações sobre o que foi adicionado à sala limpa, incluindo modelos, conjuntos de dados, políticas etc.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: Cadeia de caracteres de descrição extensa da sala limpa (tabela)
Exemplo:
call samooha_by_snowflake_local_db.consumer.describe_cleanroom($cleanroom_name);
consumer.view_provider_datasets¶
Descrição: Exibe todos os conjuntos de dados adicionados à sala limpa pelo provedor.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: Todos os nomes de conjuntos de dados do provedor na sala limpa (tabela)
Exemplo:
call samooha_by_snowflake_local_db.consumer.view_provider_datasets($cleanroom_name);
consumer.view_join_policy¶
Descrição: Descreve quais colunas os usuários podem unir com segurança em uma sala limpa, definidas pelo consumidor nos conjuntos de dados do consumidor.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: A política de junção (tabela)
Exemplo:
call samooha_by_snowflake_local_db.consumer.view_join_policy($cleanroom_name);
consumer.view_provider_join_policy¶
Descrição: Descreve quais colunas os usuários podem unir com segurança em uma sala limpa, definidas pelo provedor nos conjuntos de dados do provedor.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: A política de junção (tabela)
Exemplo:
call samooha_by_snowflake_local_db.consumer.view_provider_join_policy($cleanroom_name);
consumer.view_added_templates¶
Descrição: Exibe todos os modelos ativos na sala limpa.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: Os modelos adicionados (tabela)
Exemplo:
call samooha_by_snowflake_local_db.consumer.view_added_templates($cleanroom_name);
consumer.view_column_policy¶
Descrição: Exibe todas as políticas de coluna aplicadas à sala limpa pelo consumidor.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: A política de coluna (tabela)
Exemplo:
call samooha_by_snowflake_local_db.consumer.view_column_policy($cleanroom_name);
consumer.view_provider_column_policy¶
Descrição: Exibe todas as políticas de coluna aplicadas à sala limpa pelo provedor.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: A política de coluna (tabela)
Exemplo:
call samooha_by_snowflake_local_db.consumer.view_provider_column_policy($cleanroom_name);
consumer.view_cleanrooms¶
Descrição: Exibe todas as salas limpas criadas recentemente, classificadas pela data em que foram criadas.
Entrada:
Saída: Todas as salas limpas existentes ordenadas pela data de criação (tabela)
Exemplo:
call samooha_by_snowflake_local_db.consumer.view_cleanrooms();
consumer.is_dp_enabled¶
Descrição: Verifica se a privacidade diferencial foi habilitada na sala limpa.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: Se a sala limpa tem DP habilitado (booliano)
Exemplo:
call samooha_by_snowflake_local_db.consumer.is_dp_enabled($cleanroom_name);
consumer.view_remaining_privacy_budget¶
Descrição: Exibe o orçamento de privacidade restante que pode ser usado para fazer consultas na sala limpa. Uma vez esgotadas, outras chamadas para run_analysis não serão permitidas até que o orçamento seja redefinido. O orçamento é redefinido diariamente.
Quando a privacidade diferencial não está habilitada, o orçamento de privacidade é definido em um nível arbitrariamente alto (por exemplo, 10.000) e não se esgota.
Entrada: cleanroom_name (cadeia de caracteres)
Saída: O orçamento de privacidade restante (float)
Exemplo:
call samooha_by_snowflake_local_db.consumer.view_remaining_privacy_budget($cleanroom_name);
Métodos auxiliares gerais¶
Use os métodos a seguir para ajudar a aproveitar ao máximo a funcionalidade da sala limpa.
library.enable_local_db_auto_upgrades¶
Descrição: habilita a tarefa, samooha_by_snowflake_local_db.admin.expected_version_task
, que atualiza automaticamente o Snowflake Native App para Snowflake Data Clean Rooms conforme novas versões são lançadas.
Entrada: nenhuma
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
CALL samooha_by_snowflake_local_db.library.enable_local_db_auto_upgrades();
library.disable_local_db_auto_upgrades¶
Descrição: desabilita a tarefa, samooha_by_snowflake_local_db.admin.expected_version_task
, que atualiza automaticamente o Snowflake Native App para Snowflake Data Clean Rooms conforme novas versões são lançadas.
Entrada: nenhuma
Saída: mensagem de sucesso (cadeia de caracteres)
Exemplo:
CALL samooha_by_snowflake_local_db.library.disable_local_db_auto_upgrades();