Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. Table
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake

snowflake.Table

Explore with Pulumi AI

Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake

Import

format is database name | schema name | table name

$ pulumi import snowflake:index/table:Table example 'databaseName|schemaName|tableName'
Copy

Create Table Resource

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

Constructor syntax

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

@overload
def Table(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          columns: Optional[Sequence[TableColumnArgs]] = None,
          database: Optional[str] = None,
          schema: Optional[str] = None,
          change_tracking: Optional[bool] = None,
          cluster_bies: Optional[Sequence[str]] = None,
          comment: Optional[str] = None,
          data_retention_time_in_days: Optional[int] = None,
          name: Optional[str] = None,
          primary_key: Optional[TablePrimaryKeyArgs] = None,
          tags: Optional[Sequence[TableTagArgs]] = 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: snowflake:Table
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. TableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. TableArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. TableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. TableArgs
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 tableResource = new Snowflake.Table("tableResource", new()
{
    Columns = new[]
    {
        new Snowflake.Inputs.TableColumnArgs
        {
            Name = "string",
            Type = "string",
            Collate = "string",
            Comment = "string",
            Default = new Snowflake.Inputs.TableColumnDefaultArgs
            {
                Constant = "string",
                Expression = "string",
                Sequence = "string",
            },
            Identity = new Snowflake.Inputs.TableColumnIdentityArgs
            {
                StartNum = 0,
                StepNum = 0,
            },
            MaskingPolicy = "string",
            Nullable = false,
            SchemaEvolutionRecord = "string",
        },
    },
    Database = "string",
    Schema = "string",
    ChangeTracking = false,
    ClusterBies = new[]
    {
        "string",
    },
    Comment = "string",
    DataRetentionTimeInDays = 0,
    Name = "string",
});
Copy
example, err := snowflake.NewTable(ctx, "tableResource", &snowflake.TableArgs{
	Columns: snowflake.TableColumnArray{
		&snowflake.TableColumnArgs{
			Name:    pulumi.String("string"),
			Type:    pulumi.String("string"),
			Collate: pulumi.String("string"),
			Comment: pulumi.String("string"),
			Default: &snowflake.TableColumnDefaultArgs{
				Constant:   pulumi.String("string"),
				Expression: pulumi.String("string"),
				Sequence:   pulumi.String("string"),
			},
			Identity: &snowflake.TableColumnIdentityArgs{
				StartNum: pulumi.Int(0),
				StepNum:  pulumi.Int(0),
			},
			MaskingPolicy:         pulumi.String("string"),
			Nullable:              pulumi.Bool(false),
			SchemaEvolutionRecord: pulumi.String("string"),
		},
	},
	Database:       pulumi.String("string"),
	Schema:         pulumi.String("string"),
	ChangeTracking: pulumi.Bool(false),
	ClusterBies: pulumi.StringArray{
		pulumi.String("string"),
	},
	Comment:                 pulumi.String("string"),
	DataRetentionTimeInDays: pulumi.Int(0),
	Name:                    pulumi.String("string"),
})
Copy
var tableResource = new Table("tableResource", TableArgs.builder()
    .columns(TableColumnArgs.builder()
        .name("string")
        .type("string")
        .collate("string")
        .comment("string")
        .default_(TableColumnDefaultArgs.builder()
            .constant("string")
            .expression("string")
            .sequence("string")
            .build())
        .identity(TableColumnIdentityArgs.builder()
            .startNum(0)
            .stepNum(0)
            .build())
        .maskingPolicy("string")
        .nullable(false)
        .schemaEvolutionRecord("string")
        .build())
    .database("string")
    .schema("string")
    .changeTracking(false)
    .clusterBies("string")
    .comment("string")
    .dataRetentionTimeInDays(0)
    .name("string")
    .build());
Copy
table_resource = snowflake.Table("tableResource",
    columns=[{
        "name": "string",
        "type": "string",
        "collate": "string",
        "comment": "string",
        "default": {
            "constant": "string",
            "expression": "string",
            "sequence": "string",
        },
        "identity": {
            "start_num": 0,
            "step_num": 0,
        },
        "masking_policy": "string",
        "nullable": False,
        "schema_evolution_record": "string",
    }],
    database="string",
    schema="string",
    change_tracking=False,
    cluster_bies=["string"],
    comment="string",
    data_retention_time_in_days=0,
    name="string")
Copy
const tableResource = new snowflake.Table("tableResource", {
    columns: [{
        name: "string",
        type: "string",
        collate: "string",
        comment: "string",
        "default": {
            constant: "string",
            expression: "string",
            sequence: "string",
        },
        identity: {
            startNum: 0,
            stepNum: 0,
        },
        maskingPolicy: "string",
        nullable: false,
        schemaEvolutionRecord: "string",
    }],
    database: "string",
    schema: "string",
    changeTracking: false,
    clusterBies: ["string"],
    comment: "string",
    dataRetentionTimeInDays: 0,
    name: "string",
});
Copy
type: snowflake:Table
properties:
    changeTracking: false
    clusterBies:
        - string
    columns:
        - collate: string
          comment: string
          default:
            constant: string
            expression: string
            sequence: string
          identity:
            startNum: 0
            stepNum: 0
          maskingPolicy: string
          name: string
          nullable: false
          schemaEvolutionRecord: string
          type: string
    comment: string
    dataRetentionTimeInDays: 0
    database: string
    name: string
    schema: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Table resource accepts the following input properties:

Columns This property is required. List<TableColumn>
Definitions of a column to create in the table. Minimum one required.
Database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the table.
Schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the table.
ChangeTracking bool
Specifies whether to enable change tracking on the table. Default false.
ClusterBies List<string>
A list of one or more table columns/expressions to be used as clustering key(s) for the table
Comment string
Specifies a comment for the table.
DataRetentionTimeInDays int
Specifies the retention period for the table so that Time Travel actions (SELECT, CLONE, UNDROP) can be performed on historical data in the table. If you wish to inherit the parent schema setting then pass in the schema attribute to this argument or do not fill this parameter at all; the default value for this field is -1, which is a fallback to use Snowflake default - in this case the schema value
Name string
Specifies the identifier for the table; must be unique for the database and schema in which the table is created.
PrimaryKey TablePrimaryKey
Definitions of primary key constraint to create on table

Deprecated: Use snowflake.TableConstraint instead

Tags List<TableTag>
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

Columns This property is required. []TableColumnArgs
Definitions of a column to create in the table. Minimum one required.
Database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the table.
Schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the table.
ChangeTracking bool
Specifies whether to enable change tracking on the table. Default false.
ClusterBies []string
A list of one or more table columns/expressions to be used as clustering key(s) for the table
Comment string
Specifies a comment for the table.
DataRetentionTimeInDays int
Specifies the retention period for the table so that Time Travel actions (SELECT, CLONE, UNDROP) can be performed on historical data in the table. If you wish to inherit the parent schema setting then pass in the schema attribute to this argument or do not fill this parameter at all; the default value for this field is -1, which is a fallback to use Snowflake default - in this case the schema value
Name string
Specifies the identifier for the table; must be unique for the database and schema in which the table is created.
PrimaryKey TablePrimaryKeyArgs
Definitions of primary key constraint to create on table

Deprecated: Use snowflake.TableConstraint instead

Tags []TableTagArgs
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

columns This property is required. List<TableColumn>
Definitions of a column to create in the table. Minimum one required.
database
This property is required.
Changes to this property will trigger replacement.
String
The database in which to create the table.
schema
This property is required.
Changes to this property will trigger replacement.
String
The schema in which to create the table.
changeTracking Boolean
Specifies whether to enable change tracking on the table. Default false.
clusterBies List<String>
A list of one or more table columns/expressions to be used as clustering key(s) for the table
comment String
Specifies a comment for the table.
dataRetentionTimeInDays Integer
Specifies the retention period for the table so that Time Travel actions (SELECT, CLONE, UNDROP) can be performed on historical data in the table. If you wish to inherit the parent schema setting then pass in the schema attribute to this argument or do not fill this parameter at all; the default value for this field is -1, which is a fallback to use Snowflake default - in this case the schema value
name String
Specifies the identifier for the table; must be unique for the database and schema in which the table is created.
primaryKey TablePrimaryKey
Definitions of primary key constraint to create on table

Deprecated: Use snowflake.TableConstraint instead

tags List<TableTag>
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

columns This property is required. TableColumn[]
Definitions of a column to create in the table. Minimum one required.
database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the table.
schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the table.
changeTracking boolean
Specifies whether to enable change tracking on the table. Default false.
clusterBies string[]
A list of one or more table columns/expressions to be used as clustering key(s) for the table
comment string
Specifies a comment for the table.
dataRetentionTimeInDays number
Specifies the retention period for the table so that Time Travel actions (SELECT, CLONE, UNDROP) can be performed on historical data in the table. If you wish to inherit the parent schema setting then pass in the schema attribute to this argument or do not fill this parameter at all; the default value for this field is -1, which is a fallback to use Snowflake default - in this case the schema value
name string
Specifies the identifier for the table; must be unique for the database and schema in which the table is created.
primaryKey TablePrimaryKey
Definitions of primary key constraint to create on table

Deprecated: Use snowflake.TableConstraint instead

tags TableTag[]
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

columns This property is required. Sequence[TableColumnArgs]
Definitions of a column to create in the table. Minimum one required.
database
This property is required.
Changes to this property will trigger replacement.
str
The database in which to create the table.
schema
This property is required.
Changes to this property will trigger replacement.
str
The schema in which to create the table.
change_tracking bool
Specifies whether to enable change tracking on the table. Default false.
cluster_bies Sequence[str]
A list of one or more table columns/expressions to be used as clustering key(s) for the table
comment str
Specifies a comment for the table.
data_retention_time_in_days int
Specifies the retention period for the table so that Time Travel actions (SELECT, CLONE, UNDROP) can be performed on historical data in the table. If you wish to inherit the parent schema setting then pass in the schema attribute to this argument or do not fill this parameter at all; the default value for this field is -1, which is a fallback to use Snowflake default - in this case the schema value
name str
Specifies the identifier for the table; must be unique for the database and schema in which the table is created.
primary_key TablePrimaryKeyArgs
Definitions of primary key constraint to create on table

Deprecated: Use snowflake.TableConstraint instead

tags Sequence[TableTagArgs]
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

columns This property is required. List<Property Map>
Definitions of a column to create in the table. Minimum one required.
database
This property is required.
Changes to this property will trigger replacement.
String
The database in which to create the table.
schema
This property is required.
Changes to this property will trigger replacement.
String
The schema in which to create the table.
changeTracking Boolean
Specifies whether to enable change tracking on the table. Default false.
clusterBies List<String>
A list of one or more table columns/expressions to be used as clustering key(s) for the table
comment String
Specifies a comment for the table.
dataRetentionTimeInDays Number
Specifies the retention period for the table so that Time Travel actions (SELECT, CLONE, UNDROP) can be performed on historical data in the table. If you wish to inherit the parent schema setting then pass in the schema attribute to this argument or do not fill this parameter at all; the default value for this field is -1, which is a fallback to use Snowflake default - in this case the schema value
name String
Specifies the identifier for the table; must be unique for the database and schema in which the table is created.
primaryKey Property Map
Definitions of primary key constraint to create on table

Deprecated: Use snowflake.TableConstraint instead

tags List<Property Map>
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

Outputs

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

FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Id string
The provider-assigned unique ID for this managed resource.
Owner string
Name of the role that owns the table.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Id string
The provider-assigned unique ID for this managed resource.
Owner string
Name of the role that owns the table.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
id String
The provider-assigned unique ID for this managed resource.
owner String
Name of the role that owns the table.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
id string
The provider-assigned unique ID for this managed resource.
owner string
Name of the role that owns the table.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
id str
The provider-assigned unique ID for this managed resource.
owner str
Name of the role that owns the table.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
id String
The provider-assigned unique ID for this managed resource.
owner String
Name of the role that owns the table.

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,
        change_tracking: Optional[bool] = None,
        cluster_bies: Optional[Sequence[str]] = None,
        columns: Optional[Sequence[TableColumnArgs]] = None,
        comment: Optional[str] = None,
        data_retention_time_in_days: Optional[int] = None,
        database: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        owner: Optional[str] = None,
        primary_key: Optional[TablePrimaryKeyArgs] = None,
        schema: Optional[str] = None,
        tags: Optional[Sequence[TableTagArgs]] = 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)
resources:  _:    type: snowflake:Table    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ChangeTracking bool
Specifies whether to enable change tracking on the table. Default false.
ClusterBies List<string>
A list of one or more table columns/expressions to be used as clustering key(s) for the table
Columns List<TableColumn>
Definitions of a column to create in the table. Minimum one required.
Comment string
Specifies a comment for the table.
DataRetentionTimeInDays int
Specifies the retention period for the table so that Time Travel actions (SELECT, CLONE, UNDROP) can be performed on historical data in the table. If you wish to inherit the parent schema setting then pass in the schema attribute to this argument or do not fill this parameter at all; the default value for this field is -1, which is a fallback to use Snowflake default - in this case the schema value
Database Changes to this property will trigger replacement. string
The database in which to create the table.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Name string
Specifies the identifier for the table; must be unique for the database and schema in which the table is created.
Owner string
Name of the role that owns the table.
PrimaryKey TablePrimaryKey
Definitions of primary key constraint to create on table

Deprecated: Use snowflake.TableConstraint instead

Schema Changes to this property will trigger replacement. string
The schema in which to create the table.
Tags List<TableTag>
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

ChangeTracking bool
Specifies whether to enable change tracking on the table. Default false.
ClusterBies []string
A list of one or more table columns/expressions to be used as clustering key(s) for the table
Columns []TableColumnArgs
Definitions of a column to create in the table. Minimum one required.
Comment string
Specifies a comment for the table.
DataRetentionTimeInDays int
Specifies the retention period for the table so that Time Travel actions (SELECT, CLONE, UNDROP) can be performed on historical data in the table. If you wish to inherit the parent schema setting then pass in the schema attribute to this argument or do not fill this parameter at all; the default value for this field is -1, which is a fallback to use Snowflake default - in this case the schema value
Database Changes to this property will trigger replacement. string
The database in which to create the table.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Name string
Specifies the identifier for the table; must be unique for the database and schema in which the table is created.
Owner string
Name of the role that owns the table.
PrimaryKey TablePrimaryKeyArgs
Definitions of primary key constraint to create on table

Deprecated: Use snowflake.TableConstraint instead

Schema Changes to this property will trigger replacement. string
The schema in which to create the table.
Tags []TableTagArgs
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

changeTracking Boolean
Specifies whether to enable change tracking on the table. Default false.
clusterBies List<String>
A list of one or more table columns/expressions to be used as clustering key(s) for the table
columns List<TableColumn>
Definitions of a column to create in the table. Minimum one required.
comment String
Specifies a comment for the table.
dataRetentionTimeInDays Integer
Specifies the retention period for the table so that Time Travel actions (SELECT, CLONE, UNDROP) can be performed on historical data in the table. If you wish to inherit the parent schema setting then pass in the schema attribute to this argument or do not fill this parameter at all; the default value for this field is -1, which is a fallback to use Snowflake default - in this case the schema value
database Changes to this property will trigger replacement. String
The database in which to create the table.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
name String
Specifies the identifier for the table; must be unique for the database and schema in which the table is created.
owner String
Name of the role that owns the table.
primaryKey TablePrimaryKey
Definitions of primary key constraint to create on table

Deprecated: Use snowflake.TableConstraint instead

schema Changes to this property will trigger replacement. String
The schema in which to create the table.
tags List<TableTag>
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

changeTracking boolean
Specifies whether to enable change tracking on the table. Default false.
clusterBies string[]
A list of one or more table columns/expressions to be used as clustering key(s) for the table
columns TableColumn[]
Definitions of a column to create in the table. Minimum one required.
comment string
Specifies a comment for the table.
dataRetentionTimeInDays number
Specifies the retention period for the table so that Time Travel actions (SELECT, CLONE, UNDROP) can be performed on historical data in the table. If you wish to inherit the parent schema setting then pass in the schema attribute to this argument or do not fill this parameter at all; the default value for this field is -1, which is a fallback to use Snowflake default - in this case the schema value
database Changes to this property will trigger replacement. string
The database in which to create the table.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
name string
Specifies the identifier for the table; must be unique for the database and schema in which the table is created.
owner string
Name of the role that owns the table.
primaryKey TablePrimaryKey
Definitions of primary key constraint to create on table

Deprecated: Use snowflake.TableConstraint instead

schema Changes to this property will trigger replacement. string
The schema in which to create the table.
tags TableTag[]
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

change_tracking bool
Specifies whether to enable change tracking on the table. Default false.
cluster_bies Sequence[str]
A list of one or more table columns/expressions to be used as clustering key(s) for the table
columns Sequence[TableColumnArgs]
Definitions of a column to create in the table. Minimum one required.
comment str
Specifies a comment for the table.
data_retention_time_in_days int
Specifies the retention period for the table so that Time Travel actions (SELECT, CLONE, UNDROP) can be performed on historical data in the table. If you wish to inherit the parent schema setting then pass in the schema attribute to this argument or do not fill this parameter at all; the default value for this field is -1, which is a fallback to use Snowflake default - in this case the schema value
database Changes to this property will trigger replacement. str
The database in which to create the table.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
name str
Specifies the identifier for the table; must be unique for the database and schema in which the table is created.
owner str
Name of the role that owns the table.
primary_key TablePrimaryKeyArgs
Definitions of primary key constraint to create on table

Deprecated: Use snowflake.TableConstraint instead

schema Changes to this property will trigger replacement. str
The schema in which to create the table.
tags Sequence[TableTagArgs]
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

changeTracking Boolean
Specifies whether to enable change tracking on the table. Default false.
clusterBies List<String>
A list of one or more table columns/expressions to be used as clustering key(s) for the table
columns List<Property Map>
Definitions of a column to create in the table. Minimum one required.
comment String
Specifies a comment for the table.
dataRetentionTimeInDays Number
Specifies the retention period for the table so that Time Travel actions (SELECT, CLONE, UNDROP) can be performed on historical data in the table. If you wish to inherit the parent schema setting then pass in the schema attribute to this argument or do not fill this parameter at all; the default value for this field is -1, which is a fallback to use Snowflake default - in this case the schema value
database Changes to this property will trigger replacement. String
The database in which to create the table.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
name String
Specifies the identifier for the table; must be unique for the database and schema in which the table is created.
owner String
Name of the role that owns the table.
primaryKey Property Map
Definitions of primary key constraint to create on table

Deprecated: Use snowflake.TableConstraint instead

schema Changes to this property will trigger replacement. String
The schema in which to create the table.
tags List<Property Map>
Definitions of a tag to associate with the resource.

Deprecated: Use the 'snowflake_tag_association' resource instead.

Supporting Types

TableColumn
, TableColumnArgs

Name This property is required. string
Column name
Type This property is required. string
Column type, e.g. VARIANT. For a full list of column types, see Summary of Data Types.
Collate string
Column collation, e.g. utf8
Comment string
Column comment
Default TableColumnDefault
Defines the column default value; note due to limitations of Snowflake's ALTER TABLE ADD/MODIFY COLUMN updates to default will not be applied
Identity TableColumnIdentity
Defines the identity start/step values for a column. Note Identity/default are mutually exclusive.
MaskingPolicy string
Masking policy to apply on column. It has to be a fully qualified name.
Nullable bool
Whether this column can contain null values. Note: Depending on your Snowflake version, the default value will not suffice if this column is used in a primary key constraint.
SchemaEvolutionRecord string
Record of schema evolution.
Name This property is required. string
Column name
Type This property is required. string
Column type, e.g. VARIANT. For a full list of column types, see Summary of Data Types.
Collate string
Column collation, e.g. utf8
Comment string
Column comment
Default TableColumnDefault
Defines the column default value; note due to limitations of Snowflake's ALTER TABLE ADD/MODIFY COLUMN updates to default will not be applied
Identity TableColumnIdentity
Defines the identity start/step values for a column. Note Identity/default are mutually exclusive.
MaskingPolicy string
Masking policy to apply on column. It has to be a fully qualified name.
Nullable bool
Whether this column can contain null values. Note: Depending on your Snowflake version, the default value will not suffice if this column is used in a primary key constraint.
SchemaEvolutionRecord string
Record of schema evolution.
name This property is required. String
Column name
type This property is required. String
Column type, e.g. VARIANT. For a full list of column types, see Summary of Data Types.
collate String
Column collation, e.g. utf8
comment String
Column comment
default_ TableColumnDefault
Defines the column default value; note due to limitations of Snowflake's ALTER TABLE ADD/MODIFY COLUMN updates to default will not be applied
identity TableColumnIdentity
Defines the identity start/step values for a column. Note Identity/default are mutually exclusive.
maskingPolicy String
Masking policy to apply on column. It has to be a fully qualified name.
nullable Boolean
Whether this column can contain null values. Note: Depending on your Snowflake version, the default value will not suffice if this column is used in a primary key constraint.
schemaEvolutionRecord String
Record of schema evolution.
name This property is required. string
Column name
type This property is required. string
Column type, e.g. VARIANT. For a full list of column types, see Summary of Data Types.
collate string
Column collation, e.g. utf8
comment string
Column comment
default TableColumnDefault
Defines the column default value; note due to limitations of Snowflake's ALTER TABLE ADD/MODIFY COLUMN updates to default will not be applied
identity TableColumnIdentity
Defines the identity start/step values for a column. Note Identity/default are mutually exclusive.
maskingPolicy string
Masking policy to apply on column. It has to be a fully qualified name.
nullable boolean
Whether this column can contain null values. Note: Depending on your Snowflake version, the default value will not suffice if this column is used in a primary key constraint.
schemaEvolutionRecord string
Record of schema evolution.
name This property is required. str
Column name
type This property is required. str
Column type, e.g. VARIANT. For a full list of column types, see Summary of Data Types.
collate str
Column collation, e.g. utf8
comment str
Column comment
default TableColumnDefault
Defines the column default value; note due to limitations of Snowflake's ALTER TABLE ADD/MODIFY COLUMN updates to default will not be applied
identity TableColumnIdentity
Defines the identity start/step values for a column. Note Identity/default are mutually exclusive.
masking_policy str
Masking policy to apply on column. It has to be a fully qualified name.
nullable bool
Whether this column can contain null values. Note: Depending on your Snowflake version, the default value will not suffice if this column is used in a primary key constraint.
schema_evolution_record str
Record of schema evolution.
name This property is required. String
Column name
type This property is required. String
Column type, e.g. VARIANT. For a full list of column types, see Summary of Data Types.
collate String
Column collation, e.g. utf8
comment String
Column comment
default Property Map
Defines the column default value; note due to limitations of Snowflake's ALTER TABLE ADD/MODIFY COLUMN updates to default will not be applied
identity Property Map
Defines the identity start/step values for a column. Note Identity/default are mutually exclusive.
maskingPolicy String
Masking policy to apply on column. It has to be a fully qualified name.
nullable Boolean
Whether this column can contain null values. Note: Depending on your Snowflake version, the default value will not suffice if this column is used in a primary key constraint.
schemaEvolutionRecord String
Record of schema evolution.

TableColumnDefault
, TableColumnDefaultArgs

Constant string
The default constant value for the column
Expression string
The default expression value for the column
Sequence string
The default sequence to use for the column
Constant string
The default constant value for the column
Expression string
The default expression value for the column
Sequence string
The default sequence to use for the column
constant String
The default constant value for the column
expression String
The default expression value for the column
sequence String
The default sequence to use for the column
constant string
The default constant value for the column
expression string
The default expression value for the column
sequence string
The default sequence to use for the column
constant str
The default constant value for the column
expression str
The default expression value for the column
sequence str
The default sequence to use for the column
constant String
The default constant value for the column
expression String
The default expression value for the column
sequence String
The default sequence to use for the column

TableColumnIdentity
, TableColumnIdentityArgs

StartNum int
The number to start incrementing at.
StepNum int
Step size to increment by.
StartNum int
The number to start incrementing at.
StepNum int
Step size to increment by.
startNum Integer
The number to start incrementing at.
stepNum Integer
Step size to increment by.
startNum number
The number to start incrementing at.
stepNum number
Step size to increment by.
start_num int
The number to start incrementing at.
step_num int
Step size to increment by.
startNum Number
The number to start incrementing at.
stepNum Number
Step size to increment by.

TablePrimaryKey
, TablePrimaryKeyArgs

Keys This property is required. List<string>
Columns to use in primary key
Name string
Name of constraint
Keys This property is required. []string
Columns to use in primary key
Name string
Name of constraint
keys This property is required. List<String>
Columns to use in primary key
name String
Name of constraint
keys This property is required. string[]
Columns to use in primary key
name string
Name of constraint
keys This property is required. Sequence[str]
Columns to use in primary key
name str
Name of constraint
keys This property is required. List<String>
Columns to use in primary key
name String
Name of constraint

TableTag
, TableTagArgs

Name This property is required. string
Tag name, e.g. department.
Value This property is required. string
Tag value, e.g. marketing_info.
Database string
Name of the database that the tag was created in.
Schema string
Name of the schema that the tag was created in.
Name This property is required. string
Tag name, e.g. department.
Value This property is required. string
Tag value, e.g. marketing_info.
Database string
Name of the database that the tag was created in.
Schema string
Name of the schema that the tag was created in.
name This property is required. String
Tag name, e.g. department.
value This property is required. String
Tag value, e.g. marketing_info.
database String
Name of the database that the tag was created in.
schema String
Name of the schema that the tag was created in.
name This property is required. string
Tag name, e.g. department.
value This property is required. string
Tag value, e.g. marketing_info.
database string
Name of the database that the tag was created in.
schema string
Name of the schema that the tag was created in.
name This property is required. str
Tag name, e.g. department.
value This property is required. str
Tag value, e.g. marketing_info.
database str
Name of the database that the tag was created in.
schema str
Name of the schema that the tag was created in.
name This property is required. String
Tag name, e.g. department.
value This property is required. String
Tag value, e.g. marketing_info.
database String
Name of the database that the tag was created in.
schema String
Name of the schema that the tag was created in.

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.
Snowflake v1.1.4 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-snowflake