Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 2.17 KB

catalog.md

File metadata and controls

50 lines (37 loc) · 2.17 KB
Raw
subcategory
Unity Catalog

databricks_catalog Resource

Within a metastore, Unity Catalog provides a 3-level namespace for organizing data: Catalogs, Databases (also called Schemas), and Tables / Views.

A databricks_catalog is contained within databricks_metastore and can contain databricks_schema. By default, Databricks creates default schema for every new catalog, but Terraform plugin is removing this auto-created schema, so that resource destruction could be done in a clean way.

Example Usage

resource "databricks_catalog" "sandbox" {
  metastore_id = databricks_metastore.this.id
  name         = "sandbox"
  comment      = "this catalog is managed by terraform"
  properties = {
    purpose = "testing"
  }
}

Argument Reference

The following arguments are required:

  • name - Name of Catalog relative to parent metastore. Change forces creation of a new resource.
  • storage_root - (Optional) Managed location of the catalog. Location in cloud storage where data for managed tables will be stored. If not specified, the location will default to the metastore root location. Change forces creation of a new resource.
  • provider_name - (Optional) For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
  • share_name - (Optional) For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
  • owner - (Optional) Username/groupname/sp application_id of the catalog owner.
  • comment - (Optional) User-supplied free-form text.
  • properties - (Optional) Extensible Catalog properties.
  • force_destroy - (Optional) Delete catalog regardless of its contents.

Import

This resource can be imported by name:

terraform import databricks_catalog.this <name>

Related Resources

The following resources are used in the same context: