Conexão por meio do SnowSQL

Este tópico descreve como se conectar ao Snowflake inserindo manualmente os parâmetros de conexão. O tópico também explica como configurar uma conexão padrão para facilidade de uso, assim como uma ou mais conexões nomeadas para usar configurações de conexão alternativas ou criar várias sessões simultâneas.

Nota

Snowflake não oferece suporte à execução de várias instâncias de SnowSQL simultaneamente na mesma máquina. Por exemplo, você não pode abrir dois terminais MacOS ou aplicativos shell do Linux e executar snowsql em ambos ao mesmo tempo.

Neste tópico:

Sintaxe de conexão

$ snowsql <connection_parameters>
Copy

Onde <parâmetros_de_conexão> são um ou mais dos seguintes. Para descrições detalhadas de cada parâmetro, consulte Referência de parâmetros de conexão (neste tópico).

Parâmetro

Descrição

-a, --accountname TEXT

O identificador de sua conta. Honra $SNOWSQL_ACCOUNT.

-u, --username TEXT

Nome de usuário para se conectar ao Snowflake. Honra $SNOWSQL_USER.

-d, --dbname TEXT

Banco de dados a ser usado. Honra $SNOWSQL_DATABASE.

-s, --schemaname TEXT

Esquema no banco de dados a ser usado. Honra $SNOWSQL_SCHEMA.

-r, --rolename TEXT

Nome da função a ser usada Honra $SNOWSQL_ROLE.

-w, --warehouse TEXT

Warehouse a ser usado. Honra $SNOWSQL_WAREHOUSE.

-h, --host TEXT

Endereço do host da conexão. Honra $SNOWSQL_HOST. (Obsoleto)

-p, --port INTEGER

Número da porta para conexão. Honra $SNOWSQL_PORT. (Obsoleto)

--region TEXT

Região. Honra $SNOWSQL_REGION. (Obsoleto; use -a ou –nomeconta em seu lugar)

-m, --mfa-passcode TEXT

Token a ser usado para autenticação multifator (MFA)

--mfa-passcode-in-password

Adiciona o código de acesso MFA ao final da senha.

--abort-detached-query

Anula uma consulta se a conexão entre o cliente e o servidor for perdida. Por padrão, isso não abortará mesmo que a conexão seja perdida.

--probe-connection

Teste de conectividade ao Snowflake. Esta opção é utilizada principalmente para imprimir a cadeia de certificados TLS (Transport Layer Security).

--proxy-host TEXT

(DEPRECATED. Use as variáveis de ambiente HTTPS_PROXY e HTTP_PROXY). Nome do host do servidor proxy. Honra $SNOWSQL_PROXY_HOST.

--proxy-port INTEGER

(DEPRECATED. Use as variáveis de ambiente HTTPS_PROXY e HTTP_PROXY). Número da porta do servidor proxy. Honra $SNOWSQL_PROXY_PORT.

--proxy-user TEXT

(DEPRECATED. Use as variáveis de ambiente HTTPS_PROXY e HTTP_PROXY). Nome de usuário do servidor proxy. Honra $SNOWSQL_PROXY_USER. Defina $SNOWSQL_PROXY_PWD para a senha do servidor proxy.

--authenticator TEXT

Autenticador: “snowflake”, “externalbrowser” (para usar qualquer IdP e um navegador da web), https://<okta_account_name>.okta.com (para usar Okta nativo) ou “oauth” para autenticar usando OAuth.

-v, --version

Mostra a versão atual do SnowSQL, ou usa uma versão específica se fornecida como um valor.

--noup

Desativa a atualização automática para esta execução. Se nenhuma versão for especificada para -v, a última versão em ~/.snowsql/ será usada.

-D, --variable TEXT

Define uma variável a ser referenciada por &<var>. -D tablename=CENUSTRACKONE or –variable db_key=$DB_KEY

-o, --option TEXT

Definir opções de SnowSQL. Consulte a referência das opções na documentação do Snowflake.

-f, --filename PATH

Arquivo a ser executado.

-q, --query TEXT

Consulta a ser executada.

--query_tags TEXT

Tags a serem usadas ao executar consultas. Por padrão, --query_tag lê o valor da variável de ambiente SNOWSQL_QUERY_TAG.

--config PATH

Caminho e nome do arquivo de configuração SnowSQL. Por padrão, ~/.snowsql/config.

-P, --prompt

Força uma solicitação de senha interativa para permitir que você especifique uma senha diferente daquela armazenada na variável de ambiente $SNOWSQL_PWD.

-M, --mfa-prompt

Força uma solicitação para o segundo token para MFA.

-c, --connection TEXT

Conjunto nomeado de parâmetros de conexão a serem usados.

--single-transaction

Conexão com confirmação automática desativada. Insere BEGIN/COMMIT ao redor das instruções s para executá-las como uma única transação, garantindo que todos os comandos sejam concluídos com sucesso ou que nenhuma mudança seja aplicada.

--private-key-path PATH

Caminho para o arquivo de chave privada.

--disable-request-pooling

Desativa o pool de conexões.

-U, --upgrade

Force a atualização de SnowSQL para a versão mais recente.

-K, --client-session-keep-alive

Mantenha a sessão ativa indefinidamente, mesmo que não haja atividade do usuário.

--include_connector_version

Exiba a versão do software conector Snowflake para Python que está empacotado no binário SnowSQL.

-?, --help

Mostre esta mensagem e saia.

Especificação de senhas ao conectar

As senhas não podem ser passadas através de parâmetros de conexão. As senhas devem ser especificadas de uma das seguintes maneiras:

Nota

Em ambientes Windows, o terminal Cygwin não solicita o identificador de sua conta, nome de usuário ou senha. Isto porque o SnowSQL não pode habilitar o modo TTY nos terminais Cygwin.

Uso de variáveis de ambiente

Atualmente, as variáveis de ambiente só podem ser usadas para pré-especificar alguns valores de parâmetros de linha de comando, tais como senha, host e banco de dados. As variáveis de ambiente não estão disponíveis para uso na substituição de variáveis do SnowSQL a menos que sejam explicitamente especificadas na linha de comando ao iniciar o SnowSQL, usando ou o parâmetro de conexão -D ou --variable. Por exemplo:

Linux/macOS:
$ snowsql ... -D tablename=CENUSTRACKONE --variable db_key=$DB_KEY
Copy
Windows:
$ snowsql ... -D tablename=CENUSTRACKONE --variable db_key=%DB_KEY%
Copy

No exemplo acima, --variable define uma variável Snowflake chamada db_key como a variável de ambiente DB_KEY.

Definição das configurações de conexão padrão

Recomendamos a configuração de seus parâmetros de conexão padrão para simplificar o processo de conexão. Depois disso, ao conectar-se ao Snowflake, você pode omitir seu identificador de conta Snowflake, nome de usuário e quaisquer outros parâmetros que tenha configurado como seus valores padrão.

Para definir suas configurações padrão:

  1. Abra o arquivo de configuração do SnowSQL (chamado config) em um editor de texto. A localização padrão do arquivo é:

    Linux/macOS:

    ~/.snowsql/

    Windows:

    %USERPROFILE%\.snowsql\

    Nota

    Você pode mudar o local padrão especificando o sinalizador de linha de comando --config path ao iniciar o SnowSQL.

  1. Na seção [connections], configure os parâmetros de conexão padrão, removendo o símbolo de comentário de qualquer um dos parâmetros a seguir e especificando os valores corretos:

    [connections]
    #accountname = <string>   # Account identifier to connect to Snowflake.
    #username = <string>      # User name in the account. Optional.
    #password = <string>      # User password. Optional.
    #dbname = <string>        # Default database. Optional.
    #schemaname = <string>    # Default schema. Optional.
    #warehousename = <string> # Default warehouse. Optional.
    #rolename = <string>      # Default role. Optional.
    #authenticator = <string> # Authenticator: 'snowflake', 'externalbrowser' (to use any IdP and a web browser),  https://<okta_account_name>.okta.com (to use Okta natively), 'oauth' to authenticate using OAuth.
    
    Copy

    Atenção

    • A senha é armazenada em texto simples no arquivo config. Você deve proteger explicitamente o arquivo para restringir o acesso. Por exemplo, no Linux ou no macOS, você pode definir as permissões de leitura somente para você, executando chmod:

      $ chmod 700 ~/.snowsql/config
      
      Copy
    • Se sua senha incluir caracteres especiais, você deve anexar a senha entre aspas simples ou duplas.

Verificação da conexão da rede ao Snowflake com SnowCD

Após a configuração, você pode avaliar e solucionar problemas de conectividade de sua rede com o Snowflake usando SnowCD.

Você pode usar o SnowCD durante o processo de configuração inicial e sob demanda a qualquer momento para avaliar e solucionar problemas de sua conexão de rede ao Snowflake.

Uso de conexões nomeadas

Para fazer múltiplas conexões simultâneas ao Snowflake, ou simplesmente para armazenar diferentes configurações de conexão, você pode definir uma ou mais conexões nomeadas.

Definição de conexões nomeadas no arquivo de configuração

  1. Abra o arquivo de configuração config em um editor de texto. Por padrão, o arquivo está localizado em:

    Linux/macOS:

    ~/.snowsql/

    Windows:

    %USERPROFILE%\.snowsql\

  2. Adicione uma seção [connections] separada com um nome único para cada conexão nomeada.

    Por exemplo, o seguinte ilustra uma conexão chamada my_example_connection para uma conta Snowflake com o identificador da conta myorganization-myaccount:

    [connections.my_example_connection]
    accountname = myorganization-myaccount
    username = jsmith
    password = xxxxxxxxxxxxxxxxxxxx
    dbname = mydb
    schemaname = public
    warehousename = mywh
    
    Copy

Conexão ao Snowflake usando uma conexão nomeada

Use o parâmetro de conexão -c <cadeia de caracteres> (ou --connection <cadeia de caracteres>) para especificar uma conexão nomeada, onde <cadeia de caracteres> é o nome de uma conexão definida no arquivo de configuração.

Por exemplo, conecte-se usando a conexão my_example_connection que você criou em Definição de conexões nomeadas no arquivo de configuração (neste tópico):

$ snowsql -c my_example_connection
Copy

Uso de autenticação de pares de chaves e rotação de pares de chaves

O SnowSQL suporta autenticação de par de chaves e rotação de chaves. Você pode usar pares de chaves não criptografadas ou criptografadas.

Cuidado

Embora as chaves privadas não criptografadas sejam com suporte, o Snowflake recomenda fortemente o uso de chaves privadas criptografadas ao se conectar ao Snowflake. As chaves privadas não criptografadas não têm proteção contra o uso não autorizado se qualquer pessoa não autorizada tiver acesso a elas.

O procedimento a seguir considera que você utilize a autenticação do par de chaves criptografadas recomendado:

  1. Para começar, siga as instruções para configurar Autenticação de pares de chaves e rotação de pares de chaves.

  2. Especifique o caminho para o arquivo de chave privada, seja no arquivo de configuração ou na linha de comando:

  • No arquivo de configuração:

    • Adicione o parâmetro de conexão private_key_path às suas configurações de conexão e especifique o caminho local para o arquivo de chave privada que você criou. A sintaxe não é específica de OS:

      OS com suporte:
      private_key_path = <path>/rsa_key.p8
      
      Copy
    • Use a variável de ambiente SNOWSQL_PRIVATE_KEY_PASSPHRASE para definir a senha de descriptografia do arquivo de chave privada. Note que você não deve incluir a senha entre aspas para Linux ou MacOS, mas deve usar aspas simples ou duplas para Windows:

      Linux/macOS:
      export SNOWSQL_PRIVATE_KEY_PASSPHRASE=<passphrase>
      
      Copy
      Windows:
      set SNOWSQL_PRIVATE_KEY_PASSPHRASE='<passphrase>'
      
      Copy
  • Na linha de comando:

    Inclua o parâmetro de conexão private-key-path e especifique o caminho para seu arquivo de chave privada criptografada:

    $ snowsql -a <account_identifier> -u <user> --private-key-path <path>/rsa_key.p8
    
    Copy

    O SnowSQL solicita a senha. Alternativamente, use a variável de ambiente SNOWSQL_PRIVATE_KEY_PASSPHRASE para definir a senha para descriptografar o arquivo de chave privada (como descrito acima).

Uso de um servidor proxy

Para utilizar um servidor proxy, configure as seguintes variáveis de ambiente:

  • HTTP_PROXY

  • HTTPS_PROXY

  • NO_PROXY

Por exemplo:

Linux/macOS:
export HTTP_PROXY='http://username:password@proxyserver.company.com:80'
export HTTPS_PROXY='http://username:password@proxyserver.company.com:80'
Copy
Windows:
set HTTP_PROXY=http://username:password@proxyserver.company.com:80
set HTTPS_PROXY=http://username:password@proxyserver.company.com:80
Copy

Dica

O Snowflake não oferece suporte a configurações que envolvam a interceptação de proxies HTTPS que apresentem um certificado Transport Layer Security (TLS) diferente daquele emitido pelo Snowflake. Evitar essa configuração ajuda a reduzir possíveis riscos de segurança, como um ataque MITM (Man In The Middle) por meio de um proxy comprometido.

Se você precisar usar seu proxy TLS, a Snowflake recomenda fortemente que você atualize a política do servidor para passar o certificado do Snowflake de modo que nenhum certificado seja alterado no meio das comunicações.

Opcionalmente, NO_PROXY pode ser usado para ignorar o proxy para comunicações específicas. Por exemplo, o acesso Amazon S3 pode ser ignorado especificando NO_PROXY=".amazonaws.com".

Uso de um navegador da web para autenticação federada/SSO

Para usar a autenticação SSO baseada no navegador para SnowSQL, adicione --authenticator externalbrowser aos parâmetros de conexão SnowSQL:

Por exemplo:

$ snowsql -a <account_identifier> -u <username> --authenticator externalbrowser
Copy

Para obter mais informações sobre autenticação federada/SSO, consulte Gerenciamento/uso da autenticação federada.

Verificação da versão do driver ou conector OCSP

O Snowflake usa OCSP para avaliar a cadeia de certificados ao fazer uma conexão com o Snowflake. A versão do driver ou conector e sua configuração determinam o comportamento OCSP. Para obter mais informações sobre a versão do driver ou conector, sua configuração e comportamento OCSP, consulte Configuração do OCSP.

Servidor de cache de resposta OCSP

Nota

O servidor de cache de resposta OCSP tem suporte do SnowSQL 1.1.55 e superior.

Os clientes Snowflake iniciam cada conexão com um ponto de extremidade do servidor Snowflake com um “handshake” que estabelece uma conexão segura antes de realmente transferir dados. Como parte do handshake, um cliente autentica o certificado TLS do ponto de extremidade do servidor. O status de revogação do certificado é verificado enviando uma solicitação do certificado de cliente para um dos servidores OCSP (Online Certificate Status Protocol) para a CA (autoridade de certificação).

Uma falha na conexão ocorre quando a resposta do servidor OCSP é atrasada além de um tempo razoável. Os seguintes caches persistem no status de revogação, ajudando a aliviar esses problemas:

  • Cache de memória, que persiste por toda a vida do processo.

  • Cache de arquivos, que persiste até que o diretório de cache (por exemplo, ~/.cache/snowflake ou ~/.snowsql/ocsp_response_cache) seja purgado.

  • O servidor de cache de resposta OCSP do Snowflake, que busca respostas OCSP dos servidores OCSP da CA de hora em hora e as armazena por 24 horas. Os clientes podem então solicitar o status de validação de um determinado certificado do Snowflake a partir deste cache do servidor.

    Importante

    Se a política de seu servidor negar acesso à maioria ou a todos os sites e endereços IP externos, você precisará permitir que o endereço do servidor de cache permita a operação normal do serviço. O nome de host do servidor de cache é ocsp*.snowflakecomputing.com:80.

    Se você precisar desativar o servidor de cache por qualquer motivo, defina a variável de ambiente SF_OCSP_RESPONSE_CACHE_SERVER_ENABLED como false. Observe que o valor diferencia maiúsculas e minúsculas e precisa estar em minúsculas.

Se nenhuma das camadas de cache contiver a resposta do servidor OCSP, o cliente tenta obter o status de validação diretamente do servidor OCSP para a CA.

Tratamento de erros de conexão

Cannot open self /usr/bin/snowsql or archive /usr/bin/snowsql.pkg (somente Linux)

Devido a uma limitação do pyinstaller (o programa que empacota o SnowSQL em um executável independente a partir do código fonte Python), o prelink remove erroneamente partes do executável snowsql e causa este erro.

Para evitar este problema, o instalador do SnowSQL tenta atualizar o arquivo de configuração prelink em /etc/prelink.conf.d/snowsql.conf para o executável snowsql de forma que o prelink não altere o arquivo. Infelizmente, esta atualização de configuração não pode ser feita pelo processo de atualização automática do SnowSQL.

Trabalhe com seu administrador de sistema para executar o seguinte comando em sua estação de trabalho:

$ sudo bash -c "echo '-b snowsql' > /etc/prelink.conf.d/snowsql.conf"
Copy

Nota

Se você instalar snowsql em seu diretório base do usuário, este problema é menos provável de ocorrer porque prelink está configurado, por padrão, para verificar os diretórios de binários compartilhados (por exemplo, /usr/bin ou /bin) e não altera os programas em seu diretório base.

Referência de parâmetros de conexão

-a , --accountname

Descrição:

Obrigatório

Especifica seu identificador da conta.

Este parâmetro de conexão também pode ser definido no arquivo de configuração.

Valor:

Cadeia de caracteres

Além disso, o valor pode ser uma variável de ambiente:

Linux/macOS:

$SNOWSQL_ACCOUNT

Windows:

%SNOWSQL_ACCOUNT%

Por exemplo, no Linux ou macOS:

$ export SNOWSQL_ACCOUNT=myorganization-myaccount

$ snowsql -a $SNOWSQL_ACCOUNT
Copy
Padrão:

Nenhum

-u , --username

Descrição:

Especifica o nome de login do usuário com o qual você se conecta à conta especificada.

Este parâmetro de conexão também pode ser definido no arquivo de configuração.

Valor:

Cadeia de caracteres

O valor pode ser uma variável de ambiente:

Linux/macOS:

$SNOWSQL_USER

Windows:

%SNOWSQL_USER%

Por exemplo, no Linux ou macOS:

$ export SNOWSQL_USER=jdoe

$ snowsql -u $SNOWSQL_USER
Copy
Padrão:

Nenhum

-d , --dbname

Descrição:

Especifica o banco de dados a ser utilizado por padrão na sessão do cliente (pode ser alterado após o login).

Valor:

Cadeia de caracteres

O valor pode ser uma variável de ambiente:

Linux/macOS:

$SNOWSQL_DATABASE

Windows:

%SNOWSQL_DATABASE%

Este parâmetro de conexão também pode ser definido no arquivo de configuração.

Padrão:

Nenhum

-s , --schemaname

Descrição:

Especifica o esquema do banco de dados a ser usado por padrão na sessão do cliente (pode ser alterado após o login).

Valor:

Cadeia de caracteres

O valor pode ser uma variável de ambiente:

Linux/macOS:

$SNOWSQL_SCHEMA

Windows:

%SNOWSQL_SCHEMA%

Este parâmetro de conexão também pode ser definido no arquivo de configuração.

Padrão:

Nenhum

-r , --rolename

Descrição:

Especifica a função a ser usada por padrão para acessar objetos Snowflake na sessão do cliente (pode ser alterada após o login).

Este parâmetro de conexão também pode ser definido no arquivo de configuração.

Valor:

Cadeia de caracteres

O valor pode ser uma variável de ambiente:

Linux/macOS:

$SNOWSQL_ROLE

Windows:

%SNOWSQL_ROLE%

Padrão:

Nenhum

-w , --warehouse

Descrição:

Especifica o warehouse virtual a ser utilizado por padrão para consultas, carregamento, etc. na sessão do cliente (pode ser alterado após o login).

Este parâmetro de conexão também pode ser definido no arquivo de configuração.

Valor:

Cadeia de caracteres

O valor pode ser uma variável de ambiente:

Linux/macOS:

$SNOWSQL_WAREHOUSE

Windows:

%SNOWSQL_WAREHOUSE%

Padrão:

Nenhum

-h , --hostObsoleto

Descrição:

Fornecido para compatibilidade com versões anteriores/uso interno

Especifica o endereço do host ao qual você se conecta no Snowflake.

Este parâmetro não é mais utilizado porque o endereço do host é determinado automaticamente pela concatenação do identificador de conta especificado (usando -a ou --account) e o domínio Snowflake (snowflakecomputing.com).

Valor:

Cadeia de caracteres

Padrão:

Nenhum

-p , --portObsoleto

Descrição:

Fornecido para compatibilidade com versões anteriores/uso interno

Especifica o número da porta a ser utilizada para a conexão.

Este parâmetro não é mais utilizado porque o número da porta do Snowflake é sempre 443.

Valor:

Cadeia de caracteres

Padrão:

Nenhum

--regionObsoleto

Descrição:

Fornecido para compatibilidade com versões anteriores/uso interno

Especifica a ID para a região onde sua conta está localizada.

Este parâmetro não é mais utilizado. Para obter mais detalhes, consulte -a , --accountname (neste tópico).

Valor:

N/A

Padrão:

N/A

-m , --mfa-passcode

Descrição:

Especifica o segundo token para MFA (autenticação multifator) se você passar o código de acesso na linha de comando.

Valor:

Cadeia de caracteres

Padrão:

Nenhum

--mfa-passcode-in-password

Descrição:

Adiciona o código de acesso MFA ao final da senha.

Você pode forçar a solicitação de senha e digitar a senha seguida do código de acesso MFA. Por exemplo, se a o token MFA for 123456 e a senha for PASSWORD:

$ snowsql ... -P ...

Password: PASSWORD123456
Copy
Valor:

N/D (o parâmetro não usa um valor)

Padrão:

N/A

--abort-detached-query

Descrição:

Anula uma consulta se a conexão entre o cliente e o servidor for perdida.

Valor:

Booleano

Padrão:

Falso (ou seja, uma consulta ativa não é anulada se a conexão for perdida)

--probe-connection

Descrição:

Teste a conectividade com o Snowflake e informe os resultados. Note que esta é uma opção experimental utilizada principalmente para imprimir a cadeia de certificados TLS.

Valor:

N/D (o parâmetro não usa um valor)

Padrão:

N/A

--authenticator

Descrição:

Especifica o autenticador a ser usado para verificar as credenciais de login do usuário.

Valor:

Cadeia de caracteres (constante):

  • snowflake utiliza o autenticador interno do Snowflake.

  • externalbrowser usa seu navegador para autenticar com Okta, AD FS ou qualquer outro provedor de identidade compatível com SAML 2.0 (IdP) que tenha sido definido para sua conta.

  • https://<nome_da_conta_okta>.okta.com (ou seja, o ponto de extremidade da URL para Okta) autentica através de Okta nativo (com suporte apenas se seu IdP for Okta).

  • oauth autentica usando OAuth. Quando OAuth é especificado como o autenticador, você também deve definir o parâmetro --token para especificar o token OAuth (consulte abaixo).

Para obter mais informações, consulte Gerenciamento/uso da autenticação federada e Clientes, drivers e conectores.

Padrão:

snowflake

Nota

O autenticador externalbrowser só tem suporte em janelas de terminal que tenham acesso ao navegador da web. Por exemplo, uma janela de terminal em uma máquina remota acessada através de uma sessão SSH (Secure Shell) pode requerer configuração adicional para abrir um navegador da web.

Se você não tem acesso a um navegador da web, mas seu IdP é Okta, você pode usar o Okta nativo (ou seja, defina o autenticador como https://<nome_da_conta_okta>.okta.com).

--token

Descrição:

Especifica o token OAuth a ser usado para autenticação. Este parâmetro só é necessário quando você especifica --authenticator=oauth.

Valor:

Cadeia de caracteres

Padrão:

Nenhum

-v , --version

Descrição:

Use a versão SnowSQL especificada ou, se nenhuma versão for especificada, exiba a última versão SnowSQL instalada.

Valor:

Cadeia de caracteres

Padrão:

Nenhum

--versions

Descrição:

Lista todas as versões disponíveis do SnowSQL que podem ser instaladas e executadas. Para instalar uma versão anterior do SnowSQL da lista, use a opção -v e especifique a versão que você deseja instalar.

Valor:

N/D (o parâmetro não usa um valor)

Padrão:

N/A

--noup

Descrição:

Desativa a atualização automática para esta execução. Se esta opção não for incluída e uma versão mais nova estiver disponível, o SnowSQL automaticamente baixa e instala a nova versão. Na próxima vez que você executar o SnowSQL, a nova versão é utilizada.

Valor:

N/D (o parâmetro não usa um valor)

Padrão:

N/A

-D , --variable

Descrição:

Define variáveis SnowSQL na linha de comando. Esta opção pode ser usada para definir variáveis específicas a serem usadas no Snowflake.

Valor:

Cadeia de caracteres

Por exemplo:

$ snowsql ... -D tablename=CENUSTRACKONE --variable db_key=$DB_KEY ...
Copy
Padrão:

Nenhum

-o , --option

Descrição:

Define opções de configuração do SnowSQL na linha de comando. Estas opções substituem quaisquer opções que tenham sido definidas no arquivo de configuração do SnowSQL. Para descrições das opções que você pode definir/substituir, consulte Referência de opções de configuração do SnowSQL.

Valor:

Cadeia de caracteres

Padrão:

Nenhum

-f , --filename

Descrição:

Especifica um arquivo SQL a ser executado em modo de lote.

O valor pode ser um nome de arquivo (incluindo o caminho do diretório, se necessário) ou uma URL para o arquivo.

Valor:

Cadeia de caracteres

Padrão:

Nenhum

-q , --query

Descrição:

Especifica uma consulta SQL a ser executada.

O valor pode ser uma única consulta SQL ou uma lista de consultas separadas por ponto e vírgula a executar (por exemplo, 'select current_user(); select current_role()').

Você também pode especificar várias consultas a serem executadas assincronamente separando as consultas com ;>. O exemplo a seguir inicia o SnowSQL e executa as quatro consultas de forma assíncrona:

snowsql -o log_level=DEBUG -q "select * from SNOWSQLTABLE;> insert into table table1 values(2);> select 5;>select count(*) from testtable;"

Valor:

Cadeia de caracteres

Padrão:

Nenhum

--query_tag

Descrição:

Especifica as tags a serem usadas ao executar uma consulta.

O valor pode ser uma única tag ou uma lista de tags separadas por ponto e vírgula.

Valor:

Cadeia de caracteres

Padrão:

Valor da variável de ambiente SNOWSQL_QUERY_TAG.

--config

Descrição:

Especifica a localização (ou seja, caminho de diretório) para o arquivo de configuração SnowSQL. Inclua este parâmetro de conector se você quiser mover ou copiar o arquivo de configuração do local padrão.

Valor:

Cadeia de caracteres

Padrão:

Específico de OS:

Linux/macOS:

~/.snowsql/

Windows:

%USERPROFILE%\.snowsql\

-P , --prompt

Descrição:

Força um prompt de senha interativo.

Por padrão, SnowSQL utiliza a senha armazenada na variável de ambiente $SNOWSQL_PWD. O uso desta opção permite que você substitua a senha definida em $SNOWSQL_PWD.

Valor:

N/D (o parâmetro não usa um valor)

Padrão:

N/A

-M, --mfa-prompt

Descrição:

Força uma solicitação para o segundo token para MFA. Alternativamente, use --mfa-passcode <cadeia de caracteres> se quiser passar para a linha de comando.

Valor:

N/D (o parâmetro não usa um valor)

Padrão:

N/A

-c , --connection

Descrição:

Especifica uma conexão a ser usada, onde a cadeia de caracteres especificada é o nome de uma conexão definida no arquivo de configuração do SnowSQL. Para obter mais detalhes, consulte Uso de conexões nomeadas (neste tópico).

Valor:

Cadeia de caracteres

Padrão:

Nenhum

--single-transaction

Descrição:

Combinado com --filename, --query, ou comandos de entrada padrão, esta opção insere BEGIN/COMMIT ao redor das instruções para garantir que todos os comandos sejam completados com sucesso ou que nenhuma alteração seja aplicada.

Valor:

N/D (o parâmetro não usa um valor)

Padrão:

N/A

Nota

Observe que se os comandos de entrada utilizarem BEGIN, COMMIT ou ROLLBACK, esta opção não funcionará corretamente. Além disso, se qualquer comando não puder ser executado dentro de um bloco de transação, esta opção fará com que o comando falhe.

--private-key-path

Descrição:

Caminho para o arquivo de chave privada.

Cuidado

Embora as chaves privadas não criptografadas sejam com suporte, o Snowflake recomenda fortemente o uso de chaves privadas criptografadas ao se conectar ao Snowflake.

Para obter mais informações, consulte Uso de autenticação e rotação do par de chaves.

Este parâmetro de conexão também pode ser definido no arquivo de configuração.

Valor:

Cadeia de caracteres

Padrão:

Nenhum

--disable-request-pooling

Descrição:

Por padrão, o snowsql utiliza o pool de conexões. O pool de conexões geralmente reduz o tempo de espera para fazer uma conexão. Entretanto, pode retardar o failover do cliente para um DNS alternativo quando ocorre um problema de DNS. Este parâmetro permite que você desative o pool de conexões.

Este parâmetro se aplica somente aos clientes que têm a replicação habilitada.

Valor:

N/D (o parâmetro não usa um valor)

Padrão:

N/A

-U , --upgrade

Descrição:

Force a atualização do SnowSQL para a versão mais recente, caso não tenha sido baixada no diretório local.

Valor:

N/D (o parâmetro não usa um valor)

Padrão:

N/A

Nota

Requer o bootstrap executável do SnowSQL 1.1.63 ou versão mais recente. Baixe-a a partir da UI.

-K , --client-session-keep-alive

Descrição:

Mantenha a sessão ativa indefinidamente, mesmo que não haja atividade do usuário.

Valor:

N/D (o parâmetro não usa um valor)

Padrão:

N/A

--include_connector_version

Descrição:

Exibe a versão do software conector Snowflake para Python que está empacotado no binário SnowSQL.

Valor:

N/D (o parâmetro não usa um valor)

Padrão:

N/A

-? , --help

Descrição:

Mostra o guia de uso rápido da linha de comando.

Valor:

N/D (o parâmetro não usa um valor)

Padrão:

N/A