Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks
  3. API Docs
  4. Catalog
Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-databricks

databricks.Catalog

Explore with Pulumi AI

databricks logo
Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi
pulumi/pulumi-databricks

    This resource can only be used with a workspace-level provider!

    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 Pulumi plugin is removing this auto-created schema, so that resource destruction could be done in a clean way.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const sandbox = new databricks.Catalog("sandbox", {
    name: "sandbox",
    comment: "this catalog is managed by terraform",
    properties: {
        purpose: "testing",
    },
});

    import pulumi
import pulumi_databricks as databricks

sandbox = databricks.Catalog("sandbox",
    name="sandbox",
    comment="this catalog is managed by terraform",
    properties={
        "purpose": "testing",
    })

    package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databricks.NewCatalog(ctx, "sandbox", &databricks.CatalogArgs{
			Name:    pulumi.String("sandbox"),
			Comment: pulumi.String("this catalog is managed by terraform"),
			Properties: pulumi.StringMap{
				"purpose": pulumi.String("testing"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var sandbox = new Databricks.Catalog("sandbox", new()
    {
        Name = "sandbox",
        Comment = "this catalog is managed by terraform",
        Properties = 
        {
            { "purpose", "testing" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.Catalog;
import com.pulumi.databricks.CatalogArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var sandbox = new Catalog("sandbox", CatalogArgs.builder()
            .name("sandbox")
            .comment("this catalog is managed by terraform")
            .properties(Map.of("purpose", "testing"))
            .build());

    }
}

    resources:
  sandbox:
    type: databricks:Catalog
    properties:
      name: sandbox
      comment: this catalog is managed by terraform
      properties:
        purpose: testing

    The following resources are used in the same context:

    • databricks.getTables data to list tables within Unity Catalog.
    • databricks.getSchemas data to list schemas within Unity Catalog.
    • databricks.getCatalogs data to list catalogs within Unity Catalog.

    Create Catalog Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Catalog(name: string, args?: CatalogArgs, opts?: CustomResourceOptions);
    @overload
def Catalog(resource_name: str,
            args: Optional[CatalogArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Catalog(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            comment: Optional[str] = None,
            connection_name: Optional[str] = None,
            enable_predictive_optimization: Optional[str] = None,
            force_destroy: Optional[bool] = None,
            isolation_mode: Optional[str] = None,
            metastore_id: Optional[str] = None,
            name: Optional[str] = None,
            options: Optional[Mapping[str, str]] = None,
            owner: Optional[str] = None,
            properties: Optional[Mapping[str, str]] = None,
            provider_name: Optional[str] = None,
            share_name: Optional[str] = None,
            storage_root: Optional[str] = None)
    func NewCatalog(ctx *Context, name string, args *CatalogArgs, opts ...ResourceOption) (*Catalog, error)
    public Catalog(string name, CatalogArgs? args = null, CustomResourceOptions? opts = null)
    public Catalog(String name, CatalogArgs args)
public Catalog(String name, CatalogArgs args, CustomResourceOptions options)

    type: databricks:Catalog
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CatalogArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CatalogArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CatalogArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CatalogArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var catalogResource = new Databricks.Catalog("catalogResource", new()
{
    Comment = "string",
    ConnectionName = "string",
    EnablePredictiveOptimization = "string",
    ForceDestroy = false,
    IsolationMode = "string",
    MetastoreId = "string",
    Name = "string",
    Options = 
    {
        { "string", "string" },
    },
    Owner = "string",
    Properties = 
    {
        { "string", "string" },
    },
    ProviderName = "string",
    ShareName = "string",
    StorageRoot = "string",
});

    example, err := databricks.NewCatalog(ctx, "catalogResource", &databricks.CatalogArgs{
	Comment:                      pulumi.String("string"),
	ConnectionName:               pulumi.String("string"),
	EnablePredictiveOptimization: pulumi.String("string"),
	ForceDestroy:                 pulumi.Bool(false),
	IsolationMode:                pulumi.String("string"),
	MetastoreId:                  pulumi.String("string"),
	Name:                         pulumi.String("string"),
	Options: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Owner: pulumi.String("string"),
	Properties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ProviderName: pulumi.String("string"),
	ShareName:    pulumi.String("string"),
	StorageRoot:  pulumi.String("string"),
})

    var catalogResource = new Catalog("catalogResource", CatalogArgs.builder()
    .comment("string")
    .connectionName("string")
    .enablePredictiveOptimization("string")
    .forceDestroy(false)
    .isolationMode("string")
    .metastoreId("string")
    .name("string")
    .options(Map.of("string", "string"))
    .owner("string")
    .properties(Map.of("string", "string"))
    .providerName("string")
    .shareName("string")
    .storageRoot("string")
    .build());

    catalog_resource = databricks.Catalog("catalogResource",
    comment="string",
    connection_name="string",
    enable_predictive_optimization="string",
    force_destroy=False,
    isolation_mode="string",
    metastore_id="string",
    name="string",
    options={
        "string": "string",
    },
    owner="string",
    properties={
        "string": "string",
    },
    provider_name="string",
    share_name="string",
    storage_root="string")

    const catalogResource = new databricks.Catalog("catalogResource", {
    comment: "string",
    connectionName: "string",
    enablePredictiveOptimization: "string",
    forceDestroy: false,
    isolationMode: "string",
    metastoreId: "string",
    name: "string",
    options: {
        string: "string",
    },
    owner: "string",
    properties: {
        string: "string",
    },
    providerName: "string",
    shareName: "string",
    storageRoot: "string",
});

    type: databricks:Catalog
properties:
    comment: string
    connectionName: string
    enablePredictiveOptimization: string
    forceDestroy: false
    isolationMode: string
    metastoreId: string
    name: string
    options:
        string: string
    owner: string
    properties:
        string: string
    providerName: string
    shareName: string
    storageRoot: string

    Catalog Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Catalog resource accepts the following input properties:

    Comment string
    User-supplied free-form text.
    ConnectionName string
    For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.
    EnablePredictiveOptimization string
    Whether predictive optimization should be enabled for this object and objects under it. Can be ENABLE, DISABLE or INHERIT
    ForceDestroy bool
    Delete catalog regardless of its contents.
    IsolationMode string
    Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be ISOLATED or OPEN. Setting the catalog to ISOLATED will automatically allow access from the current workspace.
    MetastoreId string
    ID of the parent metastore.
    Name string
    Name of Catalog relative to parent metastore.
    Options Dictionary<string, string>
    For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
    Owner string
    Username/groupname/sp application_id of the catalog owner.
    Properties Dictionary<string, string>
    Extensible Catalog properties.
    ProviderName string
    For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
    ShareName string
    For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
    StorageRoot string
    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.
    Comment string
    User-supplied free-form text.
    ConnectionName string
    For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.
    EnablePredictiveOptimization string
    Whether predictive optimization should be enabled for this object and objects under it. Can be ENABLE, DISABLE or INHERIT
    ForceDestroy bool
    Delete catalog regardless of its contents.
    IsolationMode string
    Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be ISOLATED or OPEN. Setting the catalog to ISOLATED will automatically allow access from the current workspace.
    MetastoreId string
    ID of the parent metastore.
    Name string
    Name of Catalog relative to parent metastore.
    Options map[string]string
    For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
    Owner string
    Username/groupname/sp application_id of the catalog owner.
    Properties map[string]string
    Extensible Catalog properties.
    ProviderName string
    For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
    ShareName string
    For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
    StorageRoot string
    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.
    comment String
    User-supplied free-form text.
    connectionName String
    For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.
    enablePredictiveOptimization String
    Whether predictive optimization should be enabled for this object and objects under it. Can be ENABLE, DISABLE or INHERIT
    forceDestroy Boolean
    Delete catalog regardless of its contents.
    isolationMode String
    Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be ISOLATED or OPEN. Setting the catalog to ISOLATED will automatically allow access from the current workspace.
    metastoreId String
    ID of the parent metastore.
    name String
    Name of Catalog relative to parent metastore.
    options Map<String,String>
    For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
    owner String
    Username/groupname/sp application_id of the catalog owner.
    properties Map<String,String>
    Extensible Catalog properties.
    providerName String
    For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
    shareName String
    For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
    storageRoot String
    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.
    comment string
    User-supplied free-form text.
    connectionName string
    For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.
    enablePredictiveOptimization string
    Whether predictive optimization should be enabled for this object and objects under it. Can be ENABLE, DISABLE or INHERIT
    forceDestroy boolean
    Delete catalog regardless of its contents.
    isolationMode string
    Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be ISOLATED or OPEN. Setting the catalog to ISOLATED will automatically allow access from the current workspace.
    metastoreId string
    ID of the parent metastore.
    name string
    Name of Catalog relative to parent metastore.
    options {[key: string]: string}
    For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
    owner string
    Username/groupname/sp application_id of the catalog owner.
    properties {[key: string]: string}
    Extensible Catalog properties.
    providerName string
    For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
    shareName string
    For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
    storageRoot string
    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.
    comment str
    User-supplied free-form text.
    connection_name str
    For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.
    enable_predictive_optimization str
    Whether predictive optimization should be enabled for this object and objects under it. Can be ENABLE, DISABLE or INHERIT
    force_destroy bool
    Delete catalog regardless of its contents.
    isolation_mode str
    Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be ISOLATED or OPEN. Setting the catalog to ISOLATED will automatically allow access from the current workspace.
    metastore_id str
    ID of the parent metastore.
    name str
    Name of Catalog relative to parent metastore.
    options Mapping[str, str]
    For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
    owner str
    Username/groupname/sp application_id of the catalog owner.
    properties Mapping[str, str]
    Extensible Catalog properties.
    provider_name str
    For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
    share_name str
    For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
    storage_root str
    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.
    comment String
    User-supplied free-form text.
    connectionName String
    For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.
    enablePredictiveOptimization String
    Whether predictive optimization should be enabled for this object and objects under it. Can be ENABLE, DISABLE or INHERIT
    forceDestroy Boolean
    Delete catalog regardless of its contents.
    isolationMode String
    Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be ISOLATED or OPEN. Setting the catalog to ISOLATED will automatically allow access from the current workspace.
    metastoreId String
    ID of the parent metastore.
    name String
    Name of Catalog relative to parent metastore.
    options Map<String>
    For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
    owner String
    Username/groupname/sp application_id of the catalog owner.
    properties Map<String>
    Extensible Catalog properties.
    providerName String
    For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
    shareName String
    For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
    storageRoot String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Catalog resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Catalog Resource

    Get an existing Catalog resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CatalogState, opts?: CustomResourceOptions): Catalog
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        connection_name: Optional[str] = None,
        enable_predictive_optimization: Optional[str] = None,
        force_destroy: Optional[bool] = None,
        isolation_mode: Optional[str] = None,
        metastore_id: Optional[str] = None,
        name: Optional[str] = None,
        options: Optional[Mapping[str, str]] = None,
        owner: Optional[str] = None,
        properties: Optional[Mapping[str, str]] = None,
        provider_name: Optional[str] = None,
        share_name: Optional[str] = None,
        storage_root: Optional[str] = None) -> Catalog
    func GetCatalog(ctx *Context, name string, id IDInput, state *CatalogState, opts ...ResourceOption) (*Catalog, error)
    public static Catalog Get(string name, Input<string> id, CatalogState? state, CustomResourceOptions? opts = null)
    public static Catalog get(String name, Output<String> id, CatalogState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Comment string
    User-supplied free-form text.
    ConnectionName string
    For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.
    EnablePredictiveOptimization string
    Whether predictive optimization should be enabled for this object and objects under it. Can be ENABLE, DISABLE or INHERIT
    ForceDestroy bool
    Delete catalog regardless of its contents.
    IsolationMode string
    Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be ISOLATED or OPEN. Setting the catalog to ISOLATED will automatically allow access from the current workspace.
    MetastoreId string
    ID of the parent metastore.
    Name string
    Name of Catalog relative to parent metastore.
    Options Dictionary<string, string>
    For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
    Owner string
    Username/groupname/sp application_id of the catalog owner.
    Properties Dictionary<string, string>
    Extensible Catalog properties.
    ProviderName string
    For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
    ShareName string
    For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
    StorageRoot string
    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.
    Comment string
    User-supplied free-form text.
    ConnectionName string
    For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.
    EnablePredictiveOptimization string
    Whether predictive optimization should be enabled for this object and objects under it. Can be ENABLE, DISABLE or INHERIT
    ForceDestroy bool
    Delete catalog regardless of its contents.
    IsolationMode string
    Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be ISOLATED or OPEN. Setting the catalog to ISOLATED will automatically allow access from the current workspace.
    MetastoreId string
    ID of the parent metastore.
    Name string
    Name of Catalog relative to parent metastore.
    Options map[string]string
    For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
    Owner string
    Username/groupname/sp application_id of the catalog owner.
    Properties map[string]string
    Extensible Catalog properties.
    ProviderName string
    For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
    ShareName string
    For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
    StorageRoot string
    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.
    comment String
    User-supplied free-form text.
    connectionName String
    For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.
    enablePredictiveOptimization String
    Whether predictive optimization should be enabled for this object and objects under it. Can be ENABLE, DISABLE or INHERIT
    forceDestroy Boolean
    Delete catalog regardless of its contents.
    isolationMode String
    Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be ISOLATED or OPEN. Setting the catalog to ISOLATED will automatically allow access from the current workspace.
    metastoreId String
    ID of the parent metastore.
    name String
    Name of Catalog relative to parent metastore.
    options Map<String,String>
    For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
    owner String
    Username/groupname/sp application_id of the catalog owner.
    properties Map<String,String>
    Extensible Catalog properties.
    providerName String
    For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
    shareName String
    For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
    storageRoot String
    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.
    comment string
    User-supplied free-form text.
    connectionName string
    For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.
    enablePredictiveOptimization string
    Whether predictive optimization should be enabled for this object and objects under it. Can be ENABLE, DISABLE or INHERIT
    forceDestroy boolean
    Delete catalog regardless of its contents.
    isolationMode string
    Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be ISOLATED or OPEN. Setting the catalog to ISOLATED will automatically allow access from the current workspace.
    metastoreId string
    ID of the parent metastore.
    name string
    Name of Catalog relative to parent metastore.
    options {[key: string]: string}
    For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
    owner string
    Username/groupname/sp application_id of the catalog owner.
    properties {[key: string]: string}
    Extensible Catalog properties.
    providerName string
    For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
    shareName string
    For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
    storageRoot string
    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.
    comment str
    User-supplied free-form text.
    connection_name str
    For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.
    enable_predictive_optimization str
    Whether predictive optimization should be enabled for this object and objects under it. Can be ENABLE, DISABLE or INHERIT
    force_destroy bool
    Delete catalog regardless of its contents.
    isolation_mode str
    Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be ISOLATED or OPEN. Setting the catalog to ISOLATED will automatically allow access from the current workspace.
    metastore_id str
    ID of the parent metastore.
    name str
    Name of Catalog relative to parent metastore.
    options Mapping[str, str]
    For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
    owner str
    Username/groupname/sp application_id of the catalog owner.
    properties Mapping[str, str]
    Extensible Catalog properties.
    provider_name str
    For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
    share_name str
    For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
    storage_root str
    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.
    comment String
    User-supplied free-form text.
    connectionName String
    For Foreign Catalogs: the name of the connection to an external data source. Changes forces creation of a new resource.
    enablePredictiveOptimization String
    Whether predictive optimization should be enabled for this object and objects under it. Can be ENABLE, DISABLE or INHERIT
    forceDestroy Boolean
    Delete catalog regardless of its contents.
    isolationMode String
    Whether the catalog is accessible from all workspaces or a specific set of workspaces. Can be ISOLATED or OPEN. Setting the catalog to ISOLATED will automatically allow access from the current workspace.
    metastoreId String
    ID of the parent metastore.
    name String
    Name of Catalog relative to parent metastore.
    options Map<String>
    For Foreign Catalogs: the name of the entity from an external data source that maps to a catalog. For example, the database name in a PostgreSQL server.
    owner String
    Username/groupname/sp application_id of the catalog owner.
    properties Map<String>
    Extensible Catalog properties.
    providerName String
    For Delta Sharing Catalogs: the name of the delta sharing provider. Change forces creation of a new resource.
    shareName String
    For Delta Sharing Catalogs: the name of the share under the share provider. Change forces creation of a new resource.
    storageRoot String
    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.

    Import

    This resource can be imported by name:

    bash

    $ pulumi import databricks:index/catalog:Catalog this <name>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi
    pulumi/pulumi-databricks