tSnowflakeBulkExec Standard properties - 7.3

Select a type of database from the list and click Apply.

Property Type

Select the way the connection details will be set.

• Built-In: The connection details will be set locally for this component. You need to specify the values for all related connection properties manually.

• Repository: The connection details stored centrally in Repository > Metadata will be reused by this component. You need to click the [...] button next to it and in the pop-up Repository Content dialog box, select the connection details to be reused, and all related connection properties will be automatically filled in.

This property is available when Use this Component is selected from the Connection Component drop-down list.

Connection Component

Select the component that opens the database connection to be reused by this component.

Account

In the Account field, enter, in double quotation marks, the account name that has been assigned to you by Snowflake.

This field is available only when Use this Component is selected from the Connection Component drop-down list.

Authentication Type

OAuth token endpoint

Enter OAuth 2.0 token endpoint.

This option is available when OAuth 2.0 is selected from the Authentication Type drop-down list.

Client ID

Enter the client ID of your application.

This option is available when OAuth 2.0 is selected from the Authentication Type drop-down list.

Client Secret

Enter the client secret of your application.

This option is available when OAuth 2.0 is selected from the Authentication Type drop-down list.

Grant type

Set the grant type for retrieving the access token. Two options are provided: Client Credentials and Password.

Click Client Credentials and Resource Owner Password Credentials for related information.

This option is available when OAuth 2.0 is selected from the Authentication Type drop-down list.

OAuth username

Enter the OAuth username.

This option is available when Password is selected from the Grant type drop-down list.

OAuth password

Enter the OAuth password.

To enter the password, click the [...] button next to the password field, enter the password between double quotes in the pop-up dialog box, and then click OK to save the settings.

This option is available when Password is selected from the Grant type drop-down list.

Scope

Enter the scope. See Scopes for related information.

This option is available when OAuth 2.0 is selected from the Authentication Type drop-down list.

User Id and Password

Enter, in double quotation marks, your authentication information to log in to Snowflake.

• In the User ID field, enter, in double quotation marks, your login name that has been defined in Snowflake using the LOGIN_NAME parameter of Snowflake. For details, ask the administrator of your Snowflake system.

• To enter the password, click the [...] button next to the password field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

This field is available only when Use this Component is selected from the Connection Component drop-down list.

Warehouse

Enter, in double quotation marks, the name of the Snowflake warehouse to be used. This name is case-sensitive and is normally upper case in Snowflake.

This field is available only when Use this Component is selected from the Connection Component drop-down list.

Enter, within double quotation marks, the name of the database schema to be used. This name is case-sensitive and is normally upper case in Snowflake.

This field is available only when Use this Component is selected from the Connection Component drop-down list.

Database

Enter, in double quotation marks, the name of the Snowflake database to be used. This name is case-sensitive and is normally upper case in Snowflake.

This field is available only when Use this Component is selected from the Connection Component drop-down list.

Table

Click the [...] button and in the displayed wizard, select the Snowflake table to be used.

To load the data into a new table, select Use custom object in the wizard and enter the name of the new table in Object Name field.

Schema and Edit Schema

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word line when naming the fields.

Built-In: You create and store the schema locally for this component only.

Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and Job designs.

If the Snowflake data type to be handled is VARIANT, OBJECT or ARRAY, while defining the schema in the component, select String for the corresponding data in the Type column of the schema editor wizard.

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

• View schema: choose this option to view the schema only.

• Change to built-in property: choose this option to change the schema to Built-in for local changes.

• Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion. If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the Repository Content window.

Note that if the input value of any non-nullable primitive field is null, the row of data including that field will be rejected.

This component offers the advantage of the dynamic schema feature. This allows you to retrieve unknown columns from source files or to copy batches of columns from a source without mapping each column individually. For further information about dynamic schemas, see Talend Studio User Guide.

This dynamic schema feature is designed for the purpose of retrieving unknown columns of a table and is recommended to be used for this purpose only; it is not recommended for the use of creating tables.

Select the action to be carried out to the table.

• NONE: Leave the table as is.
• DROP_CREATE: Remove the table and create it again.
• CREATE: Create a new table.
• CREATE_IF_NOT_EXISTS: Create the table if it does not exist.
• DROP_IF_EXISTS_AND_CREATE: Remove the table if it already exists and create again.
• CLEAR: Remove all the data records in the table.
• TRUNCATE: Remove all the rows in the table. This action releases the space occupied by the table.

Select the operation you want to perform to the incoming data and data records in the Snowflake database table. You can insert, delete, update or merge data in the Snowflake table. This option assumes that the Snowflake table specified in Table field already exists.

• INSERT: Insert new records in the Snowflake table.
  Note: Because this operation uses the Snowflake COPY INTO command, which drops the use of temporary tables and currently does not support data validation, unexpected results may occur when you retrieve rejected records. See Transforming Data During a Load for related information.
• UPDATE: Update existing records in the Snowflake table.
• UPSERT: Create new records and update existing records. You need to specify a schema column as the join key from the Upsert Key Column drop-down list or specify to use the schema keys for the operation by selecting Use schema keys for upsert in the Advanced settings view.
  Note: The Upsert Key Column drop-down list is available when Use schema keys for upsert is not selected.
• DELETE: Remove records from the Snowflake table.

Specify the Snowflake stage folder in the internal storage to load data from.

This field is available when Internal is selected from the Storage drop-down list in the Basic settings view and the Use Custom Storage Location option is not selected in the Advanced settings view.

This field is available when you select S3 from the Storage drop-down list in the Basic settings view.

To enter the password, click the [...] button next to the password field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

This field is available when you select S3 from the Storage drop-down list in the Basic settings view.

This field is available when you select S3 from the Storage drop-down list in the Basic settings view.

This field is available when S3 or Azure is selected from the Storage drop-down list.

This field is available when you select Azure from the Storage drop-down list in the Basic settings view.

This field is available when you select Azure from the Storage drop-down list in the Basic settings view.

This field is available when you select Azure from the Storage drop-down list in the Basic settings view.

To enter the SAS token, click the [...] button next to the SAS token field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

This field is available when you select Azure from the Storage drop-down list in the Basic settings view.

Specify additional connection properties for the database connection you are creating. The properties are separated by semicolon and each property is a key-value pair, for example, encryption=1;clientname=Talend.

This field is available only when you select Use this Component from the Connection Component drop-down list and select Internal from the Storage drop-down list in the Basic settings view.

Specify the timeout period (in minutes) of Snowflake login attempts. An error will be generated if no response is received in this period.

Role

Enter, in double quotation marks, the default access control role to use to initiate the Snowflake session.

This role must already exist and has been granted to the user ID you are using to connect to Snowflake. If this field is left empty, the PUBLIC role is automatically granted. For information about Snowflake access control model, see Understanding the Access Control Model.

Region ID (Deprecated)

Enter a region ID in double quotation marks, for example eu-west-1 or east-us-2.azure. For information about Snowflake Region ID, see Supported Cloud Regions.

For Snowflake components other than tSnowflakeConnection, this field is available when you select Use This Component from the Connection Component drop-down list in the Basic settings view.

Select this check box to convert lowercase in the defined table name and schema column names to uppercase. Note that unquoted identifiers should match the Snowflake Identifier Syntax.

If you deselect the check box, all identifiers are automatically quoted.

This property is not available when you select the Manual Query check box.

For more information on the Snowflake Identifier Syntax, see Identifier Syntax.

Use schema keys for upsert

Select this option to use schema keys for the Upsert operation. This option is available when you select UPSERT from the Output Action drop-down list in the Basic settings view.

This property is available only when you select an action with Create Table from the Table Action drop down list in the Basic settings.

This field is not available when you select Use Custom Storage Location.

Snowflake access to storage

Specifies the authentication method for the COPY command when accessing the S3 bucket. See Additional Cloud Provider Parameters for related information.

• Credentials, use the S3 credentials for the authentication.
• Storage integration, use a storage integration for the authentication. In this case, enter the integration name in the Storage integration field.

S3 assume role

If you temporarily need some access permissions associated to an AWS IAM role that is not granted to your user account, select this check box to assume that role. Then specify the values for the following parameters to create a new assumed role session.

Ensure that access to this role has been granted to your user account by the trust policy associated to this role. If you are not certain about this, ask the owner of this role or your AWS administrator.

Specify the maximum data loading retries when an error occurs during loading data to or from the S3 folder. This parameter defaults to 3. A value of -1 specifies the maximum possible retries. Only -1 or positive integers are accepted.

This field is available when you select S3 from the Storage drop-down list in the Basic settings view.

Specify the maximum data loading retries when an error occurs during loading data to or from the Azure folder. This parameter defaults to 3. A value of -1 specifies the maximum possible retries. Only -1 or positive integers are accepted.

This field is available when you select Azure from the Storage drop-down list in the Basic settings view.

Option: select the parameter from the list.

Value: enter the parameter value.

This field is available when you select S3 from the Storage drop-down list in the Basic settings view.

Use Custom Stage Prefix

Select this check box to specify the path to the folder (with the current stage as the root) from which the data is loaded. You need also to enter the path to the folder in the field provided. For example, to load data stored in the files that are located in myfolder1/myfolder2 under the stage, you need to type "@~/myfolder1/myfolder2" in the field.

This field is available when you select Internal from the Storage drop-down list in the Basic settings view.

Once selected, the Stage Folder in Basic settings view becomes unavailable.

Use Custom Storage Location

Select this check box to specify a folder in an external storage (for example, S3) to load data from. You need to specify the folder in the field next to this option.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level as well as at each component level.

NB_LINE

The number of rows processed. This is an After variable and it returns an integer.

NB_SUCCESS

The number of rows successfully processed. This is an After variable and it returns an integer.

NB_REJECT

The number of rows rejected. This is an After variable and it returns an integer.

ERROR_MESSAGE

The error message generated by the component when an error occurs. This is an After variable and it returns a string.

Usage rule

This component can be used as a standalone component in a Job or a subJob.