snowflake.ExternalTable
Explore with Pulumi AI
Import
format is database name | schema name | external table name
$ pulumi import snowflake:index/externalTable:ExternalTable example 'dbName|schemaName|externalTableName'
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;
return await Deployment.RunAsync(() =>
{
var externalTable = new Snowflake.ExternalTable("externalTable", new()
{
Columns = new[]
{
new Snowflake.Inputs.ExternalTableColumnArgs
{
Name = "id",
Type = "int",
},
new Snowflake.Inputs.ExternalTableColumnArgs
{
Name = "data",
Type = "text",
},
},
Comment = "External table",
Database = "db",
FileFormat = "TYPE = CSV FIELD_DELIMITER = '|'",
Schema = "schema",
});
});
package main
import (
"github.com/pulumi/pulumi-snowflake/sdk/go/snowflake"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := snowflake.NewExternalTable(ctx, "externalTable", &snowflake.ExternalTableArgs{
Columns: snowflake.ExternalTableColumnArray{
&snowflake.ExternalTableColumnArgs{
Name: pulumi.String("id"),
Type: pulumi.String("int"),
},
&snowflake.ExternalTableColumnArgs{
Name: pulumi.String("data"),
Type: pulumi.String("text"),
},
},
Comment: pulumi.String("External table"),
Database: pulumi.String("db"),
FileFormat: pulumi.String("TYPE = CSV FIELD_DELIMITER = '|'"),
Schema: pulumi.String("schema"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.ExternalTable;
import com.pulumi.snowflake.ExternalTableArgs;
import com.pulumi.snowflake.inputs.ExternalTableColumnArgs;
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 externalTable = new ExternalTable("externalTable", ExternalTableArgs.builder()
.columns(
ExternalTableColumnArgs.builder()
.name("id")
.type("int")
.build(),
ExternalTableColumnArgs.builder()
.name("data")
.type("text")
.build())
.comment("External table")
.database("db")
.fileFormat("TYPE = CSV FIELD_DELIMITER = '|'")
.schema("schema")
.build());
}
}
import pulumi
import pulumi_snowflake as snowflake
external_table = snowflake.ExternalTable("externalTable",
columns=[
snowflake.ExternalTableColumnArgs(
name="id",
type="int",
),
snowflake.ExternalTableColumnArgs(
name="data",
type="text",
),
],
comment="External table",
database="db",
file_format="TYPE = CSV FIELD_DELIMITER = '|'",
schema="schema")
import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";
const externalTable = new snowflake.ExternalTable("externalTable", {
columns: [
{
name: "id",
type: "int",
},
{
name: "data",
type: "text",
},
],
comment: "External table",
database: "db",
fileFormat: "TYPE = CSV FIELD_DELIMITER = '|'",
schema: "schema",
});
resources:
externalTable:
type: snowflake:ExternalTable
properties:
columns:
- name: id
type: int
- name: data
type: text
comment: External table
database: db
fileFormat: TYPE = CSV FIELD_DELIMITER = '|'
schema: schema
Create ExternalTable Resource
new ExternalTable(name: string, args: ExternalTableArgs, opts?: CustomResourceOptions);
@overload
def ExternalTable(resource_name: str,
opts: Optional[ResourceOptions] = None,
auto_refresh: Optional[bool] = None,
aws_sns_topic: Optional[str] = None,
columns: Optional[Sequence[ExternalTableColumnArgs]] = None,
comment: Optional[str] = None,
copy_grants: Optional[bool] = None,
database: Optional[str] = None,
file_format: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
partition_bies: Optional[Sequence[str]] = None,
pattern: Optional[str] = None,
refresh_on_create: Optional[bool] = None,
schema: Optional[str] = None,
tags: Optional[Sequence[ExternalTableTagArgs]] = None)
@overload
def ExternalTable(resource_name: str,
args: ExternalTableArgs,
opts: Optional[ResourceOptions] = None)
func NewExternalTable(ctx *Context, name string, args ExternalTableArgs, opts ...ResourceOption) (*ExternalTable, error)
public ExternalTable(string name, ExternalTableArgs args, CustomResourceOptions? opts = null)
public ExternalTable(String name, ExternalTableArgs args)
public ExternalTable(String name, ExternalTableArgs args, CustomResourceOptions options)
type: snowflake:ExternalTable
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ExternalTableArgs
- 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 ExternalTableArgs
- 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 ExternalTableArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ExternalTableArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ExternalTableArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ExternalTable 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 ExternalTable resource accepts the following input properties:
- Columns
List<External
Table Column> Definitions of a column to create in the external table. Minimum one required.
- Database string
Name of the database that the tag was created in.
- File
Format string Specifies the file format for the external table.
- Location string
Specifies a location for the external table.
- Schema string
Name of the schema that the tag was created in.
- Auto
Refresh bool Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- Aws
Sns stringTopic Specifies the aws sns topic for the external table.
- Comment string
Specifies a comment for the external table.
- Copy
Grants bool Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
- Name string
Column name
- Partition
Bies List<string> Specifies any partition columns to evaluate for the external table.
- Pattern string
Specifies the file names and/or paths on the external stage to match.
- Refresh
On boolCreate Specifies weather to refresh when an external table is created.
- List<External
Table Tag> Definitions of a tag to associate with the resource.
Use the 'snowflake_tag_association' resource instead.
- Columns
[]External
Table Column Args Definitions of a column to create in the external table. Minimum one required.
- Database string
Name of the database that the tag was created in.
- File
Format string Specifies the file format for the external table.
- Location string
Specifies a location for the external table.
- Schema string
Name of the schema that the tag was created in.
- Auto
Refresh bool Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- Aws
Sns stringTopic Specifies the aws sns topic for the external table.
- Comment string
Specifies a comment for the external table.
- Copy
Grants bool Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
- Name string
Column name
- Partition
Bies []string Specifies any partition columns to evaluate for the external table.
- Pattern string
Specifies the file names and/or paths on the external stage to match.
- Refresh
On boolCreate Specifies weather to refresh when an external table is created.
- []External
Table Tag Args Definitions of a tag to associate with the resource.
Use the 'snowflake_tag_association' resource instead.
- columns
List<External
Table Column> Definitions of a column to create in the external table. Minimum one required.
- database String
Name of the database that the tag was created in.
- file
Format String Specifies the file format for the external table.
- location String
Specifies a location for the external table.
- schema String
Name of the schema that the tag was created in.
- auto
Refresh Boolean Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws
Sns StringTopic Specifies the aws sns topic for the external table.
- comment String
Specifies a comment for the external table.
- copy
Grants Boolean Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
- name String
Column name
- partition
Bies List<String> Specifies any partition columns to evaluate for the external table.
- pattern String
Specifies the file names and/or paths on the external stage to match.
- refresh
On BooleanCreate Specifies weather to refresh when an external table is created.
- List<External
Table Tag> Definitions of a tag to associate with the resource.
Use the 'snowflake_tag_association' resource instead.
- columns
External
Table Column[] Definitions of a column to create in the external table. Minimum one required.
- database string
Name of the database that the tag was created in.
- file
Format string Specifies the file format for the external table.
- location string
Specifies a location for the external table.
- schema string
Name of the schema that the tag was created in.
- auto
Refresh boolean Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws
Sns stringTopic Specifies the aws sns topic for the external table.
- comment string
Specifies a comment for the external table.
- copy
Grants boolean Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
- name string
Column name
- partition
Bies string[] Specifies any partition columns to evaluate for the external table.
- pattern string
Specifies the file names and/or paths on the external stage to match.
- refresh
On booleanCreate Specifies weather to refresh when an external table is created.
- External
Table Tag[] Definitions of a tag to associate with the resource.
Use the 'snowflake_tag_association' resource instead.
- columns
Sequence[External
Table Column Args] Definitions of a column to create in the external table. Minimum one required.
- database str
Name of the database that the tag was created in.
- file_
format str Specifies the file format for the external table.
- location str
Specifies a location for the external table.
- schema str
Name of the schema that the tag was created in.
- auto_
refresh bool Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws_
sns_ strtopic Specifies the aws sns topic for the external table.
- comment str
Specifies a comment for the external table.
- copy_
grants bool Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
- name str
Column name
- partition_
bies Sequence[str] Specifies any partition columns to evaluate for the external table.
- pattern str
Specifies the file names and/or paths on the external stage to match.
- refresh_
on_ boolcreate Specifies weather to refresh when an external table is created.
- Sequence[External
Table Tag Args] Definitions of a tag to associate with the resource.
Use the 'snowflake_tag_association' resource instead.
- columns List<Property Map>
Definitions of a column to create in the external table. Minimum one required.
- database String
Name of the database that the tag was created in.
- file
Format String Specifies the file format for the external table.
- location String
Specifies a location for the external table.
- schema String
Name of the schema that the tag was created in.
- auto
Refresh Boolean Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws
Sns StringTopic Specifies the aws sns topic for the external table.
- comment String
Specifies a comment for the external table.
- copy
Grants Boolean Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
- name String
Column name
- partition
Bies List<String> Specifies any partition columns to evaluate for the external table.
- pattern String
Specifies the file names and/or paths on the external stage to match.
- refresh
On BooleanCreate Specifies weather to refresh when an external table is created.
- List<Property Map>
Definitions of a tag to associate with the resource.
Use the 'snowflake_tag_association' resource instead.
Outputs
All input properties are implicitly available as output properties. Additionally, the ExternalTable resource produces the following output properties:
Look up Existing ExternalTable Resource
Get an existing ExternalTable 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?: ExternalTableState, opts?: CustomResourceOptions): ExternalTable
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_refresh: Optional[bool] = None,
aws_sns_topic: Optional[str] = None,
columns: Optional[Sequence[ExternalTableColumnArgs]] = None,
comment: Optional[str] = None,
copy_grants: Optional[bool] = None,
database: Optional[str] = None,
file_format: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
owner: Optional[str] = None,
partition_bies: Optional[Sequence[str]] = None,
pattern: Optional[str] = None,
refresh_on_create: Optional[bool] = None,
schema: Optional[str] = None,
tags: Optional[Sequence[ExternalTableTagArgs]] = None) -> ExternalTable
func GetExternalTable(ctx *Context, name string, id IDInput, state *ExternalTableState, opts ...ResourceOption) (*ExternalTable, error)
public static ExternalTable Get(string name, Input<string> id, ExternalTableState? state, CustomResourceOptions? opts = null)
public static ExternalTable get(String name, Output<String> id, ExternalTableState 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.
- Auto
Refresh bool Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- Aws
Sns stringTopic Specifies the aws sns topic for the external table.
- Columns
List<External
Table Column> Definitions of a column to create in the external table. Minimum one required.
- Comment string
Specifies a comment for the external table.
- Copy
Grants bool Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
- Database string
Name of the database that the tag was created in.
- File
Format string Specifies the file format for the external table.
- Location string
Specifies a location for the external table.
- Name string
Column name
- Owner string
Name of the role that owns the external table.
- Partition
Bies List<string> Specifies any partition columns to evaluate for the external table.
- Pattern string
Specifies the file names and/or paths on the external stage to match.
- Refresh
On boolCreate Specifies weather to refresh when an external table is created.
- Schema string
Name of the schema that the tag was created in.
- List<External
Table Tag> Definitions of a tag to associate with the resource.
Use the 'snowflake_tag_association' resource instead.
- Auto
Refresh bool Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- Aws
Sns stringTopic Specifies the aws sns topic for the external table.
- Columns
[]External
Table Column Args Definitions of a column to create in the external table. Minimum one required.
- Comment string
Specifies a comment for the external table.
- Copy
Grants bool Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
- Database string
Name of the database that the tag was created in.
- File
Format string Specifies the file format for the external table.
- Location string
Specifies a location for the external table.
- Name string
Column name
- Owner string
Name of the role that owns the external table.
- Partition
Bies []string Specifies any partition columns to evaluate for the external table.
- Pattern string
Specifies the file names and/or paths on the external stage to match.
- Refresh
On boolCreate Specifies weather to refresh when an external table is created.
- Schema string
Name of the schema that the tag was created in.
- []External
Table Tag Args Definitions of a tag to associate with the resource.
Use the 'snowflake_tag_association' resource instead.
- auto
Refresh Boolean Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws
Sns StringTopic Specifies the aws sns topic for the external table.
- columns
List<External
Table Column> Definitions of a column to create in the external table. Minimum one required.
- comment String
Specifies a comment for the external table.
- copy
Grants Boolean Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
- database String
Name of the database that the tag was created in.
- file
Format String Specifies the file format for the external table.
- location String
Specifies a location for the external table.
- name String
Column name
- owner String
Name of the role that owns the external table.
- partition
Bies List<String> Specifies any partition columns to evaluate for the external table.
- pattern String
Specifies the file names and/or paths on the external stage to match.
- refresh
On BooleanCreate Specifies weather to refresh when an external table is created.
- schema String
Name of the schema that the tag was created in.
- List<External
Table Tag> Definitions of a tag to associate with the resource.
Use the 'snowflake_tag_association' resource instead.
- auto
Refresh boolean Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws
Sns stringTopic Specifies the aws sns topic for the external table.
- columns
External
Table Column[] Definitions of a column to create in the external table. Minimum one required.
- comment string
Specifies a comment for the external table.
- copy
Grants boolean Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
- database string
Name of the database that the tag was created in.
- file
Format string Specifies the file format for the external table.
- location string
Specifies a location for the external table.
- name string
Column name
- owner string
Name of the role that owns the external table.
- partition
Bies string[] Specifies any partition columns to evaluate for the external table.
- pattern string
Specifies the file names and/or paths on the external stage to match.
- refresh
On booleanCreate Specifies weather to refresh when an external table is created.
- schema string
Name of the schema that the tag was created in.
- External
Table Tag[] Definitions of a tag to associate with the resource.
Use the 'snowflake_tag_association' resource instead.
- auto_
refresh bool Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws_
sns_ strtopic Specifies the aws sns topic for the external table.
- columns
Sequence[External
Table Column Args] Definitions of a column to create in the external table. Minimum one required.
- comment str
Specifies a comment for the external table.
- copy_
grants bool Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
- database str
Name of the database that the tag was created in.
- file_
format str Specifies the file format for the external table.
- location str
Specifies a location for the external table.
- name str
Column name
- owner str
Name of the role that owns the external table.
- partition_
bies Sequence[str] Specifies any partition columns to evaluate for the external table.
- pattern str
Specifies the file names and/or paths on the external stage to match.
- refresh_
on_ boolcreate Specifies weather to refresh when an external table is created.
- schema str
Name of the schema that the tag was created in.
- Sequence[External
Table Tag Args] Definitions of a tag to associate with the resource.
Use the 'snowflake_tag_association' resource instead.
- auto
Refresh Boolean Specifies whether to automatically refresh the external table metadata once, immediately after the external table is created.
- aws
Sns StringTopic Specifies the aws sns topic for the external table.
- columns List<Property Map>
Definitions of a column to create in the external table. Minimum one required.
- comment String
Specifies a comment for the external table.
- copy
Grants Boolean Specifies to retain the access permissions from the original table when an external table is recreated using the CREATE OR REPLACE TABLE variant
- database String
Name of the database that the tag was created in.
- file
Format String Specifies the file format for the external table.
- location String
Specifies a location for the external table.
- name String
Column name
- owner String
Name of the role that owns the external table.
- partition
Bies List<String> Specifies any partition columns to evaluate for the external table.
- pattern String
Specifies the file names and/or paths on the external stage to match.
- refresh
On BooleanCreate Specifies weather to refresh when an external table is created.
- schema String
Name of the schema that the tag was created in.
- List<Property Map>
Definitions of a tag to associate with the resource.
Use the 'snowflake_tag_association' resource instead.
Supporting Types
ExternalTableColumn, ExternalTableColumnArgs
ExternalTableTag, ExternalTableTagArgs
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
snowflake
Terraform Provider.