...
Section | User Configuration Label | Label Description | Options | Default | Variable | User Widget | ||||
---|---|---|---|---|---|---|---|---|---|---|
General | Label | Label for UI. | textbox | |||||||
Reference Name | Uniquely identified name for lineage. | referenceName | textbox | |||||||
Account Name | Full name of Snowflake account. | accountName | textbox | |||||||
Database | Database name to connect to. | database | textbox | |||||||
Import Query | Query for import data. | importQuery | textarea | |||||||
Credentials | Username | User identity for connecting to the specified database. | username | textbox | ||||||
Password | Password to use to connect to the specified database. | password | password | |||||||
Key Pair Authentication | Key Pair Authentication Enabled | If true, plugin will perform Key Pair authentication. |
| False | keyPairEnabled | toggle | ||||
Key File Path | Path to the private key file. | path | textbox | User | Snowflake login name. | user | textbox | |||
OAuth2 | OAuth2 Enabled | If true, plugin will perform OAuth2 authentication. |
| False | oauth2Enabled | toggle | ||||
Auth URL | Endpoint for the authorization server used to retrieve the authorization code. | authUrl | textbox | |||||||
Token URL | Endpoint for the resource server, which exchanges the authorization code for an access token. | tokenUrl | textbox | |||||||
Client ID | Client identifier obtained during the Application registration process. | clientId | textbox | |||||||
Client Secret | Client secret obtained during the Application registration process. | clientSecret | password | |||||||
Scopes | Scope of the access request, which might have multiple space-separated values. | scopes | textbox | |||||||
Refresh Token | Token used to receive accessToken, which is end product of OAuth2. | refreshToken | textbox | |||||||
Advanced | Bounding Query | Bounding Query should return the min and max of the values of the 'splitBy' field. For example, 'SELECT MIN(id),MAX(id) FROM table'. Not required if numSplits is set to one. | boundingQuery | textarea | ||||||
Split-By Field Name | Field Name which will be used to generate splits. Not required if numSplits is set to one. | splitBy | textbox | |||||||
Number of Splits to Generate | Number of splits to generate. | numSplits | textbox | |||||||
Connection Arguments | A list of arbitrary string tag/value pairs as connection arguments. See: https://docs.snowflake.net/manuals/user-guide/jdbc-configure.html#jdbc-driver-connection-string | connectionArguments | keyvalue |
...
Section | User Configuration Label | Label Description | Options | Default | Variable | User Widget | |||
---|---|---|---|---|---|---|---|---|---|
General | Label | Label for UI. | textbox | ||||||
Reference Name | Uniquely identified name for lineage. | referenceName | textbox | ||||||
Account Name | Full name of Snowflake account. | accountName | textbox | ||||||
Database | Database name to connect to connect to. | database | textbox | ||||||
Table Name | Name of a database table to write to. | table | textbox | ||||||
Credentials | Username | User identity for connecting to the specified database. | username | textbox | |||||
Password | Password to use to connect to the specified database. | password | password | ||||||
Key Pair Authentication | Key Pair Authentication Enabled | If true, plugin will perform Key Pair authentication. |
| False | keyPairEnabled | toggle | |||
Key File Path | Path to the private key file. | path | textboxUser | Snowflake login name. | user | textbox | |||
OAuth2 | OAuth2 Enabled | If true, plugin will perform OAuth2 authentication. |
| False | oauth2Enabled | toggle | |||
Auth URL | Endpoint for the authorization server used to retrieve the authorization code. | authUrl | textbox | ||||||
Token URL | Endpoint for the resource server, which exchanges the authorization code for an access token. | tokenUrl | textbox | ||||||
Client ID | Client identifier obtained during the Application registration process. | clientId | textbox | ||||||
Client Secret | Client secret obtained during the Application registration process. | clientSecret | password | ||||||
Scopes | Scope of the access request, which might have multiple space-separated values. | scopes | textbox | ||||||
Refresh Token | Token used to receive accessToken, which is end product of OAuth2. | refreshToken | textbox | ||||||
Advanced | Connection Arguments | A list of arbitrary string tag/value pairs as connection arguments. See: https://docs.snowflake.net/manuals/user-guide/jdbc-configure.html#jdbc-driver-connection-string | connectionArguments | keyvalue |
...
CDAP Schema Data Type | Snowflake Data Types | Comment |
---|---|---|
boolean | BOOLEAN | |
bytes | BINARY | |
date | DATE | |
double | FLOAT | Snowflake uses double-precision (64 bit) IEEE 754 floating point numbers. |
decimal | NUMBER(s, p) | |
float | FLOAT | |
int | NUMBER(s, p) | Where p >= 10. It's safe to write primitives as values of decimal logical type in the case of valid precision. |
long | NUMBER(s, p) | Where p >= 19. It's safe to write primitives as values of decimal logical type in the case of valid precision. |
string | VARCHAR | |
time | TIME | |
timestamp | TIMESTAMP_NTZ | |
array | ARRAY | |
record | OBJECT | |
enum | VARCHAR | |
map | OBJECT | |
union | VARIANT |
Action Plugin Properties
Section | User Configuration Label | Label Description | Options | Default | Variable | User Widget | ||||
---|---|---|---|---|---|---|---|---|---|---|
General | Label | Label for UI | textbox | |||||||
Account Name | Full name of Snowflake account. | accountName | textbox | |||||||
Database | Database name to connect to connect to. | database | textbox | |||||||
Query | SQL query to run. | query | textarea | |||||||
Credentials | Username | User identity for connecting to the specified database. | username | textbox | ||||||
Password | Password to use to connect to the specified database. | password | password | |||||||
Key Pair Authentication | Key Pair Authentication Enabled | If true, plugin will perform Key Pair authentication. |
| False | keyPairEnabled | toggle | ||||
Key File Path | Path to the private key file. | path | textbox | User | Snowflake login name. | user | textbox | |||
OAuth2 | OAuth2 Enabled | If true, plugin will perform OAuth2 authentication. |
| False | oauth2Enabled | toggle | ||||
Auth URL | Endpoint for the authorization server used to retrieve the authorization code. | authUrl | textbox | |||||||
Token URL | Endpoint for the resource server, which exchanges the authorization code for an access token. | tokenUrl | textbox | |||||||
Client ID | Client identifier obtained during the Application registration process. | clientId | textbox | |||||||
Client Secret | Client secret obtained during the Application registration process. | clientSecret | password | |||||||
Scopes | Scope of the access request, which might have multiple space-separated values. | scopes | textbox | |||||||
Refresh Token | Token used to receive accessToken, which is end product of OAuth2. | refreshToken | textbox | |||||||
Advanced | Connection Arguments | A list of arbitrary string tag/value pairs as connection arguments. See: https://docs.snowflake.net/manuals/user-guide/jdbc-configure.html#jdbc-driver-connection-string | connectionArguments | keyvalue |
Snowflake Data Loading Action Plugin Properties
Section | User Configuration Label | Label Description | Options | Default | Variable | User Widget | Comment |
---|---|---|---|---|---|---|---|
General | Label | Label for UI | textbox | ||||
Account Name | Full name of Snowflake account. | accountName | textbox | ||||
From | Internal or external location where the files containing data to be loaded are staged | from | textbox | ||||
Into | Name of the table into which data is loaded. | table | textbox | ||||
Select | Optional SELECT statement used for transformations. Specifies an explicit set of fields/columns (separated by commas) to load from the staged data files. The fields/columns are selected from the files using a standard SQL query. The list must match the sequence of columns in the target table. | select | textarea | ||||
Credentials | Username | Login name of the user for the connection. | username | textbox | |||
Password | Password for the specified user. | password | password | ||||
Key Pair Authentication | Key Pair Authentication Enabled | If true, plugin will perform Key Pair authentication. |
| False | keyPairEnabled | toggle | |
Key File Path | Path to the private key file. | path | textbox | Displayed only if Key Pair Authentication Enabled set to true. | |||
OAuth2 | OAuth2 Enabled | If true, plugin will perform OAuth2 authentication. |
| False | oauth2Enabled | toggle | |
Auth URL | Endpoint for the authorization server used to retrieve the authorization code. | authUrl | textbox | Displayed only if OAuth2 Enabled set to true. | |||
Token URL | Endpoint for the resource server, which exchanges the authorization code for an access token. | tokenUrl | textbox | Displayed only if OAuth2 Enabled set to true. | |||
Client ID | Client identifier obtained during the Application registration process. | clientId | textbox | Displayed only if OAuth2 Enabled set to true. | |||
Client Secret | Client secret obtained during the Application registration process. | clientSecret | password | Displayed only if OAuth2 Enabled set to true. | |||
Scopes | Scope of the access request, which might have multiple space-separated values. | scopes | textbox | Displayed only if OAuth2 Enabled set to true. | |||
Refresh Token | Token used to receive accessToken, which is end product of OAuth2. | refreshToken | textbox | Displayed only if OAuth2 Enabled set to true. | |||
Cloud Provider Parameters | Use Cloud Provider Parameters | If true, plugin will use specified Cloud Provider Parameters. |
| False | useCloudProviderParameters | toggle | |
Cloud Provider |
| GCP | cloudProvider | radio-group | Displayed only if Use Cloud Provider Parameters set to true. | ||
Storage Integration | Name of the storage integration used to delegate authentication responsibility for external cloud storage to a Snowflake identity and access management (IAM) entity. For more details, see CREATE STORAGE INTEGRATION. | Displayed only if GCP or AWS Cloud Provider selected. | |||||
Key Id | Key Id for connecting to AWS and accessing the private/protected S3 bucket where the files to load are staged. For more information, see Configuring Secure Access to AWS S3. | Displayed only if AWS Cloud Provider selected. | |||||
Secret Key | Secret Key for connecting to AWS and accessing the private/protected S3 bucket where the files to load are staged. For more information, see Configuring Secure Access to AWS S3. | Displayed only if AWS Cloud Provider selected. | |||||
Token | Token for connecting to AWS and accessing the private/protected S3 bucket where the files to load are staged. For more information, see Configuring Secure Access to AWS S3. | Displayed only if AWS Cloud Provider selected. | |||||
SAS Token | Shared access signature token for connecting to Azure and accessing the private/protected container where the files containing data are staged. Credentials are generated by Azure. | Displayed only if Microsoft Azure Cloud Provider selected. | |||||
Files Encrypted |
| False | Displayed only if AWS or Microsoft Azure Cloud Provider selected. | ||||
Encryption Type | Encryption type used. | For AWS:
For Azure:
| Displayed only if Files Encrypted set to true. | ||||
Master Key | Client-side master key that was used to encrypt the files in the bucket. The master key must be a 128-bit or 256-bit key in Base64-encoded form. Snowflake requires this key to decrypt encrypted files in the bucket and extract data for loading. | Displayed only if to AWS_CSE or AZURE_CSE Encryption Type selected. | |||||
Master Key Id | AWS Master Key ID. | Displayed only if to AWS_SSE_KMS Encryption Type selected. | |||||
Advanced | Connection Arguments | A list of arbitrary string tag/value pairs as connection arguments. See: https://docs.snowflake.net/manuals/user-guide/jdbc-configure.html#jdbc-driver-connection-string | connectionArguments | keyvalue |
Snowflake Data Unloading Action Plugin Properties
...