...
| 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. | storageIntegration | textbox | 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. | keyId | textbox | 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. | secretKey | textbox | 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. | token | textbox | 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. | sasToken | textbox | Displayed only if Microsoft Azure Cloud Provider selected. | |||
| Files Encrypted |
| False | filesEncrypted | toggle | Displayed only if AWS or Microsoft Azure Cloud Provider selected. | ||
| Encryption Type | Encryption type used. | For AWS:
For Azure:
| encryptionType | select | 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. | masterKey | textbox | Displayed only if to AWS_CSE or AZURE_CSE Encryption Type selected. | |||
| Master Key Id | AWS Master Key ID. | masterKeyId | textbox | Displayed only if to AWS_SSE_KMS Encryption Type selected. | |||
| AdvancedFile Format | File Format | Optional parameter to specify the format of the data files to load. |
| Undefined | fileFormat | toggle | |
| Format Name | Existing named file format to use for loading data into the table. The named file format determines the format type (CSV, JSON, etc.), as well as any other format options, for the data files. For more information, see CREATE FILE FORMAT. | fileFormatName | textbox | Displayed only if 'By Name' File Format selected. | |||
| Format Type | Type of files to load into the table. If a format type is specified, then additional format-specific options can be specified. For more details, see Format Type Options. |
| fileFormatType | select | Displayed only if 'By Type' File Format selected. | ||
| Format Type Options | Format-specific options separated by blank spaces, commas, or new lines. | typeOptions | textarea | Displayed only if CSV, JSON, AVRO, PARQUET or XML Format Type selected. ORC does not support any format type options. | |||
| Advanced | Files | List of one or more files names (separated by commas) to be loaded. The files must already have been staged in either the Snowflake internal location or external location specified in the command. The maximum number of files names that can be specified is 1000. | files | textbox | |||
| Pattern | Regular expression pattern string, enclosed in single quotes, specifying the file names and/or paths to match. For the best performance, try to avoid applying patterns that filter on a large number of files. | pattern | textbox | ||||
| Copy Options | One or more copy options separated by blank spaces, commas, or new lines. | copyOptions | textarea | ||||
| 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 |
Notes:
- Snowflake Data Loading Action Plugin uses COPY INTO <table> command to load data files into Snowflake
Snowflake Data Unloading Action Plugin Properties
...