Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section

User Configuration LabelLabel DescriptionOptionsDefaultVariableUser Widget
GeneralLabelLabel for UI.


textbox

Reference NameUniquely identified name for lineage.

referenceNametextbox

Account NameFull name of Snowflake account.

accountNametextbox

Database

Database name to connect to.



databasetextbox

Import Query

Query for import data.



importQuerytextarea
CredentialsUsernameUser identity for connecting to the specified database.

usernametextbox

PasswordPassword to use to connect to the specified database.

passwordpassword
Key Pair AuthenticationKey Pair Authentication EnabledIf true, plugin will perform Key Pair authentication.
  • True
  • False
FalsekeyPairEnabledtoggle

Key File PathPath to the private key file.

pathtextboxUserSnowflake login name.usertextbox
OAuth2OAuth2 EnabledIf true, plugin will perform OAuth2 authentication.
  • True
  • False
Falseoauth2Enabledtoggle

Auth URLEndpoint for the authorization server used to retrieve the authorization code.

authUrltextbox

Token URLEndpoint for the resource server, which exchanges the authorization code for an access token.

tokenUrltextbox

Client IDClient identifier obtained during the Application registration process.

clientIdtextbox

Client SecretClient secret obtained during the Application registration process.

clientSecretpassword

ScopesScope of the access request, which might have multiple space-separated values.

scopestextbox

Refresh TokenToken used to receive accessToken, which is end product of OAuth2.

refreshTokentextbox
AdvancedBounding QueryBounding 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.

boundingQuerytextarea

Split-By Field NameField Name which will be used to generate splits. Not required if numSplits is set to one.

splitBytextbox

Number of Splits to GenerateNumber of splits to generate.

numSplitstextbox

Connection ArgumentsA 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

connectionArgumentskeyvalue

...

SectionUser Configuration LabelLabel DescriptionOptionsDefaultVariableUser Widget
GeneralLabelLabel for UI.


textbox

Reference NameUniquely identified name for lineage.

referenceNametextbox

Account NameFull name of Snowflake account.

accountNametextbox

Database

Database name to connect to connect to.



databasetextbox

Table Name

Name of a database table to write to.



tabletextbox
CredentialsUsernameUser identity for connecting to the specified database.

usernametextbox

PasswordPassword to use to connect to the specified database.

passwordpassword
Key Pair AuthenticationKey Pair Authentication EnabledIf true, plugin will perform Key Pair authentication.
  • True
  • False
FalsekeyPairEnabledtoggle

Key File PathPath to the private key file.

pathtextboxUserSnowflake login name.usertextbox
OAuth2OAuth2 EnabledIf true, plugin will perform OAuth2 authentication.
  • True
  • False
Falseoauth2Enabledtoggle

Auth URLEndpoint for the authorization server used to retrieve the authorization code.

authUrltextbox

Token URLEndpoint for the resource server, which exchanges the authorization code for an access token.

tokenUrltextbox

Client IDClient identifier obtained during the Application registration process.

clientIdtextbox

Client SecretClient secret obtained during the Application registration process.

clientSecretpassword

ScopesScope of the access request, which might have multiple space-separated values.

scopestextbox

Refresh TokenToken used to receive accessToken, which is end product of OAuth2.

refreshTokentextbox
AdvancedConnection ArgumentsA 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

connectionArgumentskeyvalue

...

CDAP Schema Data TypeSnowflake Data TypesComment
booleanBOOLEAN
bytesBINARY
dateDATE
doubleFLOATSnowflake uses double-precision (64 bit) IEEE 754 floating point numbers.
decimalNUMBER(s, p)
floatFLOAT
intNUMBER(s, p)

Where p >= 10.


It's safe to write primitives as values of decimal logical type in the case of valid precision.

longNUMBER(s, p)

Where p >= 19.


It's safe to write primitives as values of decimal logical type in the case of valid precision.

stringVARCHAR
timeTIME
timestampTIMESTAMP_NTZ
arrayARRAY
recordOBJECT
enumVARCHAR
mapOBJECT
unionVARIANT

Action Plugin Properties

Section

User Configuration Label

Label Description

OptionsDefault

Variable

User Widget
General

Label

Label for UI




textbox

Account NameFull name of Snowflake account.

accountNametextbox

Database

Database name to connect to connect to.



databasetextbox

Query

SQL query to run.



querytextarea
CredentialsUsernameUser identity for connecting to the specified database.

usernametextbox

PasswordPassword to use to connect to the specified database.

passwordpassword
Key Pair AuthenticationKey Pair Authentication EnabledIf true, plugin will perform Key Pair authentication.
  • True
  • False
FalsekeyPairEnabledtoggle

Key File PathPath to the private key file.

pathtextboxUserSnowflake login name.usertextbox
OAuth2OAuth2 EnabledIf true, plugin will perform OAuth2 authentication.
  • True
  • False
Falseoauth2Enabledtoggle

Auth URLEndpoint for the authorization server used to retrieve the authorization code.

authUrltextbox

Token URLEndpoint for the resource server, which exchanges the authorization code for an access token.

tokenUrltextbox

Client IDClient identifier obtained during the Application registration process.

clientIdtextbox

Client SecretClient secret obtained during the Application registration process.

clientSecretpassword

ScopesScope of the access request, which might have multiple space-separated values.

scopestextbox

Refresh TokenToken used to receive accessToken, which is end product of OAuth2.

refreshTokentextbox
AdvancedConnection ArgumentsA 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

connectionArgumentskeyvalue

Snowflake Data Loading Action Plugin Properties

Section

User Configuration Label

Label Description

OptionsDefault

Variable

User WidgetComment
General

Label

Label for UI




textbox

Account NameFull name of Snowflake account.

accountNametextbox

FromInternal or external location where the files containing data to be loaded are staged

fromtextbox

IntoName of the table into which data is loaded.

tabletextbox

SelectOptional 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.

selecttextarea
CredentialsUsernameLogin name of the user for the connection.

usernametextbox

PasswordPassword for the specified user.

passwordpassword
Key Pair AuthenticationKey Pair Authentication EnabledIf true, plugin will perform Key Pair authentication.
  • True
  • False
FalsekeyPairEnabledtoggle

Key File PathPath to the private key file.

pathtextboxDisplayed only if Key Pair Authentication Enabled set to true.
OAuth2OAuth2 EnabledIf true, plugin will perform OAuth2 authentication.
  • True
  • False
Falseoauth2Enabledtoggle

Auth URLEndpoint for the authorization server used to retrieve the authorization code.

authUrltextboxDisplayed only if OAuth2 Enabled set to true.

Token URLEndpoint for the resource server, which exchanges the authorization code for an access token.

tokenUrltextboxDisplayed only if OAuth2 Enabled set to true.

Client IDClient identifier obtained during the Application registration process.

clientIdtextboxDisplayed only if OAuth2 Enabled set to true.

Client SecretClient secret obtained during the Application registration process.

clientSecretpasswordDisplayed only if OAuth2 Enabled set to true.

ScopesScope of the access request, which might have multiple space-separated values.

scopestextboxDisplayed only if OAuth2 Enabled set to true.

Refresh TokenToken used to receive accessToken, which is end product of OAuth2.

refreshTokentextboxDisplayed only if OAuth2 Enabled set to true.
Cloud Provider ParametersUse Cloud Provider ParametersIf true, plugin will use specified Cloud Provider Parameters.
  • True
  • False
FalseuseCloudProviderParameterstoggle

Cloud Provider
  • GCP
  • AWS
  • Microsoft Azure

GCP

cloudProviderradio-groupDisplayed only if Use Cloud Provider Parameters set to true.


Storage IntegrationName 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 IdKey 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 KeySecret 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.

TokenToken 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 TokenShared 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
  • True
  • False
False

Displayed only if AWS or Microsoft Azure Cloud Provider selected.

Encryption TypeEncryption type used.

For AWS:

  • NONE
  • AWS_CSE
  • AWS_SSE_S3
  • AWS_SSE_KMS

For Azure:

  • NONE
  • AZURE_CSE



Displayed only if Files Encrypted set to true.

Master KeyClient-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 IdAWS Master Key ID.



Displayed only if to AWS_SSE_KMS Encryption Type selected.
AdvancedConnection ArgumentsA 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

connectionArgumentskeyvalue

Snowflake Data Unloading Action Plugin Properties

...