Skip to content

SnowflakeNodeData

Source code in docs_src/capo_glue/types/snowflake_node_data.py
class SnowflakeNodeData(TypedDict, closed=True):
    source_type: NotRequired[
        "capo_glue.types.generic_limited_string.GenericLimitedString"
    ]
    """<p>Specifies how retrieved data is specified. Valid values: <code>"table"</code>, <code> "query"</code>.</p>"""
    connection: NotRequired["capo_glue.types.option.Option"]
    """<p>Specifies a Glue Data Catalog Connection to a Snowflake endpoint.</p>"""
    schema: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>Specifies a Snowflake database schema for your node to use.</p>"""
    table: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>Specifies a Snowflake table for your node to use.</p>"""
    database: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>Specifies a Snowflake database for your node to use.</p>"""
    temp_dir: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>Not currently used.</p>"""
    iam_role: NotRequired["capo_glue.types.option.Option"]
    """<p>Not currently used.</p>"""
    additional_options: NotRequired[
        "capo_glue.types.additional_options.AdditionalOptions"
    ]
    """<p>Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.</p>"""
    sample_query: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>A SQL string used to retrieve data with the <code>query</code> sourcetype.</p>"""
    pre_action: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>A SQL string run before the Snowflake connector performs its standard actions.</p>"""
    post_action: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>A SQL string run after the Snowflake connector performs its standard actions.</p>"""
    action: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>Specifies what action to take when writing to a table with preexisting data. Valid values: <code> append</code>, <code>merge</code>, <code>truncate</code>, <code>drop</code>.</p>"""
    upsert: "capo_glue.types.boolean_value.BooleanValue"
    """<p>Used when Action is <code>append</code>. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.</p>"""
    merge_action: NotRequired[
        "capo_glue.types.generic_limited_string.GenericLimitedString"
    ]
    """<p>Specifies a merge action. Valid values: <code>simple</code>, <code>custom</code>. If simple, merge behavior is defined by <code>MergeWhenMatched</code> and <code> MergeWhenNotMatched</code>. If custom, defined by <code>MergeClause</code>.</p>"""
    merge_when_matched: NotRequired[
        "capo_glue.types.generic_limited_string.GenericLimitedString"
    ]
    """<p>Specifies how to resolve records that match preexisting data when merging. Valid values: <code> update</code>, <code>delete</code>.</p>"""
    merge_when_not_matched: NotRequired[
        "capo_glue.types.generic_limited_string.GenericLimitedString"
    ]
    """<p>Specifies how to process records that do not match preexisting data when merging. Valid values: <code>insert</code>, <code>none</code>.</p>"""
    merge_clause: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>A SQL statement that specifies a custom merge behavior.</p>"""
    staging_table: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>The name of a staging table used when performing <code>merge</code> or upsert <code>append</code> actions. Data is written to this table, then moved to <code>table</code> by a generated postaction.</p>"""
    selected_columns: NotRequired["capo_glue.types.option_list.OptionList"]
    """<p>Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with <code>value</code>, <code>label</code> and <code> description</code> keys. Each structure describes a column.</p>"""
    auto_pushdown: "capo_glue.types.boolean_value.BooleanValue"
    """<p>Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.</p>"""
    table_schema: NotRequired["capo_glue.types.option_list.OptionList"]
    """<p>Manually defines the target schema for the node. A list of structures with <code>value</code> , <code>label</code> and <code>description</code> keys. Each structure defines a column.</p>"""

action instance-attribute

action: NotRequired[GenericString]

Specifies what action to take when writing to a table with preexisting data. Valid values: append, merge, truncate, drop.

additional_options instance-attribute

additional_options: NotRequired[AdditionalOptions]

Specifies additional options passed to the Snowflake connector. If options are specified elsewhere in this node, this will take precedence.

auto_pushdown instance-attribute

auto_pushdown: BooleanValue

Specifies whether automatic query pushdown is enabled. If pushdown is enabled, then when a query is run on Spark, if part of the query can be "pushed down" to the Snowflake server, it is pushed down. This improves performance of some queries.

connection instance-attribute

connection: NotRequired[Option]

Specifies a Glue Data Catalog Connection to a Snowflake endpoint.

database instance-attribute

database: NotRequired[GenericString]

Specifies a Snowflake database for your node to use.

iam_role instance-attribute

iam_role: NotRequired[Option]

Not currently used.

merge_action instance-attribute

merge_action: NotRequired[GenericLimitedString]

Specifies a merge action. Valid values: simple, custom. If simple, merge behavior is defined by MergeWhenMatched and MergeWhenNotMatched. If custom, defined by MergeClause.

merge_clause instance-attribute

merge_clause: NotRequired[GenericString]

A SQL statement that specifies a custom merge behavior.

merge_when_matched instance-attribute

merge_when_matched: NotRequired[GenericLimitedString]

Specifies how to resolve records that match preexisting data when merging. Valid values: update, delete.

merge_when_not_matched instance-attribute

merge_when_not_matched: NotRequired[GenericLimitedString]

Specifies how to process records that do not match preexisting data when merging. Valid values: insert, none.

post_action instance-attribute

post_action: NotRequired[GenericString]

A SQL string run after the Snowflake connector performs its standard actions.

pre_action instance-attribute

pre_action: NotRequired[GenericString]

A SQL string run before the Snowflake connector performs its standard actions.

sample_query instance-attribute

sample_query: NotRequired[GenericString]

A SQL string used to retrieve data with the query sourcetype.

schema instance-attribute

schema: NotRequired[GenericString]

Specifies a Snowflake database schema for your node to use.

selected_columns instance-attribute

selected_columns: NotRequired[OptionList]

Specifies the columns combined to identify a record when detecting matches for merges and upserts. A list of structures with value, label and description keys. Each structure describes a column.

source_type instance-attribute

source_type: NotRequired[GenericLimitedString]

Specifies how retrieved data is specified. Valid values: "table", "query".

staging_table instance-attribute

staging_table: NotRequired[GenericString]

The name of a staging table used when performing merge or upsert append actions. Data is written to this table, then moved to table by a generated postaction.

table instance-attribute

table: NotRequired[GenericString]

Specifies a Snowflake table for your node to use.

table_schema instance-attribute

table_schema: NotRequired[OptionList]

Manually defines the target schema for the node. A list of structures with value , label and description keys. Each structure defines a column.

temp_dir instance-attribute

temp_dir: NotRequired[EnclosedInStringProperty]

Not currently used.

upsert instance-attribute

upsert: BooleanValue

Used when Action is append. Specifies the resolution behavior when a row already exists. If true, preexisting rows will be updated. If false, those rows will be inserted.