バンドルの設定例

この記事では、Databricks Asset Bundles の機能と一般的なバンドルのユースケースの構成例について説明します。

ヒント

この記事の例の一部とその他の例は、 bundle-examples GitHub リポジトリにあります。

サーバレスコンピュートを使用するジョブ

Databricks Asset Bundles は、サーバレスコンピュートで実行されるジョブをサポートします。これを構成するには、ノートブックタスクを含むジョブの clusters 設定を省略するか、次の例に示すように環境を指定できます。 Pythonスクリプト、Python wheel、dbtタスクの場合、サーバレスコンピュートにenvironment_keyが必要です。environment_keyを参照してください。

# A serverless job (no cluster definition)
resources:
  jobs:
    serverless_job_no_cluster:
      name: serverless_job_no_cluster

      email_notifications:
        on_failure:
          - someone@example.com

      tasks:
        - task_key: notebook_task
          notebook_task:
            notebook_path: ../src/notebook.ipynb

# A serverless job (environment spec)
resources:
  jobs:
    serverless_job_environment:
      name: serverless_job_environment

      tasks:
        - task_key: task
          spark_python_task:
            python_file: ../src/main.py

          # The key that references an environment spec in a job.
          # https://docs.databricks.com/api/workspace/jobs/create#tasks-environment_key
          environment_key: default

      # A list of task execution environment specifications that can be referenced by tasks of this job.
      environments:
        - environment_key: default

          # Full documentation of this spec can be found at:
          # https://docs.databricks.com/api/workspace/jobs/create#environments-spec
          spec:
            client: "1"
            dependencies:
              - my-library

サーバレスコンピュートを使用したパイプライン

Databricksアセットバンドルは、サーバレスコンピュート上で実行されるパイプラインをサポートします。これを構成するには、パイプラインのserverless設定をtrueに設定します。次の構成例では、サーバレスコンピュートで実行するパイプラインと、1 時間ごとにパイプラインの更新をトリガーするジョブを定義します。

# A pipeline that runs on serverless compute
resources:
  pipelines:
    my_pipeline:
      name: my_pipeline
      target: ${bundle.environment}
      serverless: true
      catalog: users
      libraries:
        - notebook:
            path: ../src/my_pipeline.ipynb

      configuration:
        bundle.sourcePath: /Workspace/${workspace.file_path}/src

# This defines a job to refresh a pipeline that is triggered every hour
resources:
  jobs:
    my_job:
      name: my_job

      # Run this job once an hour.
      trigger:
        periodic:
          interval: 1
          unit: HOURS

      email_notifications:
        on_failure:
          - someone@example.com

      tasks:
        - task_key: refresh_pipeline
          pipeline_task:
            pipeline_id: ${resources.pipelines.my_pipeline.id}

SQLノートブックを使ったジョブ

次の構成例では、SQL ノートブックを使用してジョブを定義します。

resources:
  jobs:
    job_with_sql_notebook:
      name: "Job to demonstrate using a SQL notebook with a SQL warehouse"
      tasks:
        - task_key: notebook
          notebook_task:
            notebook_path: ./select.sql
            warehouse_id: 799f096837fzzzz4

複数のホイールファイルを持つジョブ

次の構成例では、複数の*.whlファイルを含むジョブを含むバンドルを定義します。

# job.yml
resources:
  jobs:
    example_job:
      name: "Example with multiple wheels"
      tasks:
        - task_key: task

          spark_python_task:
            python_file: ../src/call_wheel.py

          libraries:
            - whl: ../my_custom_wheel1/dist/*.whl
            - whl: ../my_custom_wheel2/dist/*.whl

          new_cluster:
            node_type_id: i3.xlarge
            num_workers: 0
            spark_version: 14.3.x-scala2.12
            spark_conf:
                "spark.databricks.cluster.profile": "singleNode"
                "spark.master": "local[*, 4]"
            custom_tags:
                "ResourceClass": "SingleNode"

# databricks.yml
bundle:
  name: job_with_multiple_wheels

include:
  - ./resources/job.yml

workspace:
  host: https://myworkspace.cloud.databricks.com

artifacts:
  my_custom_wheel1:
    type: whl
    build: poetry build
    path: ./my_custom_wheel1

  my_custom_wheel2:
    type: whl
    build: poetry build
    path: ./my_custom_wheel2

targets:
  dev:
    default: true
    mode: development

requirements.txt ファイルを使用するジョブ

次の構成例では、requirements.txt ファイルを使用するジョブを定義します。

resources:
  jobs:
    job_with_requirements_txt:
      name: "Example job that uses a requirements.txt file"
      tasks:
        - task_key: task
          job_cluster_key: default
          spark_python_task:
            python_file: ../src/main.py
          libraries:
            - requirements: /Workspace/${workspace.file_path}/requirements.txt

スケジュールに応じたジョブ

次の例は、スケジュールに従って実行されるジョブの構成を示しています。ジョブのスケジュールとトリガーに関する情報については、スケジュールとトリガーを使用したジョブの自動化を参照してください。

この設定は、毎日指定した時刻に実行されるジョブを定義します。

resources:
  jobs:
    my-notebook-job:
      name: my-notebook-job
      tasks:
        - task_key: my-notebook-task
          notebook_task:
            notebook_path: ./my-notebook.ipynb
      schedule:
        quartz_cron_expression: "0 0 8 * * ?" # daily at 8am
        timezone_id: UTC
        pause_status: UNPAUSED

この設定では、ジョブが最後に実行されてから 1 週間後にジョブが実行されました。

resources:
  jobs:
    my-notebook-job:
      name: my-notebook-job
      tasks:
        - task_key: my-notebook-task
          notebook_task:
            notebook_path: ./my-notebook.ipynb
      trigger:
        pause_status: UNPAUSED
        periodic:
          interval: 1
          unit: WEEKS

JAR ファイルを Unity Catalog にアップロードするバンドル

Unity Catalogボリュームをアーティファクトパスとして指定して、 JARファイルやホイールファイルなどのすべてのアーティファクトがUnity Catalogボリュームにアップロードされるようにすることができます。次のサンプルバンドルは、JAR ファイルを Unity Catalog にアップロードします。 artifact_pathマッピングの情報については、 artifact_pathを参照してください。

bundle:
  name: jar-bundle

workspace:
  host: https://myworkspace.cloud.databricks.com
  artifact_path: /Volumes/main/default/my_volume

artifacts:
  my_java_code:
    path: ./sample-java
    build: "javac PrintArgs.java && jar cvfm PrintArgs.jar META-INF/MANIFEST.MF PrintArgs.class"
    files:
      - source: ./sample-java/PrintArgs.jar

resources:
  jobs:
    jar_job:
      name: "Spark Jar Job"
      tasks:
        - task_key: SparkJarTask
          new_cluster:
            num_workers: 1
            spark_version: "14.3.x-scala2.12"
            node_type_id: "i3.xlarge"
          spark_jar_task:
            main_class_name: PrintArgs
          libraries:
            - jar: ./sample-java/PrintArgs.jar