Skip to main content

Create a Databricks View

Create a View within Databricks.

Category: Other

How it works

Run Databricks Notebook '<<NotebookPath>>' to generate the script for CREATE VIEW.

To use this activity within the API, use an ActivityCode of CREATE-VIEW.

Example JSON​

An example of what the Task Config would look like for a task using this activity. Some of these variables would be set at the group level to avoid duplication between tasks.

{
  "NotebookPath": "/Users/fred.nurks@example.com/MyRepo/My Notebook",
  "ViewSchema": "",
  "ViewName": "",
  "NotebookParameters": {
    "Param1": "Value1",
    "Param2": "Value2"
  }
}

Variable Reference​

The following variables are supported:

  • AdditionalNotebooks (Optional) - The path to other notebooks, Python files etc., referenced by the main notebook.

  • DatabricksComputeId (Optional) - The Id of the Databricks compute resource to use to run the Notebook.

  • DatabricksJobClusterSpec (Required) - JSON configuration for the job cluster. See help for examples.

    Show more details

    Job Cluster Spec

    JSON configuration for the ephemeral job cluster. A new cluster is created for each run and terminated on completion.

    Required properties

    • RuntimeVersion — Databricks Runtime version (e.g. "17.3")
    • NodeTypeId or InstancePoolId — one must be specified

    Optional properties

    • NumWorkers — number of worker nodes (omit or set to 0 for single-node)
    • DriverNodeTypeId — override the driver node type
    • DriverInstancePoolId — use a separate pool for the driver node
    • SparkVersionFull — override the full Spark version string (e.g. "17.3.x-gpu-ml-scala2.12")
    • Libraries — additional libraries to install on the cluster

    azure-keyvault-secrets is always installed automatically.

    Example — Standard job cluster

    {
        "RuntimeVersion": "17.3",
        "NodeTypeId": "Standard_DS3_v2",
        "NumWorkers": 4
    }

    Example — Using instance pools

    {
        "RuntimeVersion": "17.3",
        "InstancePoolId": "0101-120000-pool123",
        "NumWorkers": 0,
        "Libraries": [{ "pypi": { "package": "pandas==2.0.0" } }]
    }

  • DatabricksServerlessSpec (Optional) - Optional JSON configuration for serverless job runs. See help for examples.

    Show more details

    Serverless Job Spec

    Optional JSON configuration for serverless job runs. Allows specifying Python dependencies and an explicit environment version for serverless compute. All fields are optional.

    Required properties

    None.

    Optional properties

    • Libraries — list of pip requirement strings to install
    • EnvironmentVersion — Databricks environment version. If omitted, Databricks uses its default.

    Example — With libraries only. Will use the "default" environment

    {
        "Libraries": ["pandas", "numpy>=1.21.0"]
    }

    Example — With libraries and a pinned environment version

    {
        "Libraries": ["pandas==2.0.0"],
        "EnvironmentVersion": "5"
    }

    Notes

    • The spec is only applied to serverless runs (cluster IDs starting with SERVERLESS). It is ignored for existing clusters and job clusters.
    • Libraries map to environments[].spec.dependencies in the Databricks Jobs API.

  • MaximumNumberOfAttemptsAllowed (Optional) - The total number of times the running of this Task can be attempted.

  • MaximumRunTimeHours (Optional) - The maximum number of hours a task run is expected to take. If a run exceeds this duration it will be flagged as stuck.

  • MinutesToWaitBeforeNextAttempt (Optional) - If a Task run fails, the number of minutes to wait before re-attempting the Task.

  • NotebookParameters (Optional) - Parameters for use in the Databricks Notebook. This is JSON format e.g. { "Param1": "Value1", "Param2": "Value2" }.

  • NotebookPath (Required) - The relative path to the Databricks Notebook.

  • ProviderCatalog (Optional) - Only for cross-catalog views. If this view is accessing data in another catalog (the provider catalog), provide the name of the provider catalog here. This is a configuration item which you must specify in Configuration first - it will generally have a different value in each environment.

  • ViewName (Required) - The name of the view.

  • ViewSchema (Required) - The schema that this view resides in.