Configuração do Snowpipe Streaming¶
Propriedades do Snowpipe Streaming¶
Ajuste as configurações de conexão API em um arquivo profile.json
. As propriedades são descritas neste tópico.
Como mostrado no exemplo Java (GitHub), é possível carregar as configurações de profile.json
especificando o caminho do arquivo como a entrada para a variável PROFILE_PATH
.
Propriedades obrigatórias¶
authorization_type
Configure o método de autenticação e autorização para o usuário. Use um dos seguintes métodos:
JWT
: autenticação do par de chaves com JSON Web Token (JWT). Este é o método padrão. Seauthorization_type
não estiver configurado, o método padrãoJWT
será usado. Configure o seguinteprivate_key
para autenticação de par de chaves:Chave privada
private_key
para autenticar o usuário. Inclua apenas a chave, não o cabeçalho ou rodapé. Se a chave estiver dividida em várias linhas, remova as quebras de linha.Você pode fornecer uma chave não criptografada, ou pode fornecer uma chave criptografada e fornecer o parâmetro
snowflake.private.key.passphrase
para permitir que o Snowflake descriptografe a chave. Use este parâmetro se e somente se o valor do parâmetrosnowflake.private.key
estiver criptografado.
OAuth
: Snowflake OAuth. Esta opção só está disponível com Snowflake Ingest SDK versões 2.0.3 e posteriores. Configure os seguintes parâmetros para Snowflake OAuth no arquivoprofile.json
:oauth_client_id
: o ID do cliente da integração OAuth.oauth_client_secret
: o segredo do cliente da integração OAuth.oauth_refresh_token
: um token de atualização válido da integração OAuth.
Para dar suporte à atualização de token no Snowflake/OKTA OAuth, você deve configurar três parâmetros:
oauth_client_id
,oauth_client_secret
eoauth_refresh_token
. No entanto, se você usar um ponto de extremidade de API personalizado para OAuth que não exija esses valores na solicitação de atualização do token, você poderá preencher os campos desses parâmetros com espaços reservados.
url
URL para acessar sua conta Snowflake. Este URL deve incluir seu identificador da conta. Observe que o protocolo (
https://
) e o número da porta são opcionais.Observe que
url
não é necessário se você já estiver usando o Snowflake Ingest SDK e tiver definido as propriedadeshost
,scheme
eport
no arquivoprofile.json
.user
Nome de login do usuário para a conta Snowflake.
Propriedades opcionais¶
snowflake.private.key.passphrase
Frase secreta para descriptografar a chave privada quando a chave é criptografada. Para obter mais informações, consulte Uso da autenticação de par de chaves e rodízio de chaves (neste tópico).
role
Função de controle de acesso a ser usada para a sessão após a conexão ao Snowflake.
Observe que a propriedade
role
é opcional para versões 2.0.3 do Snowflake Ingest SDK e posteriores. É necessário para versões anteriores do Ingest SDK.
Exemplos¶
Para um exemplo simples que mostra como o cliente SDK poderia ser usado para criar um aplicativo Snowpipe Streaming, consulte este arquivo Java (GitHub).
Exemplos de início rápido: