snow dcm plan¶

構文¶

snow dcm plan
  <identifier>
  --from <from_location>
  --variable <variables>
  --target <target>
  --save-output
  --connection <connection>
  --host <host>
  --port <port>
  --account <account>
  --user <user>
  --password <password>
  --authenticator <authenticator>
  --workload-identity-provider <workload_identity_provider>
  --private-key-file <private_key_file>
  --token <token>
  --token-file-path <token_file_path>
  --database <database>
  --schema <schema>
  --role <role>
  --warehouse <warehouse>
  --temporary-connection
  --mfa-passcode <mfa_passcode>
  --enable-diag
  --diag-log-path <diag_log_path>
  --diag-allowlist-path <diag_allowlist_path>
  --oauth-client-id <oauth_client_id>
  --oauth-client-secret <oauth_client_secret>
  --oauth-authorization-url <oauth_authorization_url>
  --oauth-token-request-url <oauth_token_request_url>
  --oauth-redirect-uri <oauth_redirect_uri>
  --oauth-scope <oauth_scope>
  --oauth-disable-pkce
  --oauth-enable-refresh-tokens
  --oauth-enable-single-use-refresh-tokens
  --client-store-temporary-credential
  --format <format>
  --verbose
  --debug
  --silent
  --enhanced-exit-codes
  --decimal-precision <decimal_precision>

引数¶

identifier

DCMプロジェクトの識別子。例: MY_DB.MY_SCHEMA.MY_PROJECT。完全修飾名（推奨）または単純な名前をサポートします。修飾されていない場合、デフォルトで接続中のデータベースとスキーマが使用されます。マニフェスト内に`--target`または`default_target`が定義されている場合はオプションです。

オプション¶

--from PATH

DCMプロジェクトファイルを含むローカルディレクトリパス。現在のディレクトリを使用する場合は省略します。

--variable, -D TEXT

実行コンテキストの変数（例：-D "<key>=<value>"）。

--target TEXT

使用する`manifest.yml`からのターゲットプロファイル。指定がない場合は、`default_target`を使用します。

--save-output

コマンドの応答とアーティファクトをローカルの'out/'ディレクトリに保存します。デフォルト：False。

--connection, -c, --environment TEXT

config.toml ファイルで定義されている接続の名前。デフォルト: デフォルト

--host TEXT

接続用のホストアドレス。接続に指定された値を上書きします。

--port INTEGER

接続のポート。接続に指定された値を上書きします。

--account, --accountname TEXT

Snowflakeアカウントに割り当てられた名前。接続に指定された値を上書きします。

--user, --username TEXT

Snowflakeに接続するユーザー名。接続に指定された値を上書きします。

--password TEXT

Snowflakeのパスワード。接続に指定された値を上書きします。

--authenticator TEXT

Snowflakeの認証コード。接続に指定された値を上書きします。

--workload-identity-provider TEXT

ワークロードIDプロバイダー（AWS、AZURE、GCP、OIDC）。接続に指定された値を上書きします。

--private-key-file, --private-key-path TEXT

Snowflake プライベートキーファイルへのパス。接続に指定された値を上書きします。

--token TEXT

Snowflake接続時に使用する OAuth トークン。

--token-file-path TEXT

Snowflake接続時に使用する OAuth トークンを含むファイルへのパス。

--database, --dbname TEXT

使用するデータベース。接続に指定された値を上書きします。

--schema, --schemaname TEXT

使用するデータベーススキーマ。接続に指定された値を上書きします。

--role, --rolename TEXT

使用するロール。接続に指定された値を上書きします。

--warehouse TEXT

使用するウェアハウス名。接続に指定された値を上書きします。

--temporary-connection, -x

構成で定義された接続ではなく、コマンドラインパラメーターで定義された接続を使用します。デフォルト：False。

--mfa-passcode TEXT

多要素認証（MFA）に使用するトークン。

--enable-diag

接続診断レポートを作成するかどうか。デフォルト: false。

--diag-log-path TEXT

生成されたレポートのパス。デフォルトはシステム仮ディレクトリです。デフォルト: <system_temporary_directory>.

--diag-allowlist-path TEXT

allowlist パラメーターを含む JSON ファイルへのパス。

--oauth-client-id TEXT

Snowflake統合のためにIDプロバイダーが提供するクライアントIDの値。

--oauth-client-secret TEXT

Snowflake 統合用に ID プロバイダーが提供するクライアントシークレットの値。

--oauth-authorization-url TEXT

認証コードをドライバーに提供する ID プロバイダーエンドポイント。

--oauth-token-request-url TEXT

ドライバーにアクセストークンを供給する ID プロバイダーのエンドポイント。

--oauth-redirect-uri TEXT

URI 認証コードのリダイレクトに使用します。

--oauth-scope TEXT

ID プロバイダー承認リクエストで要求された範囲。

--oauth-disable-pkce

コード交換の証明キー (PKCE) を無効にします。デフォルト:False。

--oauth-enable-refresh-tokens

実際のアクセストークンが古くなった場合に、サイレント再認証コードを有効にします。デフォルト:False。

--oauth-enable-single-use-refresh-tokens

シングルユース・更新・トークンのセマンティクスにオプトインするかどうか。デフォルト:False。

--client-store-temporary-credential

仮認証情報を保存します。

--format [TABLE|JSON| JSON_EXT|CSV]

出力形式を指定します。デフォルト: TABLE

--verbose, -v

ログレベル info 以上のログエントリを表示します。デフォルト: false。

--debug

ログレベル debug 以上のログ エントリを表示します。デバッグログには追加情報が含まれます。デフォルト: false。

--silent

コンソールへの中間出力をオフにします。デフォルト: false。

--enhanced-exit-codes

終了エラーコードをエラーのタイプによって区別します。デフォルト: false。

--decimal-precision INTEGER

10進数に表示する小数位の桁数。指定がない場合は、Pythonのデフォルト精度を使用します。 [env var: SNOWFLAKE_DECIMAL_PRECISION] 。

--help

このコマンドのヘルプテキストを表示します。

使用上の注意¶

:codenowrap:`snow dcm plan`コマンドは|dcm-object|オブジェクトを検証し、:codenowrap:`deploy`コマンドが実行された場合に何が起こるかをシミュレートして、計算された変更セットを結果として出力します。このコマンドを実行しても、Snowflakeオブジェクトは作成、変更、またはドロップされません。

計画の結果をローカルの:file:out/plan.json`ファイルに保存するには、:codenowrap:--save-output`オプションを使用します。

例¶

• マニフェストの:codenowrap:`default_target`プロパティで識別されるターゲットにプロジェクト名が指定されている場合、デフォルトオプションを使用して|dcm-object|オブジェクトを計画します。

  CopyExpand

  snow dcm plan
  

  Show lessSee more

  Scroll to top

• マニフェストの:codenowrap:`DEV`ターゲットにプロジェクト名が指定されている場合、|dcm-object|プロジェクトを計画します。

  CopyExpand

  snow dcm plan --target DEV
  

  Show lessSee more

  Scroll to top

• 明示的な完全修飾名を使用して|dcm-object|オブジェクトを計画します。

  CopyExpand

  snow dcm plan MY_DB.MY_SCHEMA.MY_PROJECT
  

  Show lessSee more

  Scroll to top

• マニフェストの:codenowrap:`DEV`ターゲットにプロジェクト名が指定されている場合、ローカルファイルを使用して|dcm-object|プロジェクトを計画し、:codenowrap:`db_name`変数の値を設定して、デプロイメントエイリアスを:codenowrap:`v3`に設定します。

  CopyExpand

  snow dcm plan --target DEV --variable db_name=jdoe --alias v3
  

  Show lessSee more

  Scroll to top

• |dcm-object|オブジェクトを計画し、計画の出力をローカルに保存します。

  CopyExpand

  snow dcm plan --save-output
  

  Show lessSee more

  Scroll to top