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

databricks.SystemSchema

Explore with Pulumi AI

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

    This feature is in Public Preview.

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

    Manages system tables enablement. System tables are a Databricks-hosted analytical store of your account’s operational data. System tables can be used for historical observability across your account. System tables must be enabled by an account admin.

    Example Usage

    Enable the system schema access

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

const _this = new databricks.SystemSchema("this", {schema: "access"});

    import pulumi
import pulumi_databricks as databricks

this = databricks.SystemSchema("this", schema="access")

    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.NewSystemSchema(ctx, "this", &databricks.SystemSchemaArgs{
			Schema: pulumi.String("access"),
		})
		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 @this = new Databricks.SystemSchema("this", new()
    {
        Schema = "access",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.SystemSchema;
import com.pulumi.databricks.SystemSchemaArgs;
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 this_ = new SystemSchema("this", SystemSchemaArgs.builder()
            .schema("access")
            .build());

    }
}

    resources:
  this:
    type: databricks:SystemSchema
    properties:
      schema: access

    Create SystemSchema Resource

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

    Constructor syntax

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

@overload
def SystemSchema(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 schema: Optional[str] = None,
                 state: Optional[str] = None)
    func NewSystemSchema(ctx *Context, name string, args *SystemSchemaArgs, opts ...ResourceOption) (*SystemSchema, error)
    public SystemSchema(string name, SystemSchemaArgs? args = null, CustomResourceOptions? opts = null)
    public SystemSchema(String name, SystemSchemaArgs args)
public SystemSchema(String name, SystemSchemaArgs args, CustomResourceOptions options)

    type: databricks:SystemSchema
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 SystemSchemaArgs
    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 SystemSchemaArgs
    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 SystemSchemaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SystemSchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SystemSchemaArgs
    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 systemSchemaResource = new Databricks.SystemSchema("systemSchemaResource", new()
{
    Schema = "string",
    State = "string",
});

    example, err := databricks.NewSystemSchema(ctx, "systemSchemaResource", &databricks.SystemSchemaArgs{
	Schema: pulumi.String("string"),
	State:  pulumi.String("string"),
})

    var systemSchemaResource = new SystemSchema("systemSchemaResource", SystemSchemaArgs.builder()
    .schema("string")
    .state("string")
    .build());

    system_schema_resource = databricks.SystemSchema("systemSchemaResource",
    schema="string",
    state="string")

    const systemSchemaResource = new databricks.SystemSchema("systemSchemaResource", {
    schema: "string",
    state: "string",
});

    type: databricks:SystemSchema
properties:
    schema: string
    state: string

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

    Schema string
    name of the system schema.
    State string
    The current state of enablement for the system schema.
    Schema string
    name of the system schema.
    State string
    The current state of enablement for the system schema.
    schema String
    name of the system schema.
    state String
    The current state of enablement for the system schema.
    schema string
    name of the system schema.
    state string
    The current state of enablement for the system schema.
    schema str
    name of the system schema.
    state str
    The current state of enablement for the system schema.
    schema String
    name of the system schema.
    state String
    The current state of enablement for the system schema.

    Outputs

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

    FullName string
    the full name of the system schema, in form of system.<schema>.
    Id string
    The provider-assigned unique ID for this managed resource.
    MetastoreId string
    FullName string
    the full name of the system schema, in form of system.<schema>.
    Id string
    The provider-assigned unique ID for this managed resource.
    MetastoreId string
    fullName String
    the full name of the system schema, in form of system.<schema>.
    id String
    The provider-assigned unique ID for this managed resource.
    metastoreId String
    fullName string
    the full name of the system schema, in form of system.<schema>.
    id string
    The provider-assigned unique ID for this managed resource.
    metastoreId string
    full_name str
    the full name of the system schema, in form of system.<schema>.
    id str
    The provider-assigned unique ID for this managed resource.
    metastore_id str
    fullName String
    the full name of the system schema, in form of system.<schema>.
    id String
    The provider-assigned unique ID for this managed resource.
    metastoreId String

    Look up Existing SystemSchema Resource

    Get an existing SystemSchema 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?: SystemSchemaState, opts?: CustomResourceOptions): SystemSchema
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        full_name: Optional[str] = None,
        metastore_id: Optional[str] = None,
        schema: Optional[str] = None,
        state: Optional[str] = None) -> SystemSchema
    func GetSystemSchema(ctx *Context, name string, id IDInput, state *SystemSchemaState, opts ...ResourceOption) (*SystemSchema, error)
    public static SystemSchema Get(string name, Input<string> id, SystemSchemaState? state, CustomResourceOptions? opts = null)
    public static SystemSchema get(String name, Output<String> id, SystemSchemaState 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:
    FullName string
    the full name of the system schema, in form of system.<schema>.
    MetastoreId string
    Schema string
    name of the system schema.
    State string
    The current state of enablement for the system schema.
    FullName string
    the full name of the system schema, in form of system.<schema>.
    MetastoreId string
    Schema string
    name of the system schema.
    State string
    The current state of enablement for the system schema.
    fullName String
    the full name of the system schema, in form of system.<schema>.
    metastoreId String
    schema String
    name of the system schema.
    state String
    The current state of enablement for the system schema.
    fullName string
    the full name of the system schema, in form of system.<schema>.
    metastoreId string
    schema string
    name of the system schema.
    state string
    The current state of enablement for the system schema.
    full_name str
    the full name of the system schema, in form of system.<schema>.
    metastore_id str
    schema str
    name of the system schema.
    state str
    The current state of enablement for the system schema.
    fullName String
    the full name of the system schema, in form of system.<schema>.
    metastoreId String
    schema String
    name of the system schema.
    state String
    The current state of enablement for the system schema.

    Import

    This resource can be imported by the metastore id and schema name

    bash

    $ pulumi import databricks:index/systemSchema:SystemSchema this '<metastore_id>|<schema_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