/snowflake-cloud-objects | Type: Application | PCID required: Yes
Tools
snowflake_cloud_objects_clone_table
Clone table Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
createMode | string | No | — | Parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource. |
copyGrants | boolean | No | — | Parameter to enable copy grants when creating the object. |
targetDatabase | string | No | — | Database of the newly created table. Defaults to the source table’s database. |
targetSchema | string | No | — | Schema of the newly created table. Defaults to the source table’s schema. |
automatic_clustering | boolean | No | — | If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the table. |
budget | string | No | — | Name of the budget if the object is monitored by a budget |
bytes | integer | No | — | Number of bytes that will be scanned if the entire table is scanned in a query. Note that this number may be different than the number of actual physical bytes stored on-disk for the table |
change_tracking | boolean | No | — | Change tracking is enabled or disabled |
cluster_by | string[] | No | — | Specifies one or more columns or column expressions in the table as the clustering key |
columns | object[] | No | — | The columns value |
comment | string | No | — | Comment for the table |
constraints | object[] | No | — | The constraints value |
created_on | string | No | — | Date and time when the table was created. |
data_retention_time_in_days | integer | No | — | Specifies the retention period for the table so that Time Travel actions SELECT, CLONE, UNDROP can be performed on historical data in the table |
database_name | string | No | — | Database in which the table is stored |
default_ddl_collation | string | No | — | Specifies a default collation specification for the columns in the table, including columns added to the table in the future |
dropped_on | string | No | — | Date and time when the table was dropped |
enable_schema_evolution | boolean | No | — | Table has schema evolution enabled or disabled |
kind | string | No | — | Table type - permanent, transient, or temporary |
max_data_extension_time_in_days | integer | No | — | Specifies the retention period for the table so that Time Travel actions SELECT, CLONE, UNDROP can be performed on historical data in the table |
owner | string | No | — | Role that owns the table |
owner_role_type | string | No | — | The type of role that owns the object. |
point_of_time | object | No | — | Point of time. |
rows | integer | No | — | Number of rows in the table. Returns NULL for external tables. |
schema_name | string | No | — | Schema in which the table is stored |
search_optimization | boolean | No | — | If ON, the table has the search optimization service enabled |
search_optimization_bytes | integer | No | — | Number of additional bytes of storage that the search optimization service consumes for this table |
search_optimization_progress | integer | No | — | Percentage of the table that has been optimized for search. |
table_type | string | No | — | Type of the table |
target_name | string | No | — | Name for the cloned table. If omitted, the clone will have the same name as the source (requires targetDatabase or targetSchema to avoid conflict). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"name": {
"type": "string",
"description": "Identifier (i.e. name) for the resource."
},
"createMode": {
"type": "string",
"description": "Parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.",
"enum": [
"errorIfExists",
"orReplace",
"ifNotExists"
]
},
"copyGrants": {
"type": "boolean",
"description": "Parameter to enable copy grants when creating the object."
},
"targetDatabase": {
"type": "string",
"description": "Database of the newly created table. Defaults to the source table's database."
},
"targetSchema": {
"type": "string",
"description": "Schema of the newly created table. Defaults to the source table's schema."
},
"automatic_clustering": {
"type": "boolean",
"description": "If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the table."
},
"budget": {
"type": "string",
"description": "Name of the budget if the object is monitored by a budget"
},
"bytes": {
"type": "integer",
"description": "Number of bytes that will be scanned if the entire table is scanned in a query. Note that this number may be different than the number of actual physical bytes stored on-disk for the table"
},
"change_tracking": {
"type": "boolean",
"description": "Change tracking is enabled or disabled"
},
"cluster_by": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies one or more columns or column expressions in the table as the clustering key"
},
"columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Column name"
},
"datatype": {
"type": "string",
"description": "The data type for the column"
},
"nullable": {
"type": "boolean",
"description": "Specifies that the column does allow NULL values or not."
},
"collate": {
"type": "string",
"description": "Specifies the collation to use for column operations such as string comparison"
},
"default": {
"type": "string",
"description": "Specifies whether a default value is automatically inserted in the column if a value is not explicitly specified via an INSERT or CREATE TABLE AS SELECT statement"
},
"autoincrement": {
"type": "boolean",
"description": "The autoincrement value"
},
"autoincrement_start": {
"type": "integer",
"description": "The default value for the column starts with the specified number"
},
"autoincrement_increment": {
"type": "integer",
"description": "Each successive value for the column automatically increments by the specified amount"
},
"constraints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Constraint"
},
"column_names": {
"type": "array"
},
"constraint_type": {
"type": "string",
"description": "Type of the constraint"
}
}
},
"description": "The constraints value"
},
"comment": {
"type": "string",
"description": "Specifies a comment for the column"
}
},
"required": [
"name",
"datatype"
]
},
"description": "The columns value"
},
"comment": {
"type": "string",
"description": "Comment for the table"
},
"constraints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Constraint"
},
"column_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "Column Names"
},
"constraint_type": {
"type": "string",
"description": "Type of the constraint"
}
}
},
"description": "The constraints value"
},
"created_on": {
"type": "string",
"description": "Date and time when the table was created."
},
"data_retention_time_in_days": {
"type": "integer",
"description": "Specifies the retention period for the table so that Time Travel actions SELECT, CLONE, UNDROP can be performed on historical data in the table"
},
"database_name": {
"type": "string",
"description": "Database in which the table is stored"
},
"default_ddl_collation": {
"type": "string",
"description": "Specifies a default collation specification for the columns in the table, including columns added to the table in the future"
},
"dropped_on": {
"type": "string",
"description": "Date and time when the table was dropped"
},
"enable_schema_evolution": {
"type": "boolean",
"description": "Table has schema evolution enabled or disabled"
},
"kind": {
"type": "string",
"description": "Table type - permanent, transient, or temporary",
"enum": [
"PERMANENT",
"TRANSIENT",
"TEMPORARY",
"",
"transient",
"temporary"
]
},
"max_data_extension_time_in_days": {
"type": "integer",
"description": "Specifies the retention period for the table so that Time Travel actions SELECT, CLONE, UNDROP can be performed on historical data in the table"
},
"owner": {
"type": "string",
"description": "Role that owns the table"
},
"owner_role_type": {
"type": "string",
"description": "The type of role that owns the object."
},
"point_of_time": {
"type": "object",
"description": "Point of time.",
"properties": {
"point_of_time_type": {
"type": "string",
"description": "Type of the point of time. Possible values include: - `timestamp`: Exact time using the standard timezone format. Example: `TO_TIMESTAMP(1749423600)`. - `offset`: Interval relative to 'now.' in the form -N where N can be an integer or arithmetic expression. Example: `-120` - `statement`: ID of a query statement to use as the reference point for <a href=https://docs.snowflake.com/en/sql-reference/sql/create-clone#time-travel-parameters>Time Travel</a>. For more information, see https://docs.snowflake.com/en/sql-reference/data-types-datetime."
},
"reference": {
"type": "string",
"description": "Relation to the point of time. Currently, the API supports `at` and `before`."
}
},
"required": [
"point_of_time_type"
]
},
"rows": {
"type": "integer",
"description": "Number of rows in the table. Returns NULL for external tables."
},
"schema_name": {
"type": "string",
"description": "Schema in which the table is stored"
},
"search_optimization": {
"type": "boolean",
"description": "If ON, the table has the search optimization service enabled"
},
"search_optimization_bytes": {
"type": "integer",
"description": "Number of additional bytes of storage that the search optimization service consumes for this table"
},
"search_optimization_progress": {
"type": "integer",
"description": "Percentage of the table that has been optimized for search."
},
"table_type": {
"type": "string",
"description": "Type of the table",
"enum": [
"NORMAL",
"DYNAMIC",
"EXTERNAL",
"EVENT",
"HYBRID",
"ICEBERG",
"IMMUTABLE"
]
},
"target_name": {
"type": "string",
"description": "Name for the cloned table. If omitted, the clone will have the same name as the source (requires targetDatabase or targetSchema to avoid conflict)."
}
},
"required": [
"PCID",
"database",
"schema",
"name"
]
}
snowflake_cloud_objects_create_database
Create a database. Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
createMode | string | No | — | Parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource. | |
kind | string | No | — | Type of database to create. Currently, Snowflake supports only transient and permanent (also represented by the empty string). | |
budget | string | No | — | Budget that defines a monthly spending limit on the compute costs for a Snowflake account or a custom group of Snowflake objects. | |
comment | string | No | — | Optional comment in which to store information related to the database. | |
created_on | string | No | — | Date and time the database was created. | |
data_retention_time_in_days | integer | No | — | Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database. | |
default_ddl_collation | string | No | — | Default collation specification for all schemas and tables added to the database. You an override the default at the schema and individual table levels. | |
dropped_on | string | null | No | — | Date and time the database was dropped. |
is_current | boolean | No | — | Current database for the session. | |
is_default | boolean | No | — | Whether the database is the default database for a user. | |
log_level | string | No | — | Severity level of messages that should be ingested and made available in the active event table. Currently, Snowflake supports only TRACE, DEBUG, INFO, WARN, ERROR, FATAL and OFF. | |
max_data_extension_time_in_days | integer | No | — | Maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale. | |
name | string | Yes | — | A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive. | |
options | string | No | — | The options value | |
origin | string | No | — | The origin value | |
owner | string | No | — | Name of the role that owns the database. | |
owner_role_type | string | No | — | Type of role that owns the object, either ROLE or DATABASE_ROLE | |
retention_time | integer | No | — | Number of days that historical data is retained for Time Travel. | |
serverless_task_max_statement_size | string | No | — | Specifies the maximum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. | |
serverless_task_min_statement_size | string | No | — | Specifies the minimum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. | |
suspend_task_after_num_failures | integer | No | — | Maximum number of consecutive failed task runs before the current task is suspended automatically. | |
trace_level | string | No | — | How trace events are ingested into the event table. Currently, Snowflake supports only ALWAYS, ON_EVENT, and OFF. | |
user_task_managed_initial_warehouse_size | string | No | — | Size of the compute resources to provision for the first run of the serverless task, before a task history is available for Snowflake to determine an ideal size. | |
user_task_timeout_ms | integer | No | — | Time limit, in milliseconds, for a single run of the task before it times out. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"createMode": {
"type": "string",
"description": "Parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.",
"enum": [
"errorIfExists",
"orReplace",
"ifNotExists"
]
},
"kind": {
"type": "string",
"description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)."
},
"budget": {
"type": "string",
"description": "Budget that defines a monthly spending limit on the compute costs for a Snowflake account or a custom group of Snowflake objects."
},
"comment": {
"type": "string",
"description": "Optional comment in which to store information related to the database."
},
"created_on": {
"type": "string",
"description": "Date and time the database was created."
},
"data_retention_time_in_days": {
"type": "integer",
"description": "Specifies the number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the database, as well as specifying the default Time Travel retention time for all schemas created in the database."
},
"default_ddl_collation": {
"type": "string",
"description": "Default collation specification for all schemas and tables added to the database. You an override the default at the schema and individual table levels."
},
"dropped_on": {
"type": [
"string",
"null"
],
"description": "Date and time the database was dropped."
},
"is_current": {
"type": "boolean",
"description": "Current database for the session."
},
"is_default": {
"type": "boolean",
"description": "Whether the database is the default database for a user."
},
"log_level": {
"type": "string",
"description": "Severity level of messages that should be ingested and made available in the active event table. Currently, Snowflake supports only `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL` and `OFF`."
},
"max_data_extension_time_in_days": {
"type": "integer",
"description": "Maximum number of days for which Snowflake can extend the data retention period for tables in the database to prevent streams on the tables from becoming stale."
},
"name": {
"type": "string",
"description": "A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive."
},
"options": {
"type": "string",
"description": "The options value"
},
"origin": {
"type": "string",
"description": "The origin value"
},
"owner": {
"type": "string",
"description": "Name of the role that owns the database."
},
"owner_role_type": {
"type": "string",
"description": "Type of role that owns the object, either ROLE or DATABASE_ROLE"
},
"retention_time": {
"type": "integer",
"description": "Number of days that historical data is retained for Time Travel."
},
"serverless_task_max_statement_size": {
"type": "string",
"description": "Specifies the maximum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE."
},
"serverless_task_min_statement_size": {
"type": "string",
"description": "Specifies the minimum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE."
},
"suspend_task_after_num_failures": {
"type": "integer",
"description": "Maximum number of consecutive failed task runs before the current task is suspended automatically."
},
"trace_level": {
"type": "string",
"description": "How trace events are ingested into the event table. Currently, Snowflake supports only `ALWAYS`, `ON_EVENT`, and `OFF`."
},
"user_task_managed_initial_warehouse_size": {
"type": "string",
"description": "Size of the compute resources to provision for the first run of the serverless task, before a task history is available for Snowflake to determine an ideal size."
},
"user_task_timeout_ms": {
"type": "integer",
"description": "Time limit, in milliseconds, for a single run of the task before it times out."
}
},
"required": [
"PCID",
"name"
]
}
snowflake_cloud_objects_create_schema
Create a schema. Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. | |
createMode | string | No | — | Parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource. | |
kind | string | No | — | Type of schema to create. Currently, Snowflake supports only transient and permanent (also represented by the empty string). | |
budget | string | No | — | Budget that defines a monthly spending limit on the compute costs for a Snowflake account or a custom group of Snowflake objects. | |
comment | string | No | — | Optional comment in which to store information related to the schema. | |
created_on | string | No | — | Date and time the schema was created. | |
data_retention_time_in_days | integer | No | — | Number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the schema, as well as specifying the default Time Travel retention time for all tables created in the schema | |
database_name | string | No | — | Database that the schema belongs to | |
default_ddl_collation | string | No | — | Specifies a default collation specification for all tables added to the schema. You an override the default at the schema and individual table levels. | |
dropped_on | string | null | No | — | Date and time the schema was dropped. |
is_current | boolean | No | — | Current schema for the session. | |
is_default | boolean | No | — | Default schema for a user. | |
log_level | string | No | — | Severity level of messages that should be ingested and made available in the active event table. Currently, Snowflake supports only TRACE, DEBUG, INFO, WARN, ERROR, FATAL and OFF. | |
managed_access | boolean | No | — | Whether this schema is a managed access schema that centralizes privilege management with the schema owner. | |
max_data_extension_time_in_days | integer | No | — | Maximum number of days for which Snowflake can extend the data retention period for tables in the schema to prevent streams on the tables from becoming stale. | |
name | string | Yes | — | A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive. | |
options | string | No | — | The options value | |
owner | string | No | — | Name of the role that owns the schema. | |
owner_role_type | string | No | — | Type of role that owns the object, either ROLE or DATABASE_ROLE. | |
pipe_execution_paused | boolean | No | — | Whether pipe execution is paused. | |
retention_time | integer | No | — | Number of days that historical data is retained for Time Travel. | |
serverless_task_max_statement_size | string | No | — | Specifies the maximum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. | |
serverless_task_min_statement_size | string | No | — | Specifies the minimum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE. | |
suspend_task_after_num_failures | integer | No | — | Specifies the number of consecutive failed task runs after which the current task is suspended automatically. | |
trace_level | string | No | — | How trace events are ingested into the event table. Currently, Snowflake supports only ALWAYS, ON_EVENT, and OFF. | |
user_task_managed_initial_warehouse_size | string | No | — | Size of the compute resources to provision for the first run of the serverless task, before a task history is available for Snowflake to determine an ideal size. | |
user_task_timeout_ms | integer | No | — | Time limit, in milliseconds, for a single run of the task before it times out. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"createMode": {
"type": "string",
"description": "Parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.",
"enum": [
"errorIfExists",
"orReplace",
"ifNotExists"
]
},
"kind": {
"type": "string",
"description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)."
},
"budget": {
"type": "string",
"description": "Budget that defines a monthly spending limit on the compute costs for a Snowflake account or a custom group of Snowflake objects."
},
"comment": {
"type": "string",
"description": "Optional comment in which to store information related to the schema."
},
"created_on": {
"type": "string",
"description": "Date and time the schema was created."
},
"data_retention_time_in_days": {
"type": "integer",
"description": "Number of days for which Time Travel actions (CLONE and UNDROP) can be performed on the schema, as well as specifying the default Time Travel retention time for all tables created in the schema"
},
"database_name": {
"type": "string",
"description": "Database that the schema belongs to"
},
"default_ddl_collation": {
"type": "string",
"description": "Specifies a default collation specification for all tables added to the schema. You an override the default at the schema and individual table levels."
},
"dropped_on": {
"type": [
"string",
"null"
],
"description": "Date and time the schema was dropped."
},
"is_current": {
"type": "boolean",
"description": "Current schema for the session."
},
"is_default": {
"type": "boolean",
"description": "Default schema for a user."
},
"log_level": {
"type": "string",
"description": "Severity level of messages that should be ingested and made available in the active event table. Currently, Snowflake supports only `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL` and `OFF`."
},
"managed_access": {
"type": "boolean",
"description": "Whether this schema is a managed access schema that centralizes privilege management with the schema owner."
},
"max_data_extension_time_in_days": {
"type": "integer",
"description": "Maximum number of days for which Snowflake can extend the data retention period for tables in the schema to prevent streams on the tables from becoming stale."
},
"name": {
"type": "string",
"description": "A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive."
},
"options": {
"type": "string",
"description": "The options value"
},
"owner": {
"type": "string",
"description": "Name of the role that owns the schema."
},
"owner_role_type": {
"type": "string",
"description": "Type of role that owns the object, either `ROLE` or `DATABASE_ROLE`."
},
"pipe_execution_paused": {
"type": "boolean",
"description": "Whether pipe execution is paused."
},
"retention_time": {
"type": "integer",
"description": "Number of days that historical data is retained for Time Travel."
},
"serverless_task_max_statement_size": {
"type": "string",
"description": "Specifies the maximum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE."
},
"serverless_task_min_statement_size": {
"type": "string",
"description": "Specifies the minimum allowed warehouse size for the serverless task. Minimum XSMALL, Maximum XXLARGE."
},
"suspend_task_after_num_failures": {
"type": "integer",
"description": "Specifies the number of consecutive failed task runs after which the current task is suspended automatically."
},
"trace_level": {
"type": "string",
"description": "How trace events are ingested into the event table. Currently, Snowflake supports only `ALWAYS`, `ON_EVENT`, and `OFF`."
},
"user_task_managed_initial_warehouse_size": {
"type": "string",
"description": "Size of the compute resources to provision for the first run of the serverless task, before a task history is available for Snowflake to determine an ideal size."
},
"user_task_timeout_ms": {
"type": "integer",
"description": "Time limit, in milliseconds, for a single run of the task before it times out."
}
},
"required": [
"PCID",
"database",
"name"
]
}
snowflake_cloud_objects_create_stage
Create a stage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
createMode | string | No | — | Parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource. |
cloud | string | No | — | Cloud provider; always NULL for an internal stage. |
comment | string | No | — | Specifies a comment for the stage. |
created_on | string | No | — | Date and time when the stage was created. |
credentials | object | No | — | Specifies the credentials of the stage. |
directory_table | object | No | — | Directory table parameters of the stage. |
encryption | object | No | — | Encryption parameters of the stage. |
endpoint | string | No | — | The S3-compatible API endpoint associated with the stage; always NULL for stages that are not S3-compatible. |
has_credentials | boolean | No | — | Indicates that the external stage has access credentials; always false for an internal stage. |
has_encryption_key | boolean | No | — | Indicates that the external stage contains encrypted files; always false for an internal stage. |
kind | string | No | — | Specifies whether the stage is permanent or temporary. |
name | string | Yes | — | A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive. |
owner | string | No | — | Role that owns the stage. |
owner_role_type | string | No | — | The type of role that owns the object, either ROLE or DATABASE_ROLE. If a Snowflake Native App owns the object, the value is APPLICATION. Snowflake returns NULL if you delete the object because a deleted object does not have an owner role. |
region | string | No | — | Region where the stage is located. |
storage_integration | string | No | — | A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive. |
url | string | No | — | URL for the external stage; blank for an internal stage. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"createMode": {
"type": "string",
"description": "Parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.",
"enum": [
"errorIfExists",
"orReplace",
"ifNotExists"
]
},
"cloud": {
"type": "string",
"description": "Cloud provider; always NULL for an internal stage."
},
"comment": {
"type": "string",
"description": "Specifies a comment for the stage."
},
"created_on": {
"type": "string",
"description": "Date and time when the stage was created."
},
"credentials": {
"type": "object",
"description": "Specifies the credentials of the stage.",
"properties": {
"credential_type": {
"type": "string",
"description": "Type of the credential, can be either AWS or AZURE."
}
}
},
"directory_table": {
"type": "object",
"description": "Directory table parameters of the stage.",
"properties": {
"enable": {
"type": "boolean",
"description": "Specifies whether to add a directory table to the stage. When the value is TRUE, a directory table is created with the stage."
},
"refresh_on_create": {
"type": "boolean",
"description": "Specifies whether to automatically refresh the directory table metadata once, immediately after the stage is created."
},
"auto_refresh": {
"type": "boolean",
"description": "Specifies whether Snowflake should enable triggering automatic refreshes of the directory table metadata when new or updated data files are available in the named external stage specified in the URL value."
},
"notification_integration": {
"type": "string",
"description": "Specifies the name of the notification integration used to automatically refresh the directory table metadata."
}
}
},
"encryption": {
"type": "object",
"description": "Encryption parameters of the stage.",
"properties": {
"type": {
"type": "string",
"description": "Specifies the encryption type used.",
"enum": [
"SNOWFLAKE_FULL",
"SNOWFLAKE_SSE",
"AWS_CSE",
"AWS_SSE_S3",
"AWS_SSE_KMS",
"GCS_SSE_KMS",
"AZURE_CSE",
"NONE"
]
},
"master_key": {
"type": "string",
"description": "Specifies the client-side master key used to encrypt the files in the bucket. The master key must be a 128-bit or 256-bit key in Base64-encoded form."
},
"kms_key_id": {
"type": "string",
"description": "Optionally specifies the ID for the KMS-managed key used to encrypt files unloaded into the bucket."
}
}
},
"endpoint": {
"type": "string",
"description": "The S3-compatible API endpoint associated with the stage; always NULL for stages that are not S3-compatible."
},
"has_credentials": {
"type": "boolean",
"description": "Indicates that the external stage has access credentials; always false for an internal stage."
},
"has_encryption_key": {
"type": "boolean",
"description": "Indicates that the external stage contains encrypted files; always false for an internal stage."
},
"kind": {
"type": "string",
"description": "Specifies whether the stage is permanent or temporary.",
"enum": [
"PERMANENT",
"TEMPORARY"
]
},
"name": {
"type": "string",
"description": "A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive."
},
"owner": {
"type": "string",
"description": "Role that owns the stage."
},
"owner_role_type": {
"type": "string",
"description": "The type of role that owns the object, either ROLE or DATABASE_ROLE. If a Snowflake Native App owns the object, the value is APPLICATION. Snowflake returns NULL if you delete the object because a deleted object does not have an owner role."
},
"region": {
"type": "string",
"description": "Region where the stage is located."
},
"storage_integration": {
"type": "string",
"description": "A Snowflake object identifier. If the identifier contains spaces or special characters, the entire string must be enclosed in double quotes. Identifiers enclosed in double quotes are also case-sensitive."
},
"url": {
"type": "string",
"description": "URL for the external stage; blank for an internal stage."
}
},
"required": [
"PCID",
"database",
"schema",
"name"
]
}
snowflake_cloud_objects_create_table
Create a table (clone and undrop are separate subresources) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
createMode | string | No | — | Parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource. |
copyGrants | boolean | No | — | Parameter to enable copy grants when creating the object. |
automatic_clustering | boolean | No | — | If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the table. |
budget | string | No | — | Name of the budget if the object is monitored by a budget |
bytes | integer | No | — | Number of bytes that will be scanned if the entire table is scanned in a query. Note that this number may be different than the number of actual physical bytes stored on-disk for the table |
change_tracking | boolean | No | — | Change tracking is enabled or disabled |
cluster_by | string[] | No | — | Specifies one or more columns or column expressions in the table as the clustering key |
columns | object[] | No | — | The columns value |
comment | string | No | — | Comment for the table |
constraints | object[] | No | — | The constraints value |
created_on | string | No | — | Date and time when the table was created. |
data_retention_time_in_days | integer | No | — | Specifies the retention period for the table so that Time Travel actions SELECT, CLONE, UNDROP can be performed on historical data in the table |
database_name | string | No | — | Database in which the table is stored |
default_ddl_collation | string | No | — | Specifies a default collation specification for the columns in the table, including columns added to the table in the future |
dropped_on | string | No | — | Date and time when the table was dropped |
enable_schema_evolution | boolean | No | — | Table has schema evolution enabled or disabled |
kind | string | No | — | Table type - permanent, transient, or temporary |
max_data_extension_time_in_days | integer | No | — | Specifies the retention period for the table so that Time Travel actions SELECT, CLONE, UNDROP can be performed on historical data in the table |
name | string | Yes | — | Specifies the name for the table, must be unique for the schema in which the table is created |
owner | string | No | — | Role that owns the table |
owner_role_type | string | No | — | The type of role that owns the object. |
rows | integer | No | — | Number of rows in the table. Returns NULL for external tables. |
schema_name | string | No | — | Schema in which the table is stored |
search_optimization | boolean | No | — | If ON, the table has the search optimization service enabled |
search_optimization_bytes | integer | No | — | Number of additional bytes of storage that the search optimization service consumes for this table |
search_optimization_progress | integer | No | — | Percentage of the table that has been optimized for search. |
table_type | string | No | — | Type of the table |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"createMode": {
"type": "string",
"description": "Parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.",
"enum": [
"errorIfExists",
"orReplace",
"ifNotExists"
]
},
"copyGrants": {
"type": "boolean",
"description": "Parameter to enable copy grants when creating the object."
},
"automatic_clustering": {
"type": "boolean",
"description": "If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the table."
},
"budget": {
"type": "string",
"description": "Name of the budget if the object is monitored by a budget"
},
"bytes": {
"type": "integer",
"description": "Number of bytes that will be scanned if the entire table is scanned in a query. Note that this number may be different than the number of actual physical bytes stored on-disk for the table"
},
"change_tracking": {
"type": "boolean",
"description": "Change tracking is enabled or disabled"
},
"cluster_by": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies one or more columns or column expressions in the table as the clustering key"
},
"columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Column name"
},
"datatype": {
"type": "string",
"description": "The data type for the column"
},
"nullable": {
"type": "boolean",
"description": "Specifies that the column does allow NULL values or not."
},
"collate": {
"type": "string",
"description": "Specifies the collation to use for column operations such as string comparison"
},
"default": {
"type": "string",
"description": "Specifies whether a default value is automatically inserted in the column if a value is not explicitly specified via an INSERT or CREATE TABLE AS SELECT statement"
},
"autoincrement": {
"type": "boolean",
"description": "The autoincrement value"
},
"autoincrement_start": {
"type": "integer",
"description": "The default value for the column starts with the specified number"
},
"autoincrement_increment": {
"type": "integer",
"description": "Each successive value for the column automatically increments by the specified amount"
},
"constraints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Constraint"
},
"column_names": {
"type": "array"
},
"constraint_type": {
"type": "string",
"description": "Type of the constraint"
}
}
},
"description": "The constraints value"
},
"comment": {
"type": "string",
"description": "Specifies a comment for the column"
}
},
"required": [
"name",
"datatype"
]
},
"description": "The columns value"
},
"comment": {
"type": "string",
"description": "Comment for the table"
},
"constraints": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the Constraint"
},
"column_names": {
"type": "array",
"items": {
"type": "string"
},
"description": "Column Names"
},
"constraint_type": {
"type": "string",
"description": "Type of the constraint"
}
}
},
"description": "The constraints value"
},
"created_on": {
"type": "string",
"description": "Date and time when the table was created."
},
"data_retention_time_in_days": {
"type": "integer",
"description": "Specifies the retention period for the table so that Time Travel actions SELECT, CLONE, UNDROP can be performed on historical data in the table"
},
"database_name": {
"type": "string",
"description": "Database in which the table is stored"
},
"default_ddl_collation": {
"type": "string",
"description": "Specifies a default collation specification for the columns in the table, including columns added to the table in the future"
},
"dropped_on": {
"type": "string",
"description": "Date and time when the table was dropped"
},
"enable_schema_evolution": {
"type": "boolean",
"description": "Table has schema evolution enabled or disabled"
},
"kind": {
"type": "string",
"description": "Table type - permanent, transient, or temporary",
"enum": [
"PERMANENT",
"TRANSIENT",
"TEMPORARY",
"",
"transient",
"temporary"
]
},
"max_data_extension_time_in_days": {
"type": "integer",
"description": "Specifies the retention period for the table so that Time Travel actions SELECT, CLONE, UNDROP can be performed on historical data in the table"
},
"name": {
"type": "string",
"description": "Specifies the name for the table, must be unique for the schema in which the table is created"
},
"owner": {
"type": "string",
"description": "Role that owns the table"
},
"owner_role_type": {
"type": "string",
"description": "The type of role that owns the object."
},
"rows": {
"type": "integer",
"description": "Number of rows in the table. Returns NULL for external tables."
},
"schema_name": {
"type": "string",
"description": "Schema in which the table is stored"
},
"search_optimization": {
"type": "boolean",
"description": "If ON, the table has the search optimization service enabled"
},
"search_optimization_bytes": {
"type": "integer",
"description": "Number of additional bytes of storage that the search optimization service consumes for this table"
},
"search_optimization_progress": {
"type": "integer",
"description": "Percentage of the table that has been optimized for search."
},
"table_type": {
"type": "string",
"description": "Type of the table",
"enum": [
"NORMAL",
"DYNAMIC",
"EXTERNAL",
"EVENT",
"HYBRID",
"ICEBERG",
"IMMUTABLE"
]
}
},
"required": [
"PCID",
"database",
"schema",
"name"
]
}
snowflake_cloud_objects_create_view
Create a view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
createMode | string | No | — | Parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource. |
copyGrants | boolean | No | — | Parameter to enable copy grants when creating the object. |
columns | object[] | Yes | — | The columns of the view |
comment | string | No | — | user comment associated to an object in the dictionary |
created_on | string | No | — | Date and time when the view was created. |
database_name | string | No | — | Database in which the view is stored |
kind | string | No | — | Kind of the view, permanent (default) or temporary |
name | string | Yes | — | Name of the view |
owner | string | No | — | Role that owns the view |
owner_role_type | string | No | — | The type of role that owns the view |
query | string | Yes | — | Query used to create the view |
recursive | boolean | No | — | Whether or not this view can refer to itself using recursive syntax withot requiring a CTE (common table expression) |
schema_name | string | No | — | Schema in which the view is stored |
secure | boolean | No | — | Whether or not this view is secure |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"createMode": {
"type": "string",
"description": "Parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.",
"enum": [
"errorIfExists",
"orReplace",
"ifNotExists"
]
},
"copyGrants": {
"type": "boolean",
"description": "Parameter to enable copy grants when creating the object."
},
"columns": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Column name"
},
"comment": {
"type": "string",
"description": "Specifies a comment for the column"
},
"datatype": {
"type": "string",
"description": "The data type for the column"
}
},
"required": [
"name"
]
},
"description": "The columns of the view"
},
"comment": {
"type": "string",
"description": "user comment associated to an object in the dictionary"
},
"created_on": {
"type": "string",
"description": "Date and time when the view was created."
},
"database_name": {
"type": "string",
"description": "Database in which the view is stored"
},
"kind": {
"type": "string",
"description": "Kind of the view, permanent (default) or temporary",
"enum": [
"PERMANENT",
"TEMPORARY"
]
},
"name": {
"type": "string",
"description": "Name of the view"
},
"owner": {
"type": "string",
"description": "Role that owns the view"
},
"owner_role_type": {
"type": "string",
"description": "The type of role that owns the view"
},
"query": {
"type": "string",
"description": "Query used to create the view"
},
"recursive": {
"type": "boolean",
"description": "Whether or not this view can refer to itself using recursive syntax withot requiring a CTE (common table expression)"
},
"schema_name": {
"type": "string",
"description": "Schema in which the view is stored"
},
"secure": {
"type": "boolean",
"description": "Whether or not this view is secure"
}
},
"required": [
"PCID",
"database",
"schema",
"columns",
"name",
"query"
]
}
snowflake_cloud_objects_delete_database
Delete a database. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Identifier (i.e. name) for the resource. |
ifExists | boolean | No | — | Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist. |
restrict | boolean | No | — | Whether to drop the database if foreign keys exist that reference any tables in the database. - true: Return a warning about existing foreign key references and don’t drop the database. - false: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Identifier (i.e. name) for the resource."
},
"ifExists": {
"type": "boolean",
"description": "Parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist."
},
"restrict": {
"type": "boolean",
"description": "Whether to drop the database if foreign keys exist that reference any tables in the database. - `true`: Return a warning about existing foreign key references and don't drop the database. - `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables."
}
},
"required": [
"PCID",
"name"
]
}
snowflake_cloud_objects_delete_schema
Delete a schema. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
ifExists | boolean | No | — | Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist. |
restrict | boolean | No | — | Whether to drop the schema if foreign keys exist that reference any tables in the schema. - true: Return a warning about existing foreign key references and don’t drop the schema. - false: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables. Default: false. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"name": {
"type": "string",
"description": "Identifier (i.e. name) for the resource."
},
"ifExists": {
"type": "boolean",
"description": "Parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist."
},
"restrict": {
"type": "boolean",
"description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema. - `true`: Return a warning about existing foreign key references and don't drop the schema. - `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables. Default: `false`."
}
},
"required": [
"PCID",
"database",
"name"
]
}
snowflake_cloud_objects_delete_stage
Delete a stage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
ifExists | boolean | No | — | Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"name": {
"type": "string",
"description": "Identifier (i.e. name) for the resource."
},
"ifExists": {
"type": "boolean",
"description": "Parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist."
}
},
"required": [
"PCID",
"database",
"schema",
"name"
]
}
snowflake_cloud_objects_delete_table
Delete a table Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
ifExists | boolean | No | — | Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"name": {
"type": "string",
"description": "Identifier (i.e. name) for the resource."
},
"ifExists": {
"type": "boolean",
"description": "Parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist."
}
},
"required": [
"PCID",
"database",
"schema",
"name"
]
}
snowflake_cloud_objects_delete_view
Delete a view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
ifExists | boolean | No | — | Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"name": {
"type": "string",
"description": "Identifier (i.e. name) for the resource."
},
"ifExists": {
"type": "boolean",
"description": "Parameter that specifies how to handle the request for a resource that does not exist: - `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - `false`: The endpoint throws an error if the resource doesn't exist."
}
},
"required": [
"PCID",
"database",
"schema",
"name"
]
}
snowflake_cloud_objects_fetch_database
Fetches a database. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Identifier (i.e. name) for the resource. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Identifier (i.e. name) for the resource."
}
},
"required": [
"PCID",
"name"
]
}
snowflake_cloud_objects_fetch_schema
Fetches a schema. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"name": {
"type": "string",
"description": "Identifier (i.e. name) for the resource."
}
},
"required": [
"PCID",
"database",
"name"
]
}
snowflake_cloud_objects_fetch_stage
Fetch a stage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"name": {
"type": "string",
"description": "Identifier (i.e. name) for the resource."
}
},
"required": [
"PCID",
"database",
"schema",
"name"
]
}
snowflake_cloud_objects_fetch_table
Fetch a table. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"name": {
"type": "string",
"description": "Identifier (i.e. name) for the resource."
}
},
"required": [
"PCID",
"database",
"schema",
"name"
]
}
snowflake_cloud_objects_fetch_view
Fetch a view Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"name": {
"type": "string",
"description": "Identifier (i.e. name) for the resource."
}
},
"required": [
"PCID",
"database",
"schema",
"name"
]
}
snowflake_cloud_objects_list_databases
List databases. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
like | string | No | — | Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. |
startsWith | string | No | — | Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching. |
showLimit | integer | No | — | Parameter to limit the maximum number of rows returned by a command. |
fromName | string | No | — | Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name. |
history | boolean | No | — | Optionally includes dropped databases that have not yet been purged. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"like": {
"type": "string",
"description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters."
},
"startsWith": {
"type": "string",
"description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching."
},
"showLimit": {
"type": "integer",
"description": "Parameter to limit the maximum number of rows returned by a command."
},
"fromName": {
"type": "string",
"description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name."
},
"history": {
"type": "boolean",
"description": "Optionally includes dropped databases that have not yet been purged."
}
},
"required": [
"PCID"
]
}
snowflake_cloud_objects_list_files
List files in the stage. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
name | string | Yes | — | Identifier (i.e. name) for the resource. |
pattern | string | No | — | Parameter that filters the command output by a regular expression pattern. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"name": {
"type": "string",
"description": "Identifier (i.e. name) for the resource."
},
"pattern": {
"type": "string",
"description": "Parameter that filters the command output by a regular expression pattern."
}
},
"required": [
"PCID",
"database",
"schema",
"name"
]
}
snowflake_cloud_objects_list_schemas
List schemas. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
like | string | No | — | Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. |
startsWith | string | No | — | Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching. |
showLimit | integer | No | — | Parameter to limit the maximum number of rows returned by a command. |
fromName | string | No | — | Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name. |
history | boolean | No | — | Whether to include dropped schemas that have not yet been purged. Default: false. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"like": {
"type": "string",
"description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters."
},
"startsWith": {
"type": "string",
"description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching."
},
"showLimit": {
"type": "integer",
"description": "Parameter to limit the maximum number of rows returned by a command."
},
"fromName": {
"type": "string",
"description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name."
},
"history": {
"type": "boolean",
"description": "Whether to include dropped schemas that have not yet been purged. Default: `false`."
}
},
"required": [
"PCID",
"database"
]
}
snowflake_cloud_objects_list_stages
List stages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
like | string | No | — | Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"like": {
"type": "string",
"description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters."
}
},
"required": [
"PCID",
"database",
"schema"
]
}
snowflake_cloud_objects_list_tables
List tables Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
like | string | No | — | Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. |
startsWith | string | No | — | Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching. |
showLimit | integer | No | — | Parameter to limit the maximum number of rows returned by a command. |
fromName | string | No | — | Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name. |
history | boolean | No | — | Optionally includes dropped tables that have not yet been purged. |
deep | boolean | No | — | Optionally includes dependency information of the table. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"like": {
"type": "string",
"description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters."
},
"startsWith": {
"type": "string",
"description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching."
},
"showLimit": {
"type": "integer",
"description": "Parameter to limit the maximum number of rows returned by a command."
},
"fromName": {
"type": "string",
"description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name."
},
"history": {
"type": "boolean",
"description": "Optionally includes dropped tables that have not yet been purged."
},
"deep": {
"type": "boolean",
"description": "Optionally includes dependency information of the table."
}
},
"required": [
"PCID",
"database",
"schema"
]
}
snowflake_cloud_objects_list_views
List views Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
database | string | Yes | — | Identifier (i.e. name) for the database to which the resource belongs. You can use the /api/v2/databases GET request to get a list of available databases. |
schema | string | Yes | — | Identifier (i.e. name) for the schema to which the resource belongs. You can use the /api/v2/databases/{database}/schemas GET request to get a list of available schemas for the specified database. |
like | string | No | — | Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters. |
startsWith | string | No | — | Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching. |
showLimit | integer | No | — | Parameter to limit the maximum number of rows returned by a command. |
fromName | string | No | — | Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name. |
deep | boolean | No | — | Optionally includes dependency information of the view. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"database": {
"type": "string",
"description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases."
},
"schema": {
"type": "string",
"description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database."
},
"like": {
"type": "string",
"description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters."
},
"startsWith": {
"type": "string",
"description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching."
},
"showLimit": {
"type": "integer",
"description": "Parameter to limit the maximum number of rows returned by a command."
},
"fromName": {
"type": "string",
"description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name."
},
"deep": {
"type": "boolean",
"description": "Optionally includes dependency information of the view."
}
},
"required": [
"PCID",
"database",
"schema"
]
}