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

databricks.SqlTable

Explore with Pulumi AI

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

    Within a metastore, Unity Catalog provides a 3-level namespace for organizing data: Catalogs, databases (also called schemas), and tables / views.

    A databricks.SqlTable is contained within databricks_schema, and can represent either a managed table, an external table or a view.

    This resource creates and updates the Unity Catalog table/view by executing the necessary SQL queries on a special auto-terminating cluster it would create for this operation. You could also specify a SQL warehouse or cluster for the queries to be executed on.

    Use an Identity Column

    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",
    },
});
const things = new databricks.Schema("things", {
    catalogName: sandbox.id,
    name: "things",
    comment: "this database is managed by terraform",
    properties: {
        kind: "various",
    },
});
const thing = new databricks.SqlTable("thing", {
    name: "quickstart_table",
    catalogName: sandbox.name,
    schemaName: things.name,
    tableType: "MANAGED",
    dataSourceFormat: "DELTA",
    storageLocation: "",
    columns: [
        {
            name: "id",
            type: "bigint",
            identity: "default",
        },
        {
            name: "name",
            type: "string",
            comment: "name of thing",
        },
    ],
    comment: "this table is managed by terraform",
});

    import pulumi
import pulumi_databricks as databricks

sandbox = databricks.Catalog("sandbox",
    name="sandbox",
    comment="this catalog is managed by terraform",
    properties={
        "purpose": "testing",
    })
things = databricks.Schema("things",
    catalog_name=sandbox.id,
    name="things",
    comment="this database is managed by terraform",
    properties={
        "kind": "various",
    })
thing = databricks.SqlTable("thing",
    name="quickstart_table",
    catalog_name=sandbox.name,
    schema_name=things.name,
    table_type="MANAGED",
    data_source_format="DELTA",
    storage_location="",
    columns=[
        {
            "name": "id",
            "type": "bigint",
            "identity": "default",
        },
        {
            "name": "name",
            "type": "string",
            "comment": "name of thing",
        },
    ],
    comment="this table is managed by terraform")

    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{
			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
		}
		things, err := databricks.NewSchema(ctx, "things", &databricks.SchemaArgs{
			CatalogName: sandbox.ID(),
			Name:        pulumi.String("things"),
			Comment:     pulumi.String("this database is managed by terraform"),
			Properties: pulumi.StringMap{
				"kind": pulumi.String("various"),
			},
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewSqlTable(ctx, "thing", &databricks.SqlTableArgs{
			Name:             pulumi.String("quickstart_table"),
			CatalogName:      sandbox.Name,
			SchemaName:       things.Name,
			TableType:        pulumi.String("MANAGED"),
			DataSourceFormat: pulumi.String("DELTA"),
			StorageLocation:  pulumi.String(""),
			Columns: databricks.SqlTableColumnArray{
				&databricks.SqlTableColumnArgs{
					Name:     pulumi.String("id"),
					Type:     pulumi.String("bigint"),
					Identity: pulumi.String("default"),
				},
				&databricks.SqlTableColumnArgs{
					Name:    pulumi.String("name"),
					Type:    pulumi.String("string"),
					Comment: pulumi.String("name of thing"),
				},
			},
			Comment: pulumi.String("this table is managed by terraform"),
		})
		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" },
        },
    });

    var things = new Databricks.Schema("things", new()
    {
        CatalogName = sandbox.Id,
        Name = "things",
        Comment = "this database is managed by terraform",
        Properties = 
        {
            { "kind", "various" },
        },
    });

    var thing = new Databricks.SqlTable("thing", new()
    {
        Name = "quickstart_table",
        CatalogName = sandbox.Name,
        SchemaName = things.Name,
        TableType = "MANAGED",
        DataSourceFormat = "DELTA",
        StorageLocation = "",
        Columns = new[]
        {
            new Databricks.Inputs.SqlTableColumnArgs
            {
                Name = "id",
                Type = "bigint",
                Identity = "default",
            },
            new Databricks.Inputs.SqlTableColumnArgs
            {
                Name = "name",
                Type = "string",
                Comment = "name of thing",
            },
        },
        Comment = "this table is managed by terraform",
    });

});

    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 com.pulumi.databricks.Schema;
import com.pulumi.databricks.SchemaArgs;
import com.pulumi.databricks.SqlTable;
import com.pulumi.databricks.SqlTableArgs;
import com.pulumi.databricks.inputs.SqlTableColumnArgs;
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());

        var things = new Schema("things", SchemaArgs.builder()
            .catalogName(sandbox.id())
            .name("things")
            .comment("this database is managed by terraform")
            .properties(Map.of("kind", "various"))
            .build());

        var thing = new SqlTable("thing", SqlTableArgs.builder()
            .name("quickstart_table")
            .catalogName(sandbox.name())
            .schemaName(things.name())
            .tableType("MANAGED")
            .dataSourceFormat("DELTA")
            .storageLocation("")
            .columns(            
                SqlTableColumnArgs.builder()
                    .name("id")
                    .type("bigint")
                    .identity("default")
                    .build(),
                SqlTableColumnArgs.builder()
                    .name("name")
                    .type("string")
                    .comment("name of thing")
                    .build())
            .comment("this table is managed by terraform")
            .build());

    }
}

    resources:
  sandbox:
    type: databricks:Catalog
    properties:
      name: sandbox
      comment: this catalog is managed by terraform
      properties:
        purpose: testing
  things:
    type: databricks:Schema
    properties:
      catalogName: ${sandbox.id}
      name: things
      comment: this database is managed by terraform
      properties:
        kind: various
  thing:
    type: databricks:SqlTable
    properties:
      name: quickstart_table
      catalogName: ${sandbox.name}
      schemaName: ${things.name}
      tableType: MANAGED
      dataSourceFormat: DELTA
      storageLocation:
      columns:
        - name: id
          type: bigint
          identity: default
        - name: name
          type: string
          comment: name of thing
      comment: this table is managed by terraform

    Create SqlTable Resource

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

    Constructor syntax

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

@overload
def SqlTable(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             catalog_name: Optional[str] = None,
             table_type: Optional[str] = None,
             schema_name: Optional[str] = None,
             owner: Optional[str] = None,
             properties: Optional[Mapping[str, str]] = None,
             data_source_format: Optional[str] = None,
             name: Optional[str] = None,
             options: Optional[Mapping[str, str]] = None,
             columns: Optional[Sequence[SqlTableColumnArgs]] = None,
             partitions: Optional[Sequence[str]] = None,
             comment: Optional[str] = None,
             cluster_keys: Optional[Sequence[str]] = None,
             storage_credential_name: Optional[str] = None,
             storage_location: Optional[str] = None,
             cluster_id: Optional[str] = None,
             view_definition: Optional[str] = None,
             warehouse_id: Optional[str] = None)
    func NewSqlTable(ctx *Context, name string, args SqlTableArgs, opts ...ResourceOption) (*SqlTable, error)
    public SqlTable(string name, SqlTableArgs args, CustomResourceOptions? opts = null)
    public SqlTable(String name, SqlTableArgs args)
public SqlTable(String name, SqlTableArgs args, CustomResourceOptions options)

    type: databricks:SqlTable
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 SqlTableArgs
    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 SqlTableArgs
    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 SqlTableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SqlTableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SqlTableArgs
    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 sqlTableResource = new Databricks.SqlTable("sqlTableResource", new()
{
    CatalogName = "string",
    TableType = "string",
    SchemaName = "string",
    Owner = "string",
    Properties = 
    {
        { "string", "string" },
    },
    DataSourceFormat = "string",
    Name = "string",
    Options = 
    {
        { "string", "string" },
    },
    Columns = new[]
    {
        new Databricks.Inputs.SqlTableColumnArgs
        {
            Name = "string",
            Comment = "string",
            Identity = "string",
            Nullable = false,
            Type = "string",
            TypeJson = "string",
        },
    },
    Partitions = new[]
    {
        "string",
    },
    Comment = "string",
    ClusterKeys = new[]
    {
        "string",
    },
    StorageCredentialName = "string",
    StorageLocation = "string",
    ClusterId = "string",
    ViewDefinition = "string",
    WarehouseId = "string",
});

    example, err := databricks.NewSqlTable(ctx, "sqlTableResource", &databricks.SqlTableArgs{
	CatalogName: pulumi.String("string"),
	TableType:   pulumi.String("string"),
	SchemaName:  pulumi.String("string"),
	Owner:       pulumi.String("string"),
	Properties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DataSourceFormat: pulumi.String("string"),
	Name:             pulumi.String("string"),
	Options: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Columns: databricks.SqlTableColumnArray{
		&databricks.SqlTableColumnArgs{
			Name:     pulumi.String("string"),
			Comment:  pulumi.String("string"),
			Identity: pulumi.String("string"),
			Nullable: pulumi.Bool(false),
			Type:     pulumi.String("string"),
			TypeJson: pulumi.String("string"),
		},
	},
	Partitions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Comment: pulumi.String("string"),
	ClusterKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
	StorageCredentialName: pulumi.String("string"),
	StorageLocation:       pulumi.String("string"),
	ClusterId:             pulumi.String("string"),
	ViewDefinition:        pulumi.String("string"),
	WarehouseId:           pulumi.String("string"),
})

    var sqlTableResource = new SqlTable("sqlTableResource", SqlTableArgs.builder()
    .catalogName("string")
    .tableType("string")
    .schemaName("string")
    .owner("string")
    .properties(Map.of("string", "string"))
    .dataSourceFormat("string")
    .name("string")
    .options(Map.of("string", "string"))
    .columns(SqlTableColumnArgs.builder()
        .name("string")
        .comment("string")
        .identity("string")
        .nullable(false)
        .type("string")
        .typeJson("string")
        .build())
    .partitions("string")
    .comment("string")
    .clusterKeys("string")
    .storageCredentialName("string")
    .storageLocation("string")
    .clusterId("string")
    .viewDefinition("string")
    .warehouseId("string")
    .build());

    sql_table_resource = databricks.SqlTable("sqlTableResource",
    catalog_name="string",
    table_type="string",
    schema_name="string",
    owner="string",
    properties={
        "string": "string",
    },
    data_source_format="string",
    name="string",
    options={
        "string": "string",
    },
    columns=[{
        "name": "string",
        "comment": "string",
        "identity": "string",
        "nullable": False,
        "type": "string",
        "type_json": "string",
    }],
    partitions=["string"],
    comment="string",
    cluster_keys=["string"],
    storage_credential_name="string",
    storage_location="string",
    cluster_id="string",
    view_definition="string",
    warehouse_id="string")

    const sqlTableResource = new databricks.SqlTable("sqlTableResource", {
    catalogName: "string",
    tableType: "string",
    schemaName: "string",
    owner: "string",
    properties: {
        string: "string",
    },
    dataSourceFormat: "string",
    name: "string",
    options: {
        string: "string",
    },
    columns: [{
        name: "string",
        comment: "string",
        identity: "string",
        nullable: false,
        type: "string",
        typeJson: "string",
    }],
    partitions: ["string"],
    comment: "string",
    clusterKeys: ["string"],
    storageCredentialName: "string",
    storageLocation: "string",
    clusterId: "string",
    viewDefinition: "string",
    warehouseId: "string",
});

    type: databricks:SqlTable
properties:
    catalogName: string
    clusterId: string
    clusterKeys:
        - string
    columns:
        - comment: string
          identity: string
          name: string
          nullable: false
          type: string
          typeJson: string
    comment: string
    dataSourceFormat: string
    name: string
    options:
        string: string
    owner: string
    partitions:
        - string
    properties:
        string: string
    schemaName: string
    storageCredentialName: string
    storageLocation: string
    tableType: string
    viewDefinition: string
    warehouseId: string

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

    CatalogName string
    Name of parent catalog. Change forces creation of a new resource.
    SchemaName string
    Name of parent Schema relative to parent Catalog. Change forces creation of a new resource.
    TableType string
    Distinguishes a view vs. managed/external Table. MANAGED, EXTERNAL or VIEW. Change forces creation of a new resource.
    ClusterId string
    ClusterKeys List<string>
    a subset of columns to liquid cluster the table by. Conflicts with partitions.
    Columns List<SqlTableColumn>
    Comment string
    User-supplied free-form text. Changing comment is not currently supported on VIEW table_type.
    DataSourceFormat string
    External tables are supported in multiple data source formats. The string constants identifying these formats are DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. Change forces creation of a new resource. Not supported for MANAGED tables or VIEW.
    Name string
    Name of table relative to parent catalog and schema. Change forces creation of a new resource.
    Options Dictionary<string, string>
    Map of user defined table options. Change forces creation of a new resource.
    Owner string
    Username/groupname/sp application_id of the schema owner.
    Partitions List<string>
    a subset of columns to partition the table by. Change forces creation of a new resource. Conflicts with cluster_keys. Change forces creation of a new resource.
    Properties Dictionary<string, string>
    Map of table properties.
    StorageCredentialName string
    For EXTERNAL Tables only: the name of storage credential to use. Change forces creation of a new resource.
    StorageLocation string
    URL of storage location for Table data (required for EXTERNAL Tables). Not supported for VIEW or MANAGED table_type.
    ViewDefinition string
    SQL text defining the view (for table_type == "VIEW"). Not supported for MANAGED or EXTERNAL table_type.
    WarehouseId string
    All table CRUD operations must be executed on a running cluster or SQL warehouse. If a warehouse_id is specified, that SQL warehouse will be used to execute SQL commands to manage this table. Conflicts with cluster_id.
    CatalogName string
    Name of parent catalog. Change forces creation of a new resource.
    SchemaName string
    Name of parent Schema relative to parent Catalog. Change forces creation of a new resource.
    TableType string
    Distinguishes a view vs. managed/external Table. MANAGED, EXTERNAL or VIEW. Change forces creation of a new resource.
    ClusterId string
    ClusterKeys []string
    a subset of columns to liquid cluster the table by. Conflicts with partitions.
    Columns []SqlTableColumnArgs
    Comment string
    User-supplied free-form text. Changing comment is not currently supported on VIEW table_type.
    DataSourceFormat string
    External tables are supported in multiple data source formats. The string constants identifying these formats are DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. Change forces creation of a new resource. Not supported for MANAGED tables or VIEW.
    Name string
    Name of table relative to parent catalog and schema. Change forces creation of a new resource.
    Options map[string]string
    Map of user defined table options. Change forces creation of a new resource.
    Owner string
    Username/groupname/sp application_id of the schema owner.
    Partitions []string
    a subset of columns to partition the table by. Change forces creation of a new resource. Conflicts with cluster_keys. Change forces creation of a new resource.
    Properties map[string]string
    Map of table properties.
    StorageCredentialName string
    For EXTERNAL Tables only: the name of storage credential to use. Change forces creation of a new resource.
    StorageLocation string
    URL of storage location for Table data (required for EXTERNAL Tables). Not supported for VIEW or MANAGED table_type.
    ViewDefinition string
    SQL text defining the view (for table_type == "VIEW"). Not supported for MANAGED or EXTERNAL table_type.
    WarehouseId string
    All table CRUD operations must be executed on a running cluster or SQL warehouse. If a warehouse_id is specified, that SQL warehouse will be used to execute SQL commands to manage this table. Conflicts with cluster_id.
    catalogName String
    Name of parent catalog. Change forces creation of a new resource.
    schemaName String
    Name of parent Schema relative to parent Catalog. Change forces creation of a new resource.
    tableType String
    Distinguishes a view vs. managed/external Table. MANAGED, EXTERNAL or VIEW. Change forces creation of a new resource.
    clusterId String
    clusterKeys List<String>
    a subset of columns to liquid cluster the table by. Conflicts with partitions.
    columns List<SqlTableColumn>
    comment String
    User-supplied free-form text. Changing comment is not currently supported on VIEW table_type.
    dataSourceFormat String
    External tables are supported in multiple data source formats. The string constants identifying these formats are DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. Change forces creation of a new resource. Not supported for MANAGED tables or VIEW.
    name String
    Name of table relative to parent catalog and schema. Change forces creation of a new resource.
    options Map<String,String>
    Map of user defined table options. Change forces creation of a new resource.
    owner String
    Username/groupname/sp application_id of the schema owner.
    partitions List<String>
    a subset of columns to partition the table by. Change forces creation of a new resource. Conflicts with cluster_keys. Change forces creation of a new resource.
    properties Map<String,String>
    Map of table properties.
    storageCredentialName String
    For EXTERNAL Tables only: the name of storage credential to use. Change forces creation of a new resource.
    storageLocation String
    URL of storage location for Table data (required for EXTERNAL Tables). Not supported for VIEW or MANAGED table_type.
    viewDefinition String
    SQL text defining the view (for table_type == "VIEW"). Not supported for MANAGED or EXTERNAL table_type.
    warehouseId String
    All table CRUD operations must be executed on a running cluster or SQL warehouse. If a warehouse_id is specified, that SQL warehouse will be used to execute SQL commands to manage this table. Conflicts with cluster_id.
    catalogName string
    Name of parent catalog. Change forces creation of a new resource.
    schemaName string
    Name of parent Schema relative to parent Catalog. Change forces creation of a new resource.
    tableType string
    Distinguishes a view vs. managed/external Table. MANAGED, EXTERNAL or VIEW. Change forces creation of a new resource.
    clusterId string
    clusterKeys string[]
    a subset of columns to liquid cluster the table by. Conflicts with partitions.
    columns SqlTableColumn[]
    comment string
    User-supplied free-form text. Changing comment is not currently supported on VIEW table_type.
    dataSourceFormat string
    External tables are supported in multiple data source formats. The string constants identifying these formats are DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. Change forces creation of a new resource. Not supported for MANAGED tables or VIEW.
    name string
    Name of table relative to parent catalog and schema. Change forces creation of a new resource.
    options {[key: string]: string}
    Map of user defined table options. Change forces creation of a new resource.
    owner string
    Username/groupname/sp application_id of the schema owner.
    partitions string[]
    a subset of columns to partition the table by. Change forces creation of a new resource. Conflicts with cluster_keys. Change forces creation of a new resource.
    properties {[key: string]: string}
    Map of table properties.
    storageCredentialName string
    For EXTERNAL Tables only: the name of storage credential to use. Change forces creation of a new resource.
    storageLocation string
    URL of storage location for Table data (required for EXTERNAL Tables). Not supported for VIEW or MANAGED table_type.
    viewDefinition string
    SQL text defining the view (for table_type == "VIEW"). Not supported for MANAGED or EXTERNAL table_type.
    warehouseId string
    All table CRUD operations must be executed on a running cluster or SQL warehouse. If a warehouse_id is specified, that SQL warehouse will be used to execute SQL commands to manage this table. Conflicts with cluster_id.
    catalog_name str
    Name of parent catalog. Change forces creation of a new resource.
    schema_name str
    Name of parent Schema relative to parent Catalog. Change forces creation of a new resource.
    table_type str
    Distinguishes a view vs. managed/external Table. MANAGED, EXTERNAL or VIEW. Change forces creation of a new resource.
    cluster_id str
    cluster_keys Sequence[str]
    a subset of columns to liquid cluster the table by. Conflicts with partitions.
    columns Sequence[SqlTableColumnArgs]
    comment str
    User-supplied free-form text. Changing comment is not currently supported on VIEW table_type.
    data_source_format str
    External tables are supported in multiple data source formats. The string constants identifying these formats are DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. Change forces creation of a new resource. Not supported for MANAGED tables or VIEW.
    name str
    Name of table relative to parent catalog and schema. Change forces creation of a new resource.
    options Mapping[str, str]
    Map of user defined table options. Change forces creation of a new resource.
    owner str
    Username/groupname/sp application_id of the schema owner.
    partitions Sequence[str]
    a subset of columns to partition the table by. Change forces creation of a new resource. Conflicts with cluster_keys. Change forces creation of a new resource.
    properties Mapping[str, str]
    Map of table properties.
    storage_credential_name str
    For EXTERNAL Tables only: the name of storage credential to use. Change forces creation of a new resource.
    storage_location str
    URL of storage location for Table data (required for EXTERNAL Tables). Not supported for VIEW or MANAGED table_type.
    view_definition str
    SQL text defining the view (for table_type == "VIEW"). Not supported for MANAGED or EXTERNAL table_type.
    warehouse_id str
    All table CRUD operations must be executed on a running cluster or SQL warehouse. If a warehouse_id is specified, that SQL warehouse will be used to execute SQL commands to manage this table. Conflicts with cluster_id.
    catalogName String
    Name of parent catalog. Change forces creation of a new resource.
    schemaName String
    Name of parent Schema relative to parent Catalog. Change forces creation of a new resource.
    tableType String
    Distinguishes a view vs. managed/external Table. MANAGED, EXTERNAL or VIEW. Change forces creation of a new resource.
    clusterId String
    clusterKeys List<String>
    a subset of columns to liquid cluster the table by. Conflicts with partitions.
    columns List<Property Map>
    comment String
    User-supplied free-form text. Changing comment is not currently supported on VIEW table_type.
    dataSourceFormat String
    External tables are supported in multiple data source formats. The string constants identifying these formats are DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. Change forces creation of a new resource. Not supported for MANAGED tables or VIEW.
    name String
    Name of table relative to parent catalog and schema. Change forces creation of a new resource.
    options Map<String>
    Map of user defined table options. Change forces creation of a new resource.
    owner String
    Username/groupname/sp application_id of the schema owner.
    partitions List<String>
    a subset of columns to partition the table by. Change forces creation of a new resource. Conflicts with cluster_keys. Change forces creation of a new resource.
    properties Map<String>
    Map of table properties.
    storageCredentialName String
    For EXTERNAL Tables only: the name of storage credential to use. Change forces creation of a new resource.
    storageLocation String
    URL of storage location for Table data (required for EXTERNAL Tables). Not supported for VIEW or MANAGED table_type.
    viewDefinition String
    SQL text defining the view (for table_type == "VIEW"). Not supported for MANAGED or EXTERNAL table_type.
    warehouseId String
    All table CRUD operations must be executed on a running cluster or SQL warehouse. If a warehouse_id is specified, that SQL warehouse will be used to execute SQL commands to manage this table. Conflicts with cluster_id.

    Outputs

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

    EffectiveProperties Dictionary<string, string>
    Id string
    The provider-assigned unique ID for this managed resource.
    EffectiveProperties map[string]string
    Id string
    The provider-assigned unique ID for this managed resource.
    effectiveProperties Map<String,String>
    id String
    The provider-assigned unique ID for this managed resource.
    effectiveProperties {[key: string]: string}
    id string
    The provider-assigned unique ID for this managed resource.
    effective_properties Mapping[str, str]
    id str
    The provider-assigned unique ID for this managed resource.
    effectiveProperties Map<String>
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SqlTable Resource

    Get an existing SqlTable 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?: SqlTableState, opts?: CustomResourceOptions): SqlTable
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        catalog_name: Optional[str] = None,
        cluster_id: Optional[str] = None,
        cluster_keys: Optional[Sequence[str]] = None,
        columns: Optional[Sequence[SqlTableColumnArgs]] = None,
        comment: Optional[str] = None,
        data_source_format: Optional[str] = None,
        effective_properties: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        options: Optional[Mapping[str, str]] = None,
        owner: Optional[str] = None,
        partitions: Optional[Sequence[str]] = None,
        properties: Optional[Mapping[str, str]] = None,
        schema_name: Optional[str] = None,
        storage_credential_name: Optional[str] = None,
        storage_location: Optional[str] = None,
        table_type: Optional[str] = None,
        view_definition: Optional[str] = None,
        warehouse_id: Optional[str] = None) -> SqlTable
    func GetSqlTable(ctx *Context, name string, id IDInput, state *SqlTableState, opts ...ResourceOption) (*SqlTable, error)
    public static SqlTable Get(string name, Input<string> id, SqlTableState? state, CustomResourceOptions? opts = null)
    public static SqlTable get(String name, Output<String> id, SqlTableState 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:
    CatalogName string
    Name of parent catalog. Change forces creation of a new resource.
    ClusterId string
    ClusterKeys List<string>
    a subset of columns to liquid cluster the table by. Conflicts with partitions.
    Columns List<SqlTableColumn>
    Comment string
    User-supplied free-form text. Changing comment is not currently supported on VIEW table_type.
    DataSourceFormat string
    External tables are supported in multiple data source formats. The string constants identifying these formats are DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. Change forces creation of a new resource. Not supported for MANAGED tables or VIEW.
    EffectiveProperties Dictionary<string, string>
    Name string
    Name of table relative to parent catalog and schema. Change forces creation of a new resource.
    Options Dictionary<string, string>
    Map of user defined table options. Change forces creation of a new resource.
    Owner string
    Username/groupname/sp application_id of the schema owner.
    Partitions List<string>
    a subset of columns to partition the table by. Change forces creation of a new resource. Conflicts with cluster_keys. Change forces creation of a new resource.
    Properties Dictionary<string, string>
    Map of table properties.
    SchemaName string
    Name of parent Schema relative to parent Catalog. Change forces creation of a new resource.
    StorageCredentialName string
    For EXTERNAL Tables only: the name of storage credential to use. Change forces creation of a new resource.
    StorageLocation string
    URL of storage location for Table data (required for EXTERNAL Tables). Not supported for VIEW or MANAGED table_type.
    TableType string
    Distinguishes a view vs. managed/external Table. MANAGED, EXTERNAL or VIEW. Change forces creation of a new resource.
    ViewDefinition string
    SQL text defining the view (for table_type == "VIEW"). Not supported for MANAGED or EXTERNAL table_type.
    WarehouseId string
    All table CRUD operations must be executed on a running cluster or SQL warehouse. If a warehouse_id is specified, that SQL warehouse will be used to execute SQL commands to manage this table. Conflicts with cluster_id.
    CatalogName string
    Name of parent catalog. Change forces creation of a new resource.
    ClusterId string
    ClusterKeys []string
    a subset of columns to liquid cluster the table by. Conflicts with partitions.
    Columns []SqlTableColumnArgs
    Comment string
    User-supplied free-form text. Changing comment is not currently supported on VIEW table_type.
    DataSourceFormat string
    External tables are supported in multiple data source formats. The string constants identifying these formats are DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. Change forces creation of a new resource. Not supported for MANAGED tables or VIEW.
    EffectiveProperties map[string]string
    Name string
    Name of table relative to parent catalog and schema. Change forces creation of a new resource.
    Options map[string]string
    Map of user defined table options. Change forces creation of a new resource.
    Owner string
    Username/groupname/sp application_id of the schema owner.
    Partitions []string
    a subset of columns to partition the table by. Change forces creation of a new resource. Conflicts with cluster_keys. Change forces creation of a new resource.
    Properties map[string]string
    Map of table properties.
    SchemaName string
    Name of parent Schema relative to parent Catalog. Change forces creation of a new resource.
    StorageCredentialName string
    For EXTERNAL Tables only: the name of storage credential to use. Change forces creation of a new resource.
    StorageLocation string
    URL of storage location for Table data (required for EXTERNAL Tables). Not supported for VIEW or MANAGED table_type.
    TableType string
    Distinguishes a view vs. managed/external Table. MANAGED, EXTERNAL or VIEW. Change forces creation of a new resource.
    ViewDefinition string
    SQL text defining the view (for table_type == "VIEW"). Not supported for MANAGED or EXTERNAL table_type.
    WarehouseId string
    All table CRUD operations must be executed on a running cluster or SQL warehouse. If a warehouse_id is specified, that SQL warehouse will be used to execute SQL commands to manage this table. Conflicts with cluster_id.
    catalogName String
    Name of parent catalog. Change forces creation of a new resource.
    clusterId String
    clusterKeys List<String>
    a subset of columns to liquid cluster the table by. Conflicts with partitions.
    columns List<SqlTableColumn>
    comment String
    User-supplied free-form text. Changing comment is not currently supported on VIEW table_type.
    dataSourceFormat String
    External tables are supported in multiple data source formats. The string constants identifying these formats are DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. Change forces creation of a new resource. Not supported for MANAGED tables or VIEW.
    effectiveProperties Map<String,String>
    name String
    Name of table relative to parent catalog and schema. Change forces creation of a new resource.
    options Map<String,String>
    Map of user defined table options. Change forces creation of a new resource.
    owner String
    Username/groupname/sp application_id of the schema owner.
    partitions List<String>
    a subset of columns to partition the table by. Change forces creation of a new resource. Conflicts with cluster_keys. Change forces creation of a new resource.
    properties Map<String,String>
    Map of table properties.
    schemaName String
    Name of parent Schema relative to parent Catalog. Change forces creation of a new resource.
    storageCredentialName String
    For EXTERNAL Tables only: the name of storage credential to use. Change forces creation of a new resource.
    storageLocation String
    URL of storage location for Table data (required for EXTERNAL Tables). Not supported for VIEW or MANAGED table_type.
    tableType String
    Distinguishes a view vs. managed/external Table. MANAGED, EXTERNAL or VIEW. Change forces creation of a new resource.
    viewDefinition String
    SQL text defining the view (for table_type == "VIEW"). Not supported for MANAGED or EXTERNAL table_type.
    warehouseId String
    All table CRUD operations must be executed on a running cluster or SQL warehouse. If a warehouse_id is specified, that SQL warehouse will be used to execute SQL commands to manage this table. Conflicts with cluster_id.
    catalogName string
    Name of parent catalog. Change forces creation of a new resource.
    clusterId string
    clusterKeys string[]
    a subset of columns to liquid cluster the table by. Conflicts with partitions.
    columns SqlTableColumn[]
    comment string
    User-supplied free-form text. Changing comment is not currently supported on VIEW table_type.
    dataSourceFormat string
    External tables are supported in multiple data source formats. The string constants identifying these formats are DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. Change forces creation of a new resource. Not supported for MANAGED tables or VIEW.
    effectiveProperties {[key: string]: string}
    name string
    Name of table relative to parent catalog and schema. Change forces creation of a new resource.
    options {[key: string]: string}
    Map of user defined table options. Change forces creation of a new resource.
    owner string
    Username/groupname/sp application_id of the schema owner.
    partitions string[]
    a subset of columns to partition the table by. Change forces creation of a new resource. Conflicts with cluster_keys. Change forces creation of a new resource.
    properties {[key: string]: string}
    Map of table properties.
    schemaName string
    Name of parent Schema relative to parent Catalog. Change forces creation of a new resource.
    storageCredentialName string
    For EXTERNAL Tables only: the name of storage credential to use. Change forces creation of a new resource.
    storageLocation string
    URL of storage location for Table data (required for EXTERNAL Tables). Not supported for VIEW or MANAGED table_type.
    tableType string
    Distinguishes a view vs. managed/external Table. MANAGED, EXTERNAL or VIEW. Change forces creation of a new resource.
    viewDefinition string
    SQL text defining the view (for table_type == "VIEW"). Not supported for MANAGED or EXTERNAL table_type.
    warehouseId string
    All table CRUD operations must be executed on a running cluster or SQL warehouse. If a warehouse_id is specified, that SQL warehouse will be used to execute SQL commands to manage this table. Conflicts with cluster_id.
    catalog_name str
    Name of parent catalog. Change forces creation of a new resource.
    cluster_id str
    cluster_keys Sequence[str]
    a subset of columns to liquid cluster the table by. Conflicts with partitions.
    columns Sequence[SqlTableColumnArgs]
    comment str
    User-supplied free-form text. Changing comment is not currently supported on VIEW table_type.
    data_source_format str
    External tables are supported in multiple data source formats. The string constants identifying these formats are DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. Change forces creation of a new resource. Not supported for MANAGED tables or VIEW.
    effective_properties Mapping[str, str]
    name str
    Name of table relative to parent catalog and schema. Change forces creation of a new resource.
    options Mapping[str, str]
    Map of user defined table options. Change forces creation of a new resource.
    owner str
    Username/groupname/sp application_id of the schema owner.
    partitions Sequence[str]
    a subset of columns to partition the table by. Change forces creation of a new resource. Conflicts with cluster_keys. Change forces creation of a new resource.
    properties Mapping[str, str]
    Map of table properties.
    schema_name str
    Name of parent Schema relative to parent Catalog. Change forces creation of a new resource.
    storage_credential_name str
    For EXTERNAL Tables only: the name of storage credential to use. Change forces creation of a new resource.
    storage_location str
    URL of storage location for Table data (required for EXTERNAL Tables). Not supported for VIEW or MANAGED table_type.
    table_type str
    Distinguishes a view vs. managed/external Table. MANAGED, EXTERNAL or VIEW. Change forces creation of a new resource.
    view_definition str
    SQL text defining the view (for table_type == "VIEW"). Not supported for MANAGED or EXTERNAL table_type.
    warehouse_id str
    All table CRUD operations must be executed on a running cluster or SQL warehouse. If a warehouse_id is specified, that SQL warehouse will be used to execute SQL commands to manage this table. Conflicts with cluster_id.
    catalogName String
    Name of parent catalog. Change forces creation of a new resource.
    clusterId String
    clusterKeys List<String>
    a subset of columns to liquid cluster the table by. Conflicts with partitions.
    columns List<Property Map>
    comment String
    User-supplied free-form text. Changing comment is not currently supported on VIEW table_type.
    dataSourceFormat String
    External tables are supported in multiple data source formats. The string constants identifying these formats are DELTA, CSV, JSON, AVRO, PARQUET, ORC, TEXT. Change forces creation of a new resource. Not supported for MANAGED tables or VIEW.
    effectiveProperties Map<String>
    name String
    Name of table relative to parent catalog and schema. Change forces creation of a new resource.
    options Map<String>
    Map of user defined table options. Change forces creation of a new resource.
    owner String
    Username/groupname/sp application_id of the schema owner.
    partitions List<String>
    a subset of columns to partition the table by. Change forces creation of a new resource. Conflicts with cluster_keys. Change forces creation of a new resource.
    properties Map<String>
    Map of table properties.
    schemaName String
    Name of parent Schema relative to parent Catalog. Change forces creation of a new resource.
    storageCredentialName String
    For EXTERNAL Tables only: the name of storage credential to use. Change forces creation of a new resource.
    storageLocation String
    URL of storage location for Table data (required for EXTERNAL Tables). Not supported for VIEW or MANAGED table_type.
    tableType String
    Distinguishes a view vs. managed/external Table. MANAGED, EXTERNAL or VIEW. Change forces creation of a new resource.
    viewDefinition String
    SQL text defining the view (for table_type == "VIEW"). Not supported for MANAGED or EXTERNAL table_type.
    warehouseId String
    All table CRUD operations must be executed on a running cluster or SQL warehouse. If a warehouse_id is specified, that SQL warehouse will be used to execute SQL commands to manage this table. Conflicts with cluster_id.

    Supporting Types

    SqlTableColumn, SqlTableColumnArgs

    Name string
    User-visible name of column
    Comment string
    User-supplied free-form text.
    Identity string
    Whether field is an identity column. Can be default, always or unset. It is unset by default.
    Nullable bool
    Whether field is nullable (Default: true)
    Type string
    Column type spec (with metadata) as SQL text. Not supported for VIEW table_type.
    TypeJson string
    Name string
    User-visible name of column
    Comment string
    User-supplied free-form text.
    Identity string
    Whether field is an identity column. Can be default, always or unset. It is unset by default.
    Nullable bool
    Whether field is nullable (Default: true)
    Type string
    Column type spec (with metadata) as SQL text. Not supported for VIEW table_type.
    TypeJson string
    name String
    User-visible name of column
    comment String
    User-supplied free-form text.
    identity String
    Whether field is an identity column. Can be default, always or unset. It is unset by default.
    nullable Boolean
    Whether field is nullable (Default: true)
    type String
    Column type spec (with metadata) as SQL text. Not supported for VIEW table_type.
    typeJson String
    name string
    User-visible name of column
    comment string
    User-supplied free-form text.
    identity string
    Whether field is an identity column. Can be default, always or unset. It is unset by default.
    nullable boolean
    Whether field is nullable (Default: true)
    type string
    Column type spec (with metadata) as SQL text. Not supported for VIEW table_type.
    typeJson string
    name str
    User-visible name of column
    comment str
    User-supplied free-form text.
    identity str
    Whether field is an identity column. Can be default, always or unset. It is unset by default.
    nullable bool
    Whether field is nullable (Default: true)
    type str
    Column type spec (with metadata) as SQL text. Not supported for VIEW table_type.
    type_json str
    name String
    User-visible name of column
    comment String
    User-supplied free-form text.
    identity String
    Whether field is an identity column. Can be default, always or unset. It is unset by default.
    nullable Boolean
    Whether field is nullable (Default: true)
    type String
    Column type spec (with metadata) as SQL text. Not supported for VIEW table_type.
    typeJson String

    Import

    This resource can be imported by its full name:

    bash

    $ pulumi import databricks:index/sqlTable:SqlTable this <catalog_name>.<schema_name>.<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