Databricks catalog Terraform module

One Unity Catalog catalog.

Creates one Unity Catalog catalog and, when grants is not empty, one databricks_grants block on it.

Resources

• databricks_catalog.this
• databricks_grants.this[0] (count = 1 only when grants is not empty)

The resource addresses above are part of the DataTF import contract. Do not rename them.

Usage

module "catalog" {
  source  = "536tech/catalog/databricks"
  version = "0.1.0"

  name           = "sales"
  isolation_mode = "ISOLATED"
  owner          = "data-platform"
  comment        = "Sales domain"
  storage_root   = "abfss://sales@lake.dfs.core.windows.net/"

  grants = [{
    principal  = "data-engineers"
    privileges = ["USE_CATALOG", "USE_SCHEMA", "CREATE_SCHEMA"]
  }]
}

Compatibility

Configure the Databricks provider in the calling root with a workspace endpoint. This resource module is also used by the workspace pattern module. Each repository has its own releases. Consumers select an exact tested module version.

The resource addresses match the original workspace submodule in version 0.1.1. To migrate a direct submodule call, change its source and version. Keep the module block name. Run terraform init and require a plan with no resource changes. DataTF exports continue to use the workspace pattern module and its existing import addresses.

Development

Use Terraform 1.7 or later for the mock tests. The module supports Terraform 1.5 or later.

prek install
terraform init -backend=false -lockfile=readonly
terraform validate
terraform test
tflint --recursive
prek run --all-files

CI tests the committed provider version and the minimum supported provider, 1.128.0. The workspace pattern module checks the complete DataTF contract and its integration behavior.

License

Apache-2.0.

Requirements

The following requirements are needed by this module:

• terraform (>= 1.5.0)

• databricks (>= 1.128.0, < 2.0.0)

Providers

The following providers are used by this module:

• databricks (>= 1.128.0, < 2.0.0)

Resources

The following resources are used by this module:

• databricks_catalog.this (resource)
• databricks_grants.this (resource)

Required Inputs

The following input variables are required:

isolation_mode

Description: Catalog isolation mode: OPEN or ISOLATED.

Type: string

name

Description: Catalog name.

Type: string

owner

Description: Catalog owner. A user, group, or service principal.

Type: string

Optional Inputs

The following input variables are optional (have default values):

comment

Description: Catalog description.

Type: string

Default: null

force_destroy

Description: Allow Terraform to delete the catalog while it still contains schemas.

Type: bool

Default: false

grants

Description: Direct catalog grants. A list permits computed service principal application IDs.

Type:

list(object({
    principal  = string
    privileges = list(string)
  }))

Default: []

properties

Description: Catalog properties.

Type: map(string)

Default: null

storage_root

Description: Managed storage location for the catalog. Changing it replaces the catalog.

Type: string

Default: null

Outputs

The following outputs are exported:

id

Description: Catalog id.

name

Description: Catalog name.