Databricks

Pulumi Official
Package maintained by Pulumi
v0.4.0 published on Wednesday, Apr 20, 2022 by Pulumi

Catalog

The following resources are used in the same context:

  • databricks.Table data to list tables within Unity Catalog.
  • databricks.Schema data to list schemas within Unity Catalog.
  • databricks.Catalog data to list catalogs within Unity Catalog.

Example Usage

using Pulumi;
using Databricks = Pulumi.Databricks;

class MyStack : Stack
{
    public MyStack()
    {
        var sandbox = new Databricks.Catalog("sandbox", new Databricks.CatalogArgs
        {
            MetastoreId = databricks_metastore.This.Id,
            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{
			MetastoreId: pulumi.Any(databricks_metastore.This.Id),
			Comment:     pulumi.String("this catalog is managed by terraform"),
			Properties: pulumi.AnyMap{
				"purpose": pulumi.Any("testing"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_databricks as databricks

sandbox = databricks.Catalog("sandbox",
    metastore_id=databricks_metastore["this"]["id"],
    comment="this catalog is managed by terraform",
    properties={
        "purpose": "testing",
    })
import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

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

Coming soon!

Create a Catalog Resource

new Catalog(name: string, args?: CatalogArgs, opts?: CustomResourceOptions);
@overload
def Catalog(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            comment: Optional[str] = None,
            metastore_id: Optional[str] = None,
            name: Optional[str] = None,
            owner: Optional[str] = None,
            properties: Optional[Mapping[str, Any]] = None)
@overload
def Catalog(resource_name: str,
            args: Optional[CatalogArgs] = None,
            opts: Optional[ResourceOptions] = 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.

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.

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

The Catalog resource accepts the following input properties:

Comment string

User-supplied free-form text.

MetastoreId string
Name string

Name of Catalog relative to parent metastore. Change forces creation of a new resource.

Owner string

Username/groupname of catalog owner. Currently this field can only be changed after the resource is created.

Properties Dictionary<string, object>

Extensible Catalog properties.

Comment string

User-supplied free-form text.

MetastoreId string
Name string

Name of Catalog relative to parent metastore. Change forces creation of a new resource.

Owner string

Username/groupname of catalog owner. Currently this field can only be changed after the resource is created.

Properties map[string]interface{}

Extensible Catalog properties.

comment String

User-supplied free-form text.

metastoreId String
name String

Name of Catalog relative to parent metastore. Change forces creation of a new resource.

owner String

Username/groupname of catalog owner. Currently this field can only be changed after the resource is created.

properties Map<String,Object>

Extensible Catalog properties.

comment string

User-supplied free-form text.

metastoreId string
name string

Name of Catalog relative to parent metastore. Change forces creation of a new resource.

owner string

Username/groupname of catalog owner. Currently this field can only be changed after the resource is created.

properties {[key: string]: any}

Extensible Catalog properties.

comment str

User-supplied free-form text.

metastore_id str
name str

Name of Catalog relative to parent metastore. Change forces creation of a new resource.

owner str

Username/groupname of catalog owner. Currently this field can only be changed after the resource is created.

properties Mapping[str, Any]

Extensible Catalog properties.

comment String

User-supplied free-form text.

metastoreId String
name String

Name of Catalog relative to parent metastore. Change forces creation of a new resource.

owner String

Username/groupname of catalog owner. Currently this field can only be changed after the resource is created.

properties Map<Any>

Extensible Catalog properties.

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 an 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,
        metastore_id: Optional[str] = None,
        name: Optional[str] = None,
        owner: Optional[str] = None,
        properties: Optional[Mapping[str, Any]] = 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.

MetastoreId string
Name string

Name of Catalog relative to parent metastore. Change forces creation of a new resource.

Owner string

Username/groupname of catalog owner. Currently this field can only be changed after the resource is created.

Properties Dictionary<string, object>

Extensible Catalog properties.

Comment string

User-supplied free-form text.

MetastoreId string
Name string

Name of Catalog relative to parent metastore. Change forces creation of a new resource.

Owner string

Username/groupname of catalog owner. Currently this field can only be changed after the resource is created.

Properties map[string]interface{}

Extensible Catalog properties.

comment String

User-supplied free-form text.

metastoreId String
name String

Name of Catalog relative to parent metastore. Change forces creation of a new resource.

owner String

Username/groupname of catalog owner. Currently this field can only be changed after the resource is created.

properties Map<String,Object>

Extensible Catalog properties.

comment string

User-supplied free-form text.

metastoreId string
name string

Name of Catalog relative to parent metastore. Change forces creation of a new resource.

owner string

Username/groupname of catalog owner. Currently this field can only be changed after the resource is created.

properties {[key: string]: any}

Extensible Catalog properties.

comment str

User-supplied free-form text.

metastore_id str
name str

Name of Catalog relative to parent metastore. Change forces creation of a new resource.

owner str

Username/groupname of catalog owner. Currently this field can only be changed after the resource is created.

properties Mapping[str, Any]

Extensible Catalog properties.

comment String

User-supplied free-form text.

metastoreId String
name String

Name of Catalog relative to parent metastore. Change forces creation of a new resource.

owner String

Username/groupname of catalog owner. Currently this field can only be changed after the resource is created.

properties Map<Any>

Extensible Catalog properties.

Import

This resource can be imported by namebash

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

Package Details

Repository
https://github.com/pulumi/pulumi-databricks
License
Apache-2.0
Notes

This Pulumi package is based on the databricks Terraform Provider.