Conexão por meio do SnowSQL¶

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:

• Insere pelo prompt interativo em SnowSQL (aplica-se somente a senhas).

• Definidas no arquivo de configuração do SnowSQL usando a opção password. Para obter mais detalhes, consulte Definição de configurações de conexão padrão (neste tópico).

• Especificadas usando as variáveis de ambiente SNOWSQL_PWD. Para obter mais detalhes, consulte Uso de variáveis de ambiente (neste tópico).

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

-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 , --host — Obsoleto¶

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 , --port — Obsoleto¶

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

--region — Obsoleto¶

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

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