1. Packages
  2. Packages
  3. Databricks Provider
  4. API Docs
  5. Schema
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-databricks

databricks.Schema

databricks logo
Viewing docs for Databricks v0.4.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-databricks

    Private Preview This feature is in Private Preview. Contact your Databricks representative to request access.

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

    A databricks.Schema is contained within databricks.Catalog and can contain tables & views.

    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" },
            },
        });
        var things = new Databricks.Schema("things", new Databricks.SchemaArgs
        {
            CatalogName = sandbox.Id,
            Comment = "this database is managed by terraform",
            Properties = 
            {
                { "kind", "various" },
            },
        });
    }

}

    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 {
		sandbox, 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
		}
		_, err = databricks.NewSchema(ctx, "things", &databricks.SchemaArgs{
			CatalogName: sandbox.ID(),
			Comment:     pulumi.String("this database is managed by terraform"),
			Properties: pulumi.AnyMap{
				"kind": pulumi.Any("various"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Example coming soon!

    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",
    },
});
const things = new databricks.Schema("things", {
    catalogName: sandbox.id,
    comment: "this database is managed by terraform",
    properties: {
        kind: "various",
    },
});

    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",
    })
things = databricks.Schema("things",
    catalog_name=sandbox.id,
    comment="this database is managed by terraform",
    properties={
        "kind": "various",
    })

    Example coming soon!

    Create Schema Resource

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

    Constructor syntax

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

@overload
def Schema(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           catalog_name: Optional[str] = None,
           comment: Optional[str] = None,
           metastore_id: Optional[str] = None,
           name: Optional[str] = None,
           owner: Optional[str] = None,
           properties: Optional[Mapping[str, Any]] = None)
    func NewSchema(ctx *Context, name string, args SchemaArgs, opts ...ResourceOption) (*Schema, error)
    public Schema(string name, SchemaArgs args, CustomResourceOptions? opts = null)
    public Schema(String name, SchemaArgs args)
public Schema(String name, SchemaArgs args, CustomResourceOptions options)

    type: databricks:Schema
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 SchemaArgs
    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 SchemaArgs
    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 SchemaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SchemaArgs
    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 schemaResource = new Databricks.Schema("schemaResource", new()
{
    CatalogName = "string",
    Comment = "string",
    MetastoreId = "string",
    Name = "string",
    Owner = "string",
    Properties = 
    {
        { "string", "any" },
    },
});

    example, err := databricks.NewSchema(ctx, "schemaResource", &databricks.SchemaArgs{
	CatalogName: pulumi.String("string"),
	Comment:     pulumi.String("string"),
	MetastoreId: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Owner:       pulumi.String("string"),
	Properties: pulumi.Map{
		"string": pulumi.Any("any"),
	},
})

    var schemaResource = new Schema("schemaResource", SchemaArgs.builder()
    .catalogName("string")
    .comment("string")
    .metastoreId("string")
    .name("string")
    .owner("string")
    .properties(Map.of("string", "any"))
    .build());

    schema_resource = databricks.Schema("schemaResource",
    catalog_name="string",
    comment="string",
    metastore_id="string",
    name="string",
    owner="string",
    properties={
        "string": "any",
    })

    const schemaResource = new databricks.Schema("schemaResource", {
    catalogName: "string",
    comment: "string",
    metastoreId: "string",
    name: "string",
    owner: "string",
    properties: {
        string: "any",
    },
});

    type: databricks:Schema
properties:
    catalogName: string
    comment: string
    metastoreId: string
    name: string
    owner: string
    properties:
        string: any

    Schema 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 Schema resource accepts the following input properties:

    CatalogName string
    Name of parent catalog
    Comment string
    User-supplied free-form text.
    MetastoreId string
    Name string
    Name of Schema relative to parent catalog. Change forces creation of a new resource.
    Owner string
    Username/groupname of schema owner. Currently this field can only be changed after the resource is created.
    Properties Dictionary<string, object>
    Extensible Schema properties.
    CatalogName string
    Name of parent catalog
    Comment string
    User-supplied free-form text.
    MetastoreId string
    Name string
    Name of Schema relative to parent catalog. Change forces creation of a new resource.
    Owner string
    Username/groupname of schema owner. Currently this field can only be changed after the resource is created.
    Properties map[string]interface{}
    Extensible Schema properties.
    catalogName String
    Name of parent catalog
    comment String
    User-supplied free-form text.
    metastoreId String
    name String
    Name of Schema relative to parent catalog. Change forces creation of a new resource.
    owner String
    Username/groupname of schema owner. Currently this field can only be changed after the resource is created.
    properties Map<String,Object>
    Extensible Schema properties.
    catalogName string
    Name of parent catalog
    comment string
    User-supplied free-form text.
    metastoreId string
    name string
    Name of Schema relative to parent catalog. Change forces creation of a new resource.
    owner string
    Username/groupname of schema owner. Currently this field can only be changed after the resource is created.
    properties {[key: string]: any}
    Extensible Schema properties.
    catalog_name str
    Name of parent catalog
    comment str
    User-supplied free-form text.
    metastore_id str
    name str
    Name of Schema relative to parent catalog. Change forces creation of a new resource.
    owner str
    Username/groupname of schema owner. Currently this field can only be changed after the resource is created.
    properties Mapping[str, Any]
    Extensible Schema properties.
    catalogName String
    Name of parent catalog
    comment String
    User-supplied free-form text.
    metastoreId String
    name String
    Name of Schema relative to parent catalog. Change forces creation of a new resource.
    owner String
    Username/groupname of schema owner. Currently this field can only be changed after the resource is created.
    properties Map<Any>
    Extensible Schema properties.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Schema 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 Schema Resource

    Get an existing Schema 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?: SchemaState, opts?: CustomResourceOptions): Schema
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog_name: Optional[str] = None,
        comment: Optional[str] = None,
        metastore_id: Optional[str] = None,
        name: Optional[str] = None,
        owner: Optional[str] = None,
        properties: Optional[Mapping[str, Any]] = None) -> Schema
    func GetSchema(ctx *Context, name string, id IDInput, state *SchemaState, opts ...ResourceOption) (*Schema, error)
    public static Schema Get(string name, Input<string> id, SchemaState? state, CustomResourceOptions? opts = null)
    public static Schema get(String name, Output<String> id, SchemaState state, CustomResourceOptions options)
    resources:  _:    type: databricks:Schema    get:      id: ${id}
    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:
    CatalogName string
    Name of parent catalog
    Comment string
    User-supplied free-form text.
    MetastoreId string
    Name string
    Name of Schema relative to parent catalog. Change forces creation of a new resource.
    Owner string
    Username/groupname of schema owner. Currently this field can only be changed after the resource is created.
    Properties Dictionary<string, object>
    Extensible Schema properties.
    CatalogName string
    Name of parent catalog
    Comment string
    User-supplied free-form text.
    MetastoreId string
    Name string
    Name of Schema relative to parent catalog. Change forces creation of a new resource.
    Owner string
    Username/groupname of schema owner. Currently this field can only be changed after the resource is created.
    Properties map[string]interface{}
    Extensible Schema properties.
    catalogName String
    Name of parent catalog
    comment String
    User-supplied free-form text.
    metastoreId String
    name String
    Name of Schema relative to parent catalog. Change forces creation of a new resource.
    owner String
    Username/groupname of schema owner. Currently this field can only be changed after the resource is created.
    properties Map<String,Object>
    Extensible Schema properties.
    catalogName string
    Name of parent catalog
    comment string
    User-supplied free-form text.
    metastoreId string
    name string
    Name of Schema relative to parent catalog. Change forces creation of a new resource.
    owner string
    Username/groupname of schema owner. Currently this field can only be changed after the resource is created.
    properties {[key: string]: any}
    Extensible Schema properties.
    catalog_name str
    Name of parent catalog
    comment str
    User-supplied free-form text.
    metastore_id str
    name str
    Name of Schema relative to parent catalog. Change forces creation of a new resource.
    owner str
    Username/groupname of schema owner. Currently this field can only be changed after the resource is created.
    properties Mapping[str, Any]
    Extensible Schema properties.
    catalogName String
    Name of parent catalog
    comment String
    User-supplied free-form text.
    metastoreId String
    name String
    Name of Schema relative to parent catalog. Change forces creation of a new resource.
    owner String
    Username/groupname of schema owner. Currently this field can only be changed after the resource is created.
    properties Map<Any>
    Extensible Schema properties.

    Import

    This resource can be imported by namebash

     $ pulumi import databricks:index/schema:Schema 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
    Viewing docs for Databricks v0.4.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-databricks
      Try Pulumi Cloud free. Your team will thank you.