1. Packages
  2. Databricks
  3. API Docs
  4. Table
Databricks v1.34.0 published on Tuesday, Mar 5, 2024 by Pulumi

databricks.Table

Explore with Pulumi AI

databricks logo
Databricks v1.34.0 published on Tuesday, Mar 5, 2024 by Pulumi

    Create Table Resource

    new Table(name: string, args: TableArgs, opts?: CustomResourceOptions);
    @overload
    def Table(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              catalog_name: Optional[str] = None,
              columns: Optional[Sequence[TableColumnArgs]] = None,
              comment: Optional[str] = None,
              data_source_format: Optional[str] = None,
              name: Optional[str] = None,
              owner: Optional[str] = None,
              properties: Optional[Mapping[str, Any]] = 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)
    @overload
    def Table(resource_name: str,
              args: TableArgs,
              opts: Optional[ResourceOptions] = None)
    func NewTable(ctx *Context, name string, args TableArgs, opts ...ResourceOption) (*Table, error)
    public Table(string name, TableArgs args, CustomResourceOptions? opts = null)
    public Table(String name, TableArgs args)
    public Table(String name, TableArgs args, CustomResourceOptions options)
    
    type: databricks:Table
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args TableArgs
    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 TableArgs
    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 TableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    CatalogName string
    Columns List<TableColumn>
    DataSourceFormat string
    SchemaName string
    TableType string
    Comment string
    Name string
    Owner string
    Properties Dictionary<string, object>
    StorageCredentialName string
    StorageLocation string
    ViewDefinition string

    Outputs

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

    Get an existing Table 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?: TableState, opts?: CustomResourceOptions): Table
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            catalog_name: Optional[str] = None,
            columns: Optional[Sequence[TableColumnArgs]] = None,
            comment: Optional[str] = None,
            data_source_format: Optional[str] = None,
            name: Optional[str] = None,
            owner: Optional[str] = None,
            properties: Optional[Mapping[str, Any]] = 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) -> Table
    func GetTable(ctx *Context, name string, id IDInput, state *TableState, opts ...ResourceOption) (*Table, error)
    public static Table Get(string name, Input<string> id, TableState? state, CustomResourceOptions? opts = null)
    public static Table get(String name, Output<String> id, TableState 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
    Columns List<TableColumn>
    Comment string
    DataSourceFormat string
    Name string
    Owner string
    Properties Dictionary<string, object>
    SchemaName string
    StorageCredentialName string
    StorageLocation string
    TableType string
    ViewDefinition string

    Supporting Types

    TableColumn, TableColumnArgs

    name String
    position Integer
    typeName String
    typeText String
    comment String
    nullable Boolean
    partitionIndex Integer
    typeIntervalType String
    typeJson String
    typePrecision Integer
    typeScale Integer
    name string
    position number
    typeName string
    typeText string
    comment string
    nullable boolean
    partitionIndex number
    typeIntervalType string
    typeJson string
    typePrecision number
    typeScale number
    name String
    position Number
    typeName String
    typeText String
    comment String
    nullable Boolean
    partitionIndex Number
    typeIntervalType String
    typeJson String
    typePrecision Number
    typeScale Number

    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.34.0 published on Tuesday, Mar 5, 2024 by Pulumi