|dcm|の展開と管理¶

インターフェースツール¶

|dcm|には次のインターフェースオプションがあります。

Git統合¶

|dcm-object|定義ファイルが保存されているGitリポジトリに接続します。

予算のロールと権限¶

|dcm-object|オブジェクトを作成するユーザーのロールには、次のロールと権限が必要です。

• CREATE DCM PROJECT ON SCHEMA権限。

  CopyExpand

  GRANT CREATE DCM PROJECT ON SCHEMA <schema_name> TO ROLE <role_name>;
  

  Show lessSee more

  Scroll to top

DCM project の作成¶

次のオプションのいずれかを使用して|dcm-object|オブジェクトを作成します。

CREATE [OR REPLACE] DCM PROJECT [IF NOT EXISTS] <my_project>
[COMMENT = 'my comment'];

snow dcm create <my_project> --if-not-exists

snow dcm create <my_project> --if-not-exists

snow dcm create # uses the name specified in the default target from the manifest

snow dcm create --target # uses the named target from the manifest

DCM管理のオブジェクトの所有権¶

|dcm-object|をデプロイするロールは、デフォルトで、デプロイされたすべてのオブジェクトに対するOWNERSHIP権限を有しています。

プロジェクト定義には、他のロールへのGRANT OWNERSHIPステートメントを含めることができます。Snowflakeは、|dcm-object|所有者ロールが、保持する別の下位レベルのロールに対してのみDCM管理オブジェクトの所有権を付与することをお勧めします。その後、プロジェクト所有者ロールが新しいオブジェクト所有者ロールの権限を「継承する」ため、プロジェクトはこのオブジェクトを引き続き管理できます。

|dcm-object|所有者ロールが、自身が保持しない別のロールにDCM管理オブジェクトの所有権を付与すると、プロジェクト所有者ロールのオブジェクトに対する所有権はなくなります。それで、プロジェクトからこのデプロイされたオブジェクトを管理することはできなくなります。それ以降のデプロイは失敗します。この場合、オブジェクト定義をプロジェクトから削除するか、所有権をプロジェクト所有者ロールに戻す必要があります。

既存のオブジェクトを|dcm-object|の管理下に移行する場合、|dcm-object|オブジェクトを所有するロールには、|dcm-object|によって管理されるオブジェクトに対する所有権限（直接または他のロールを通じて継承）も必要になります。

PLAN コマンドを実行します¶

PLANコマンドは、入力として次の情報を受け取ります。

• マニフェストファイルへのパス

  CLIはマニフェストからターゲットを読み取ります（default_target``または--target``フラグ）。SQLコマンドの場合は、マニフェストファイルへのパスとプロジェクト名を指定する必要があります。

• Jinja変数の定義値（オプション）。

• ターゲットの``templating_config``は自動的に構成プロファイルを選択します。SQLコマンドの場合、プロファイルを指定するにはUSING CONFIGURATION句を使用します。

• 上書きする構成プロファイルの1つまたは複数の値（オプション）。

以下は、PLANコマンドの実行方法の例です。

Snowflake CLISnowsightSQL

ローカルのIDEターミナルで、またはGitワークフローの一部として、:code:`snow dcm plan`コマンドを実行します。

ローカルディレクトリからDCMプロジェクトを計画するCLIコマンドの例は次のとおりです。

CopyExpand

cd ./Quickstarts/DCM_Project_Quickstart_1/
snow dcm plan

Show lessSee more

Scroll to top

SnowflakeステージまたはGitリポジトリクローンからDCMプロジェクトを計画するCLIコマンドの例は次のとおりです。

CopyExpand

snow dcm plan --target PROD_US --save-output

Show lessSee more

Scroll to top

オプションの引数を使用してDCMプロジェクトを計画するCLIコマンドの例は次のとおりです。

CopyExpand

snow dcm plan
--variable "wh_size='MEDIUM'" --variable "teams = ['TEAM_A', 'TEAM_B']"
--save-output

Show lessSee more

Scroll to top

変数は二重引用符で囲む必要があり、文字列値には追加の一重引用符が必要です。値のリストには角括弧が必要です。

定義ファイルパス¶

マニフェストファイルと定義ファイルの場所を参照する場合、次のオプションがあります。

• ワークスペースパスから

  Snowsightユーザーインターフェースは、現在のワークスペース内にあるすべての|dcm-object|定義を自動的に一覧表示します。これらのパスのいずれかを選択すると、ワークスペースによりそれが使用され、DCMコマンドが実行されます。

  ワークスペースで手動によりSQLコマンドを実行する場合、任意のワークスペース内の同じパスを参照することもできます。

  ヒント：ワークスペース内にあるすべてのファイルの背後にあるスリードットメニューを使用すると、そのファイルへのフルパスをSQLコードにコピーできます。

  ワークスペースパスからDCMプロジェクトを計画するSQLコマンドの例は次のとおりです。

  CopyExpand

  EXECUTE DCM PROJECT DCM_PROJECT_DEV
    PLAN
    USING CONFIGURATION DEV
  FROM
    'snow://workspace/USER$.PUBLIC.DEFAULT$/versions/live/Quickstarts/DCM_Project_Quickstart_1'
  

  Show lessSee more

  Scroll to top

• ディスク上のローカルGitリポジトリクローンから

  ローカルのIDEでCLIコマンドを実行する前に、``manifest.yml``ファイルを含むディレクトリを選択します。または、使用するマニフェストと定義を含む別のローカルディレクトリを指定することもできます。

  ローカルGitリポジトリの現在のディレクトリから|dcm-object|を計画するCLIコマンドの例は次のとおりです。

  CopyExpand

  cd ./Quickstarts/DCM_Project_Quickstart_1/
  
  snow dcm plan
  
  snow dcm plan --target PROD
  

  Show lessSee more

  Scroll to top

  ローカルGitリポジトリクローンの別のディレクトリから|dcm-object|を計画するCLIコマンドの例は次のとおりです。

  CopyExpand

  snow dcm plan DCM_PROJECT_DEV --configuration DEV --from ./Quickstarts/DCM_Project_Quickstart_2/
  

  Show lessSee more

  Scroll to top

• ワークフロー内のリモートリポジトリから

  同じCLI構文は、DCMコマンドがCI/CDワークフローで実行される場合に使用できます。

  ローカルGitリポジトリクローンから|dcm-object|を計画するCI/CDワークフローの例は次のとおりです。

  CopyExpand

  steps:
    - name: Clone Repo
      uses: actions/checkout@v4
    - name: Setup SnowCLI
      uses: snowflakedb/snowflake-cli-action@v2.0
    - name: Run PLAN
      run: |
        cd ./Quickstarts/DCM_Project_Quickstart_1/
        snow dcm plan --target PROD --save-output
  

  Show lessSee more

  Scroll to top

• Snowflake内のステージまたはGitリポジトリクローンから

  DCMコマンドを実行するプロシージャまたはタスクをSnowflake内で実行する場合、このSQLコマンドは、アカウント内のSnowflakeステージまたはGitリポジトリクローンへの絶対パスを参照できます。

  Gitリポジトリクローンの場合は、最新バージョンを利用するために、まずALTER GIT REPOSITORY FETCHの実行を検討してください。

  ``'@...'``パスは、DCM SQLコマンドを実行する場合にのみ使用できます。

  SnowflakeのステージまたはGitリポジトリクローンからDCMプロジェクトを計画するSQLコマンドの例は次のとおりです。

  CopyExpand

  EXECUTE DCM PROJECT DCM_PROJECT_DEV
    PLAN
    USING CONFIGURATION DEV
  FROM
    '@DCM_DEMO.DEPLOY.DCM_DEMO/branches/main/Quickstarts/DCM_Project_Quickstart_1/'
  

  Show lessSee more

  Scroll to top

計画の出力¶

標準計画の出力には、計画の実行に関する次の情報がJSON形式で含まれます。

version: 2
metadata:
  timestamp: <timestamp>
  query_id: <query_id>
  project_name: <project_name>
  user: <user>
  role_name: <role_name>
  command: <command>
  changes:
    - kind: <kind>
        "attribute_name": <attribute_name>,
        "value": <value>
        "changes": [
          {
            "kind": <kind>,
            "attribute_name": <attribute_name>,
            "value": <value>
          }
        ]
      }
    ]
  }
}

プラン出力の例を次に示します。

{
  "version": 2,
  "metadata": {
    "timestamp": <timestamp>,
    "query_id": <query_id>,
    "project_name": <project_name>,
    "user": <user>,
    "role_name": <role_name>,
    "command": <command>
  },
  "changeset": [
    {
      "type": "CREATE",
      "object_id": {
        "domain": "TABLE",
        "name": "CUSTOMER_SUMMARY",
        "fqn": "MY_DB.ANALYTICS.CUSTOMER_SUMMARY",
        "database": "MY_DB",
        "schema": "ANALYTICS"
      },
      "changes": [
        {
          "kind": "set",
          "attribute_name": "warehouse_size",
          "value": "XSMALL"
        },
        {
          "kind": "set",
          "attribute_name": "query",
          "value": "SELECT customer_id, SUM(amount) AS total FROM orders GROUP BY customer_id"
        }
      ]
    },
    {
      "type": "ALTER",
      "object_id": {
        "domain": "DYNAMIC_TABLE",
        "name": "ORDER_DETAILS",
        "fqn": "MY_DB.ANALYTICS.ORDER_DETAILS",
        "database": "MY_DB",
        "schema": "ANALYTICS"
      },
      "changes": [
        {
          "kind": "changed",
          "attribute_name": "warehouse_size",
          "value": "SMALL",
          "prev_value": "XSMALL"
        },
        {
          "kind": "collection",
          "collection_name": "columns",
          "id_label": "name",
          "changes": [
            {
              "kind": "added",
              "item_id": "DISCOUNT_AMOUNT",
              "changes": [
                {
                  "kind": "set",
                  "attribute_name": "data_type",
                  "value": "NUMBER(10,2)"
                }
              ]
            },
            {
              "kind": "modified",
              "item_id": "ORDER_STATUS",
              "changes": [
                {
                  "kind": "changed",
                  "attribute_name": "data_type",
                  "value": "VARCHAR(50)",
                  "prev_value": "VARCHAR(20)"
                }
              ]
            },
            {
              "kind": "removed",
              "item_id": "LEGACY_FLAG"
            }
          ]
        }
      ]
    },
    {
      "type": "DROP",
      "object_id": {
        "domain": "VIEW",
        "name": "OLD_REPORT_VIEW",
        "fqn": "MY_DB.ANALYTICS.OLD_REPORT_VIEW",
        "database": "MY_DB",
        "schema": "ANALYTICS"
      },
      "changes": []
    }
  ]
}

DEPLOY コマンドを実行します¶

DEPLOYコマンドを実行するには、次の入力を指定します。

• マニフェストファイルへのパス。

• マニフェストで構成プロファイルが定義されている場合は、構成プロファイル名を指定する必要があります。

• デフォルト値を上書きする構成プロファイルの値（オプション）。

• デプロイ*エイリアス*（オプション）。

以下は、DEPLOYコマンドの実行方法の例です。

EXECUTE DCM PROJECT DCM_DEMO.PROJECTS.DCM_PROJECT_DEV
  DEPLOY
FROM
  'snow://workspace/USER$.PUBLIC.DEFAULT$/versions/live/Quickstarts/DCM_Project_Quickstart_1';

EXECUTE DCM PROJECT DCM_DEMO.PROJECTS.DCM_PROJECT_DEV
  DEPLOY AS "testing 2 teams"
  USING CONFIGURATION DEV (wh_size => 'MEDIUM', teams => ['TEAM_A', 'TEAM_B'])
FROM
  'snow://workspace/USER$.PUBLIC.DEFAULT$/versions/live/Quickstarts/DCM_Project_Quickstart_1';

cd ./Quickstarts/DCM_Project_Quickstart_1/
snow dcm deploy DCM_DEMO.PROJECTS.DCM_PROJECT_DEV

snow dcm deploy --target PROD_US

snow dcm deploy DCM_DEMO.PROJECTS.DCM_PROJECT_DEV \
--configuration DEV \
--variable "wh_size='MEDIUM'" --variable "teams = ['TEAM_A', 'TEAM_B']" \
--alias 'testing 2 teams'

標準計画の出力構造については、:ref:`label-dcm_projects_plan_deploy_output`を参照してください。

|dcm-object|が管理するすべてのオブジェクトを表示¶

:doc:`/sql-reference/sql/show-entities-in-dcm-project`コマンドを使用すると、特定の|dcm-object|によって現在管理されているすべてのSnowflakeオブジェクトのリストを表示できます。すべてのオブジェクトに関する完全修飾名のリストを提供します。結果を表示するには、|dcm-object|に対するREAD権限と、管理対象オブジェクト自体を表示する権限の両方が必要です。

:code:`LIKE`を使用して名前で検索するか、フロー演算子を使用して結果セットに対し追加の処理やフィルタリングを実行できます。

同様に、このプロジェクトで定義およびデプロイされた権限について、SHOW GRANTSおよびSHOW FUTURE GRANTSを実行できます。

現在|dcm-object|によって管理されているすべてのオブジェクトを表示する例は次のとおりです。

SHOW ENTITIES LIKE '%DASHBOARD%' IN DCM PROJECT DCM_DEMO.PROJECTS.DCM_PROJECT_DEV;

SHOW ENTITIES IN DCM PROJECT DCM_DEMO.PROJECTS.DCM_PROJECT_DEV
  ->> SELECT * FROM $1 WHERE "object_type" = 'DYNAMIC_TABLE';

SHOW [FUTURE] GRANTS IN DCM PROJECT DCM_DEMO.PROJECTS.DCM_PROJECT_DEV;

|dcm-object|からのオブジェクトの切り離し¶

UNSET DCM PROJECT句とともに:doc:`/sql-reference/sql/alter`コマンドを使用すると、デプロイ済みで、現在|dcm-object|によって管理されているオブジェクトを切り離すことができます。このコマンドは、オブジェクトをドロップせずにオブジェクトと|dcm-object|の関連付けを削除します。別の|dcm-object|でオブジェクトの管理を開始する場合に、このコマンドを使用できます。

再度デプロイする前に、:ref:`プロジェクト定義ファイル<label-dcm_projects_definition_files>`から対応するDEFINEステートメントを必ず削除してください。そうでない場合、オブジェクトは|dcm-object|に再統合されます。

|dcm-object|からオブジェクトを切り離すSQLコマンドの例は次のとおりです。

ALTER TABLE MY_DB.MY_SCH.MY_TABLE
  UNSET DCM PROJECT;

デプロイ済みの権限付与や期待値は、DCMプロジェクトから切り離すことはできません。

|dcm-object|のドロップ¶

|dcm-object|オブジェクトがドロップされた場合、管理対象のすべてのエンティティ、権限付与、および期待値は「管理対象外」としてそのまま残ります。

DROP DCM PROJECT [IF EXISTS] <my_project>;

snow dcm drop my_project

CI/CDベストプラクティス¶

CI/CDパイプラインを使用してデプロイメントを自動化する場合は、次のプラクティスに従ってください。

• 本番以外の環境をターゲットとする|dcm-object|は、誤って本番環境にデプロイされるのを避けるため、本番環境に対応するオブジェクトとは異なるロールにより、所有されている必要があります。

• 本番環境をターゲットとする|dcm-object|は、プロジェクト内のすべてのオブジェクトをデプロイできる特別に調整されたアクセス権限を持つ、本番デプロイ専用のロールにより、所有されている必要があります。

  • |dcm-object|の所有権向けに、一般的な管理者ロールを使用しないでください。そのようなロールはサービスユーザーにのみ付与し、個々の開発者には付与しないでください。

  • 個々の開発者ではなく、サービスユーザーにのみ専用の本番デプロイロールを付与します。

  • 重要なインフラやデータ製品の不変性を確保するため、所有権を本番デプロイロールに制限します。

    専用の本番デプロイロールが本番オブジェクトの所有権を他のロールに付与した場合、それらのロールを付与されたユーザーは本番オブジェクトを変更またはドロップできます。

GitHubアクションの例¶

このセクションでは、|dcm|の典型的なCI/CDパターンを説明する、サンプルGitHubアクションワークフローを提供します。Azure DevOps、GitLab CI/CD、Bitbucket Pipelinesなどの他のGitベースのプラットフォームにも同じ概念が適用されます。ワークフローの構文のみが異なります。

各サンプルは、パイプラインのセットアップ、環境トポロジ、組織要件に基づいてカスタマイズし、組み合わせることができるビルドブロックを提供します。

サンプルワークフローは、任意のDCM CI/CDセットアップに適用可能な次のパターンを示しています。

• **マニフェスト駆動型の構成**各ワークフローは、マニフェストターゲットから``account_identifier``、project_owner、および``project_name``を読み取ります。これにより、環境構成を1か所に保持し、GitHubシークレット間での重複を防ぐことができます。

• **データドロップ保護**デプロイワークフローは、データベース、スキーマ、テーブル、ステージなど、データを保持するオブジェクトに対する破壊的なDROP操作について、``plan_result.json``を解析し、見つかった場合はデプロイをブロックします。

• **ステージから本番環境への順次昇格**実稼働へのデプロイは、ステージングのデプロイが成功し、動的テーブルが更新され、データ品質テストに合格した後にのみ開始されます。

• **構造化プラン出力の解析**ワークフローは``jq``を使用して``plan_result.json``から操作数とオブジェクトドメインを抽出し、カスタムの要約とチェックを簡単にビルドできるようにします。

• **AIを利用した要約**``snow cortex complete``は、GitHubアクションジョブの概要として、post-hookスクリプトの結果と動的テーブルの更新出力の自然言語による要約を生成します。

これらのサンプルワークフローを実行する前に、次の前提条件を完了してください。

• |dcm-object|ファイルをGitリポジトリに保存します。

• ユーザーにGitHubアクションを作成および実行する権限を付与します。

• Snowflakeサービスユーザーの認証情報（SNOWFLAKE_USER、SNOWFLAKE_PASSWORD、または個人アクセストークン）用のGitHubシークレットを構成します。

• |dcm-object|フォルダーへのパス（DCM_PROJECT_PATH）用のGitHub変数を構成します。

• 各マニフェストターゲット（DCM_STAGE、``DCM_PROD_US``など）のGitHub環境を構成します。

GitHubアクションでのSnowflake接続の設定については、ブログ投稿、`GitHubアクションCI/CD実践ガイド<https://medium.com/@uche.nkadi/automate-your-dbt-project-on-snowflake-a-practical-guide-to-github-actions-ci-cd-a366b6e061e5>`_の前半を参照してください。

|dcm|のCI/CDライフサイクル全体をカバーする一連のGitHubアクションワークフローについては、`snowflake-labs DCMリポジトリ<https://github.com/Snowflake-Labs/snowflake_dcm_projects/GitHub_workflows>`_を参照してください。

すべてのサンプルワークフローは、環境固有の構成が重複するGitHubシークレットではなく、バージョン管理された``manifest.yml``内に保持されるように、``yq``を使用してマニフェストターゲットからSnowflake ``account_identifier``および``project_owner``ロールを直接読み取ります。サービスユーザーの認証情報のみがシークレットとして保存されます。