SnowSQL を介した接続¶

接続時のパスワードの指定¶

接続パラメーターを介してパスワードを渡すことはできません。パスワードは、次のいずれかの方法で指定する必要があります。

• SnowSQL の インタラクティブプロンプト を介して入力します（パスワードのみに適用）。

• password オプションを使用して、SnowSQL 構成ファイルで定義します。詳細については、（このトピックの） デフォルトの接続設定の構成 をご参照ください。

• SNOWSQL_PWD 環境変数を使用して指定します。詳細については、（このトピックの） 環境変数の使用 をご参照ください。

環境変数の使用¶

現在、環境変数は、パスワード、ホスト、データベースなどの一部のコマンドラインパラメーター値を事前に指定するためにのみ使用できます。環境変数は、 -D または --variable 接続パラメーターを使用して、SnowSQL を開始するときにコマンドラインで明示的に指定されない限り、SnowSQL 変数置換で使用できません。例：

Linux/macOS:

$ snowsql ... -D tablename=CENUSTRACKONE --variable db_key=$DB_KEY

Copy

Windows:

$ snowsql ... -D tablename=CENUSTRACKONE --variable db_key=%DB_KEY%

Copy

上記の例では、 --variable は db_key というSnowflake変数を DB_KEY 環境変数に設定します。

構成ファイルでの名前付き接続の定義¶

1. テキストエディターで config 構成ファイルを開きます。デフォルトでは、ファイルは次の場所にあります。

   Linux/macOS:

   ~/.snowsql/

   Windows:

   %USERPROFILE%\.snowsql\

2. 名前付き接続ごとに一意の名前を持つ個別の [connections] セクションを追加します。

   次の例は、 アカウント識別子 myorganization-myaccount を使用した、Snowflakeアカウントの my_example_connection という名前の接続を示しています。

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

   Copy

名前付き接続を使用したSnowflakeへの接続¶

-c <ストリング> （または --connection <ストリング>）接続パラメーターを使用して、名前付き接続を指定します。 <ストリング> は、 構成ファイル で定義された接続の名前です。

たとえば、（このトピックの） 構成ファイルでの名前付き接続の定義 （このトピック内）で作成した my_example_connection 接続を使用して接続します。

$ snowsql -c my_example_connection

Copy

-a 、 --accountname¶

説明:

必須

使用する アカウント識別子 を指定します。

この接続パラメーターは、 構成ファイル でも設定できます。

値:

文字列

また、値は環境変数にすることもできます。

Linux/macOS:

$SNOWSQL_ACCOUNT

Windows:

%SNOWSQL_ACCOUNT%

たとえば、Linuxまたは macOSでは、次のようになります。

$ export SNOWSQL_ACCOUNT=myorganization-myaccount

$ snowsql -a $SNOWSQL_ACCOUNT

Copy

デフォルト:

なし

-u 、 --username¶

説明:

指定したアカウントに接続するユーザーのログイン名を指定します。

この接続パラメーターは、 構成ファイル でも設定できます。

値:

文字列

値は環境変数にすることができます。

Linux/macOS:

$SNOWSQL_USER

Windows:

%SNOWSQL_USER%

たとえば、Linuxまたは macOSでは、次のようになります。

$ export SNOWSQL_USER=jdoe

$ snowsql -u $SNOWSQL_USER

Copy

デフォルト:

なし

-d 、 --dbname¶

説明:

クライアントセッションでデフォルトで使用するデータベースを指定します（ログイン後に変更できます）。

値:

文字列

値は環境変数にすることができます。

Linux/macOS:

$SNOWSQL_DATABASE

Windows:

%SNOWSQL_DATABASE%

この接続パラメーターは、 構成ファイル でも設定できます。

デフォルト:

なし

-s 、 --schemaname¶

説明:

クライアントセッションでデフォルトで使用するデータベーススキーマを指定します（ログイン後に変更できます）。

値:

文字列

値は環境変数にすることができます。

Linux/macOS:

$SNOWSQL_SCHEMA

Windows:

%SNOWSQL_SCHEMA%

この接続パラメーターは、 構成ファイル でも設定できます。

デフォルト:

なし

-r 、 --rolename¶

説明:

クライアントセッションでSnowflakeオブジェクトにアクセスするためにデフォルトで使用するロールを指定します（ログイン後に変更できます）。

この接続パラメーターは、 構成ファイル でも設定できます。

値:

文字列

値は環境変数にすることができます。

Linux/macOS:

$SNOWSQL_ROLE

Windows:

%SNOWSQL_ROLE%

デフォルト:

なし

-w 、 --warehouse¶

説明:

クライアントセッションのクエリ、ロードなどにデフォルトで使用する仮想ウェアハウスを指定します（ログイン後に変更できます）。

この接続パラメーターは、 構成ファイル でも設定できます。

値:

文字列

値は環境変数にすることができます。

Linux/macOS:

$SNOWSQL_WAREHOUSE

Windows:

%SNOWSQL_WAREHOUSE%

デフォルト:

なし

-h 、 --host --- 廃止¶

説明:

下位互換性/内部使用のために提供

Snowflakeで接続するホストのアドレスを指定します。

ホストアドレスは、指定したアカウント識別子（-a または --account を使用）とSnowflakeドメイン（snowflakecomputing.com）を連結することで自動的に決定されるため、このパラメーターは使用されなくなりました。

値:

文字列

デフォルト:

なし

-p、 --port --- 廃止¶

説明:

下位互換性/内部使用のために提供

接続に使用するポート番号を指定します。

Snowflakeのポート番号は常に 443 であるため、このパラメーターは使用されなくなりました。

値:

文字列

デフォルト:

なし

--region --- 廃止¶

説明:

下位互換性/内部使用のために提供

アカウントが存在する 地域 の ID を指定します。

このパラメーターは使用されなくなりました。詳細については、 -a 、 --accountname （このトピック内）をご参照ください。

値:

N/A

デフォルト:

N/A

-m 、 --mfa-passcode¶

説明:

コマンドラインでパスコードを渡す場合、MFA （多要素認証）の2番目のトークンを指定します。

値:

文字列

デフォルト:

なし

--mfa-passcode-in-password¶

説明:

パスワードの最後に MFA パスコードを追加します。

パスワードプロンプトを強制し、パスワードの後に MFA パスコードを入力できます。例えば、MFA トークンが 123456 で、パスワードが PASSWORD の場合は、次のようになります。

$ snowsql ... -P ...

Password: PASSWORD123456

Copy

値:

なし（パラメーターは値を取らない）

デフォルト:

N/A

--abort-detached-query¶

説明:

クライアントとサーバー間の接続が失われた場合、クエリを中止します。

値:

ブール値

デフォルト:

False（接続が失われてもアクティブなクエリは中止されない）

--probe-connection¶

説明:

Snowflakeへの接続をテストし、結果を報告します。これは、主に TLS 証明書チェーンを出力するために使用される試験的なオプションであることに注意してください。

値:

なし（パラメーターは値を取らない）

デフォルト:

N/A

--authenticator¶

説明:

ユーザーログイン認証情報の検証に使用する認証方式を指定します。

値:

文字列（定数）：

• snowflake では、内部Snowflake認証方式を使用します。

• externalbrowser は、 ウェブブラウザーを使用 して、Okta、AD FS、またはアカウントに定義されている他のSAML 2.0準拠の識別プロバイダー（IdP）で認証します。

• https://<Oktaのアカウント名>.okta.com （つまり、OktaのURLエンドポイント）は、 ネイティブOktaの を介して認証します（IdPがOktaの場合のみサポート）。

• oauth は、OAuthを使用して認証します。OAuth が認証コードとして指定されている場合は、 OAuth トークンを指定するために --token パラメーターも設定する必要があります（ 以下を参照）。

詳細については、 フェデレーション認証の管理/使用 および クライアント、ドライバー、およびコネクタ をご参照ください。

デフォルト:

snowflake

注釈

externalbrowser 認証方式は、ウェブブラウザーにアクセスできるターミナルウィンドウでのみサポートされます。たとえば、SSH（Secure Shell）セッションを介してアクセスされるリモートマシンのターミナルウィンドウでは、ウェブブラウザーを開くために追加設定が必要になる場合があります。

ウェブブラウザーへのアクセスがなくても、IdPがOktaの場合は、ネイティブOktaを使用できます（つまり、認証方式を https://<Oktaのアカウント名>.okta.com に設定）。

--token¶

説明:

認証に使用する OAuth トークンを指定します。このパラメーターは、 --authenticator=oauth を指定する場合にのみ必要です。

値:

文字列

デフォルト:

なし

-v 、 --version¶

説明:

指定された SnowSQL バージョンを使用するか、バージョンが指定されていない場合は、インストールされている最新の SnowSQL バージョンを表示します。

値:

文字列

デフォルト:

なし

--versions¶

説明:

インストールして実行できる SnowSQL の利用可能なすべてのバージョンをリストします。リストから以前の SnowSQL バージョンをインストールするには、 -v オプションを使用して、インストールするバージョンを指定します。

値:

なし（パラメーターは値を取らない）

デフォルト:

N/A

--noup¶

説明:

この実行の自動アップグレードを無効化します。このオプションが含まれておらず、新しいバージョンが利用可能な場合、SnowSQL は自動的に新しいバージョンをダウンロードしてインストールします。次回の SnowSQL実行時には、新しいバージョンが使用されます。

値:

なし（パラメーターは値を取らない）

デフォルト:

N/A

-D 、 --variable¶

説明:

コマンドラインで SnowSQL 変数を定義します。このオプションを使用して、Snowflakeで使用する特定の変数を設定できます。

値:

文字列

例:

$ snowsql ... -D tablename=CENUSTRACKONE --variable db_key=$DB_KEY ...

Copy

デフォルト:

なし

-o 、 --option¶

説明:

コマンドラインで SnowSQL 構成オプションを定義します。これらのオプションは、 SnowSQL 構成ファイルで設定されたオプションを上書きします。設定/オーバーライドできるオプションの説明については、 SnowSQL 構成オプションリファレンス をご参照ください。

値:

文字列

デフォルト:

なし

-f 、 --filename¶

説明:

バッチモードで実行する SQL ファイルを指定します。

値は、ファイル名（必要に応じてディレクトリパスを含む）またはファイルへの URL です。

値:

文字列

デフォルト:

なし

-q 、 --query¶

説明:

実行する SQL クエリを指定します。

値は、単一の SQL クエリ、または実行するクエリのセミコロン区切りのリスト（例： 'select current_user(); select current_role()'）です。

クエリを ;> で区切ることにより、非同期で実行する複数のクエリを指定することもできます。次の例では、 SnowSQL を開始し、4つのクエリすべてを非同期で実行します。

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

値:

文字列

デフォルト:

なし

--query_tag¶

説明:

クエリ実行時に使用するタグを指定します。

値は1つのタグか、セミコロンで区切られたタグのリストです。

値:

文字列

デフォルト:

SNOWSQL_QUERY_TAG 環境変数の値。

--config¶

説明:

SnowSQL 構成ファイルの場所（ディレクトリパス）を指定します。デフォルトの場所から構成ファイルを移動またはコピーする場合は、このコネクタパラメーターを含めます。

値:

文字列

デフォルト:

OS固有：

Linux/macOS:

~/.snowsql/

Windows:

%USERPROFILE%\.snowsql\

-P 、 --prompt¶

説明:

インタラクティブパスワードプロンプトを強制します。

デフォルトでは、 SnowSQL は $SNOWSQL_PWD 環境変数に保存されているパスワードを使用します。このオプションを使用すると、 $SNOWSQL_PWD で定義されたパスワードを上書きできます。

値:

なし（パラメーターは値を取らない）

デフォルト:

N/A

-M、 --mfa-prompt¶

説明:

MFA の2番目のトークンのプロンプトを強制します。または、コマンドラインに渡す場合は --mfa-passcode <文字列> を使用します。

値:

なし（パラメーターは値を取らない）

デフォルト:

N/A

-c 、 --connection¶

説明:

使用する接続を指定します。指定された文字列は、SnowSQL 構成ファイルで定義された接続の名前です。詳細については、 名前付き接続の使用 （このトピック）をご参照ください。

値:

文字列

デフォルト:

なし

--single-transaction¶

説明:

このオプションは、 --filename、 --query、または標準入力コマンドと組み合わせて、ステートメントを BEGIN/COMMIT でラップし、すべてのコマンドが正常に完了するか、変更が適用されないようにします。

値:

なし（パラメーターは値を取らない）

デフォルト:

N/A

注釈

入力コマンドで BEGIN、 COMMIT、または ROLLBACKを使用する場合、このオプションは正しく機能しないことに注意してください。また、トランザクションブロック内でコマンドを実行できない場合、このオプションによりコマンドが失敗します。

--private-key-path¶

説明:

秘密キーファイルへのパス。

注意

暗号化されていない秘密キーがサポートされていますが、Snowflakeに接続する場合は、暗号化された秘密キーを使用することを強くお勧めします。

詳細については、 キーペア認証およびキーペアローテーションの使用 をご参照ください。

この接続パラメーターは、 構成ファイル でも設定できます。

値:

文字列

デフォルト:

なし

--disable-request-pooling¶

説明:

デフォルトでは、snowsqlは接続プーリングを使用します。接続プーリングは、通常、接続を確立するための遅延時間を短縮します。ただし、DNS の問題が発生すると、代替の DNS へのクライアントフェールオーバーが遅くなる可能性があります。このパラメーターを使用すると、接続プーリングをオフにできます。

このパラメーターは、複製が有効化されている顧客にのみ適用されます。

値:

なし（パラメーターは値を取らない）

デフォルト:

N/A

-U 、 --upgrade¶

説明:

ローカルディレクトリにダウンロードされていない場合、SnowSQL を最新バージョンに強制的にアップグレードします。

値:

なし（パラメーターは値を取らない）

デフォルト:

N/A

注釈

SnowSQL 1.1.63以降のバージョンのブートストラップ実行可能ファイルが必要です。 UIからダウンロードします。

-K 、 --client-session-keep-alive¶

説明:

ユーザーのアクティビティがない場合でも、セッションを無期限にアクティブに保ちます。

値:

なし（パラメーターは値を取らない）

デフォルト:

N/A

--include_connector_version¶

説明:

SnowSQL バイナリのパッケージ内に含まれているPython用Snowflakeコネクタソフトウェアのバージョンを表示します。

値:

なし（パラメーターは値を取らない）

デフォルト:

N/A

-? 、 --help¶

説明:

コマンドラインのクイック使用ガイドを表示します。

値:

なし（パラメーターは値を取らない）

デフォルト:

N/A