Cosmos + dbt Core: 実装チェックリスト

ステップを順番に実行してください。ユーザーの制約を満たす最もシンプルな設定を優先してください。

バージョン注記: このスキルは Cosmos 1.11+ および Airflow 3.x を対象としています。ユーザーが Airflow 2.x を使用している場合は、インポートを適宜調整してください (付録 A を参照)。

参照: 最新の安定版: https://pypi.org/project/astronomer-cosmos/

開始前に確認: (1) dbt エンジン = Core (Fusion ではない → cosmos-dbt-fusion を使用), (2) ウェアハウスタイプ, (3) Airflow バージョン, (4) 実行環境 (Airflow env / venv / container), (5) DbtDag vs DbtTaskGroup vs 個別オペレータ, (6) マニフェストの可用性。

---

1. プロジェクトを設定 (ProjectConfig)

アプローチ	使用する場合	必須パラメータ
プロジェクトパス	ファイルがローカルで利用可能	dbt_project_path
マニフェストのみ	dbt_manifest ロードモード	manifest_path + project_name

from cosmos import ProjectConfig

_project_config = ProjectConfig(
    dbt_project_path="/path/to/dbt/project",
    # manifest_path="/path/to/manifest.json",  # for dbt_manifest load mode
    # project_name="my_project",  # if using manifest_path without dbt_project_path
    # install_dbt_deps=False,  # if deps precomputed in CI
)

2. パース戦略を選択 (RenderConfig)

制約に基づいてロードモードを 1 つ選択してください:

ロードモード	使用する場合	必須入力	制約
dbt_manifest	大規模プロジェクト、コンテナ化実行、最速	ProjectConfig.manifest_path	リモートマニフェストは manifest_conn_id が必要
dbt_ls	複雑なセレクタ、dbt ネイティブ選択が必要	dbt インストール済み OR dbt_executable_path	コンテナ化実行でも使用可能
dbt_ls_file	毎回 dbt_ls を実行せずに dbt_ls 選択	RenderConfig.dbt_ls_path	select/exclude は動作しません
automatic (デフォルト)	シンプルなセットアップ、Cosmos に選択させる	なし	フォールバック: manifest → dbt_ls → custom

重要: コンテナ化実行 (DOCKER/KUBERNETES/等)

from cosmos import RenderConfig, LoadMode

_render_config = RenderConfig(
    load_method=LoadMode.DBT_MANIFEST,  # or DBT_LS, DBT_LS_FILE, AUTOMATIC
)

---

3. 実行モードを選択 (ExecutionConfig)

参照: モードごとの詳細な設定例については reference/cosmos-config.md を参照してください。

実行モードを 1 つ選択してください:

実行モード	使用する場合	速度	必須セットアップ
WATCHER	最速、単一の dbt build 可視性	最速	env の dbt アダプタ OR dbt_executable_path or dbt Fusion
WATCHER_KUBERNETES	最速の分離方法、単一の dbt build 可視性	高速	コンテナにインストールされた dbt
LOCAL + DBT_RUNNER	dbt + アダプタが Airflow と同じ Python インストール内	高速	requirements.txt の dbt 1.5+
LOCAL + SUBPROCESS	dbt + アダプタが Airflow デプロイメント内で利用可能、分離された Python インストール	中速	dbt_executable_path
AIRFLOW_ASYNC	BigQuery + 長時間実行トランスフォーム	高速	Airflow ≥2.8、プロバイダー依存関係
KUBERNETES	Airflow と dbt の間で分離	中速	Airflow ≥2.8、プロバイダー依存関係
VIRTUALENV	イメージを変更できない、ランタイム venv	低速	operator_args の py_requirements
その他のコンテナ化アプローチ	Airflow と dbt の分離をサポート	中速	コンテナ設定

from cosmos import ExecutionConfig, ExecutionMode

_execution_config = ExecutionConfig(
    execution_mode=ExecutionMode.WATCHER,  # or LOCAL, VIRTUALENV, AIRFLOW_ASYNC, KUBERNETES, etc.
)

---

4. ウェアハウス接続を設定 (ProfileConfig)

参照: 詳細な ProfileConfig オプションと全 ProfileMapping クラスについては reference/cosmos-config.md を参照してください。

オプション A: Airflow Connection + ProfileMapping (推奨)

from cosmos import ProfileConfig
from cosmos.profiles import SnowflakeUserPasswordProfileMapping

_profile_config = ProfileConfig(
    profile_name="default",
    target_name="dev",
    profile_mapping=SnowflakeUserPasswordProfileMapping(
        conn_id="snowflake_default",
        profile_args={"schema": "my_schema"},
    ),
)

オプション B: 既存の profiles.yml

重要: シークレットをハードコードしないでください。環境変数を使用してください。

from cosmos import ProfileConfig

_profile_config = ProfileConfig(
    profile_name="my_profile",
    target_name="dev",
    profiles_yml_filepath="/path/to/profiles.yml",
)

---

5. テスト動作を設定 (RenderConfig)

参照: 詳細なテストオプションについては reference/cosmos-config.md を参照してください。

TestBehavior	動作
AFTER_EACH (デフォルト)	テストは各モデル直後に実行 (デフォルト)
BUILD	実行とテストを単一の dbt build に結合
AFTER_ALL	すべてのモデル完了後にすべてのテストを実行
NONE	テストをスキップ

from cosmos import RenderConfig, TestBehavior

_render_config = RenderConfig(
    test_behavior=TestBehavior.AFTER_EACH,
)

---

6. operator_args を設定

参照: 詳細な operator_args オプションについては reference/cosmos-config.md を参照してください。

_operator_args = {
    # BaseOperator パラメータ
    "retries": 3,

    # Cosmos 固有パラメータ
    "install_deps": False,
    "full_refresh": False,
    "quiet": True,

    # ランタイム dbt 変数 (XCom / params)
    "vars": '{"my_var": "{{ ti.xcom_pull(task_ids=\'pre_dbt\') }}"}',
}

---

7. DAG / TaskGroup をアセンブル

オプション A: DbtDag (スタンドアロン)

from cosmos import DbtDag, ProjectConfig, ProfileConfig, ExecutionConfig, RenderConfig
from cosmos.profiles import SnowflakeUserPasswordProfileMapping
from pendulum import datetime

_project_config = ProjectConfig(
    dbt_project_path="/usr/local/airflow/dbt/my_project",
)

_profile_config = ProfileConfig(
    profile_name="default",
    target_name="dev",
    profile_mapping=SnowflakeUserPasswordProfileMapping(
        conn_id="snowflake_default",
    ),
)

_execution_config = ExecutionConfig()
_render_config = RenderConfig()

my_cosmos_dag = DbtDag(
    dag_id="my_cosmos_dag",
    project_config=_project_config,
    profile_config=_profile_config,
    execution_config=_execution_config,
    render_config=_render_config,
    operator_args={},
    start_date=datetime(2025, 1, 1),
    schedule="@daily",
)

オプション B: DbtTaskGroup (既存 DAG 内)

from airflow.sdk import dag, task  # Airflow 3.x
# from airflow.decorators import dag, task  # Airflow 2.x
from airflow.models.baseoperator import chain
from cosmos import DbtTaskGroup, ProjectConfig, ProfileConfig, ExecutionConfig, RenderConfig
from pendulum import datetime

_project_config = ProjectConfig(dbt_project_path="/usr/local/airflow/dbt/my_project")
_profile_config = ProfileConfig(profile_name="default", target_name="dev")
_execution_config = ExecutionConfig()
_render_config = RenderConfig()

@dag(start_date=datetime(2025, 1, 1), schedule="@daily")
def my_dag():
    @task
    def pre_dbt():
        return "some_value"

    dbt = DbtTaskGroup(
        group_id="dbt_project",
        project_config=_project_config,
        profile_config=_profile_config,
        execution_config=_execution_config,
        render_config=_render_config,
    )

    @task
    def post_dbt():
        pass

    chain(pre_dbt(), dbt, post_dbt())

my_dag()

オプション C: Cosmos オペレータを直接使用

import os
from datetime import datetime
from pathlib import Path
from typing import Any

from airflow import DAG

try:
    from airflow.providers.standard.operators.python import PythonOperator
except ImportError:
    from airflow.operators.python import PythonOperator

from cosmos import DbtCloneLocalOperator, DbtRunLocalOperator, DbtSeedLocalOperator, ProfileConfig
from cosmos.io import upload_to_aws_s3

DEFAULT_DBT_ROOT_PATH = Path(__file__).parent / "dbt"
DBT_ROOT_PATH = Path(os.getenv("DBT_ROOT_PATH", DEFAULT_DBT_ROOT_PATH))
DBT_PROJ_DIR = DBT_ROOT_PATH / "jaffle_shop"
DBT_PROFILE_PATH = DBT_PROJ_DIR / "profiles.yml"
DBT_ARTIFACT = DBT_PROJ_DIR / "target"

profile_config = ProfileConfig(
    profile_name="default",
    target_name="dev",
    profiles_yml_filepath=DBT_PROFILE_PATH,
)


def check_s3_file(bucket_name: str, file_key: str, aws_conn_id: str = "aws_default", **context: Any) -> bool:
    """Check if a file exists in the given S3 bucket."""
    from airflow.providers.amazon.aws.hooks.s3 import S3Hook

    s3_key = f"{context['dag'].dag_id}/{context['run_id']}/seed/0/{file_key}"
    print(f"Checking if file {s3_key} exists in S3 bucket...")
    hook = S3Hook(aws_conn_id=aws_conn_id)
    return hook.check_for_key(key=s3_key, bucket_name=bucket_name)


with DAG("example_operators", start_date=datetime(2024, 1, 1), catchup=False) as dag:
    seed_operator = DbtSeedLocalOperator(
        profile_config=profile_config,
        project_dir=DBT_PROJ_DIR,
        task_id="seed",
        dbt_cmd_flags=["--select", "raw_customers"],
        install_deps=True,
        append_env=True,
    )

    check_file_uploaded_task = PythonOperator(
        task_id="check_file_uploaded_task",
        python_callable=check_s3_file,
        op_kwargs={
            "aws_conn_id": "aws_s3_conn",
            "bucket_name": "cosmos-artifacts-upload",
            "file_key": "target/run_results.json",
        },
    )

    run_operator = DbtRunLocalOperator(
        profile_config=profile_config,
        project_dir=DBT_PROJ_DIR,
        task_id="run",
        dbt_cmd_flags=["--models", "stg_customers"],
        install_deps=True,
        append_env=True,
    )

    clone_operator = DbtCloneLocalOperator(
        profile_config=profile_config,
        project_dir=DBT_PROJ_DIR,
        task_id="clone",
        dbt_cmd_flags=["--models", "stg_customers", "--state", DBT_ARTIFACT],
        install_deps=True,
        append_env=True,
    )

    seed_operator >> run_operator >> clone_operator
    seed_operator >> check_file_uploaded_task

個別 Cosmos タスクに依存関係を設定

from cosmos import DbtDag, DbtResourceType
from airflow.sdk import task, chain

with DbtDag(...) as dag:
    @task
    def upstream_task():
        pass

    _upstream = upstream_task()

    for unique_id, dbt_node in dag.dbt_graph.filtered_nodes.items():
        if dbt_node.resource_type == DbtResourceType.SEED:
            my_dbt_task = dag.tasks_map[unique_id]
            chain(_upstream, my_dbt_task)

---

8. 安全性チェック

確定する前に以下を確認してください:

• 実行モードが制約に一致する (AIRFLOW_ASYNC → BigQuery のみ)
• 選択した実行モードに対してウェアハウスアダプタがインストール済み
• Airflow 接続または環境変数経由のシークレット、プレーンテキスト NG
• ロードモードが実行に一致 (複雑なセレクタ → dbt_ls)
• Cosmos アセット上でダウンストリーム DAG がスケジュールされている場合は Airflow 3 アセット URI (付録 A を参照)

---

付録 A: Airflow 3 互換性

インポート上の違い

Airflow 3.x	Airflow 2.x
from airflow.sdk import dag, task	from airflow.decorators import dag, task
from airflow.sdk import chain	from airflow.models.baseoperator import chain

アセット/Dataset URI フォーマット変更

Cosmos ≤1.9 (Airflow 2 Datasets):

postgres://0.0.0.0:5434/postgres.public.orders

Cosmos ≥1.10 (Airflow 3 Assets):

postgres://0.0.0.0:5434/postgres/public/orders

重要: Airflow 3 へのアップグレード時にアセット URI を更新してください。

---

付録 B: 運用上の追加機能

キャッシング

Cosmos はパース速度を上げるためにアーティファクトをキャッシュします。デフォルトで有効。

参照: https://astronomer.github.io/astronomer-cosmos/configuration/caching.html

メモリ最適化インポート

AIRFLOW__COSMOS__ENABLE_MEMORY_OPTIMISED_IMPORTS=True

有効時:

from cosmos.airflow.dag import DbtDag  # instead of: from cosmos import DbtDag

アーティファクトをオブジェクトストレージにアップロード

AIRFLOW__COSMOS__REMOTE_TARGET_PATH=s3://bucket/target_dir/
AIRFLOW__COSMOS__REMOTE_TARGET_PATH_CONN_ID=aws_default

from cosmos.io import upload_to_cloud_storage

my_dag = DbtDag(
    # ...
    operator_args={"callback": upload_to_cloud_storage},
)

dbt ドキュメントホスティング (Airflow 3.1+ / Cosmos 1.11+)

AIRFLOW__COSMOS__DBT_DOCS_PROJECTS='{
    "my_project": {
        "dir": "s3://bucket/docs/",
        "index": "index.html",
        "conn_id": "aws_default",
        "name": "My Project"
    }
}'

参照: https://astronomer.github.io/astronomer-cosmos/configuration/hosting-docs.html

---

関連スキル

• cosmos-dbt-fusion: dbt Fusion プロジェクト向け (dbt Core ではない)
• authoring-dags: 一般的な DAG オーサリングパターン
• testing-dags: 作成後の DAG テスト