tSnowflakeOutputBulkExec Standard properties
These properties are used to configure tSnowflakeOutputBulkExec running in the Standard Job framework.
The Standard tSnowflakeOutputBulkExec component belongs to the Cloud family.
The component in this framework is available in all subscription-based Talend products.
Basic settings
Database |
Select the desired database type from the list and click Apply. |
Property Type |
Select the way the connection details will be set.
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 |
Set the authentication type.
Information noteNote: Before selecting the Key
Pair option, make sure you have set the key pair authentication
data in the Basic settings view of the tSetKeystore
component as follows.
|
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. Information noteNote: OAuth password does not support spaces.
|
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.
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. |
Schema |
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:
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 Dynamic schema. 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. |
Table Action | Select the action to be carried out to the table.
|
Output Action | 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.
|
Storage | Select the type of storage to upload the incoming data to and to load data
into the table from.
|
Stage Folder | Specify the folder under the Snowflake stage to write incoming data to and
to load data from. This field is available when you select Internal from the Storage drop-down list in the Basic settings view. |
Region | Specify the region where the S3 bucket locates. This field is available when you select S3 from the Storage drop-down list in the Basic settings view. |
Access Key and Secret Key | Enter the authentication information required to connect to the Amazon S3
bucket to be used. 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. |
Bucket | Enter the name of the bucket (in double quotation marks) to be used for
storing the incoming data and loading data from. This bucket must already exist. This field is available when you select S3 from the Storage drop-down list in the Basic settings view. |
Folder | Enter the name of the folder (in double quotation marks) to be used for
storing the incoming data and loading data from. This folder will be created if it
does not exist at runtime. This property is available only when S3 or Azure is selected from the Storage drop-down list. |
Server-Side Encryption | Select this check box to encrypt the files to be uploaded to the S3 bucket
on the server side. This property is checked by default. This field is available when you select S3 from the Storage drop-down list in the Basic settings view. |
Protocol | Select the protocol used to create Azure connection. This field is available when you select Azure from the Storage drop-down list in the Basic settings view. |
Account Name | Enter the Azure storage account name (in double quotation marks). This field is available when you select Azure from the Storage drop-down list in the Basic settings view. |
Container and Folder | Enter the Azure container and folder names (in double quotation marks). This field is available when you select Azure from the Storage drop-down list in the Basic settings view. |
SAS Token | Specify the SAS token to grant limited access to objects in your storage
account. 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. |
Advanced settings
Additional JDBC Parameters |
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. |
Login Timeout |
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. |
URL suffix |
Enter, in double quotation marks, the Snowflake custom domain URL of your choice. For more information about Snowflake URL formats, see Standard account URLs. 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. |
Allow Snowflake to convert columns and tables to uppercase | 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. |
Temporary Table Schema | Specify a schema for the temporary table. The schema must exist. |
Use strict schema matching | Select this option to load incoming data to table columns whose column names
are exactly the same as those of the incoming data. Column names are case sensitive. If this option is not selected, it is possible that incoming data are not loaded into the corresponding table columns. This option is available when INSERT is selected from the Output Action drop-down list in the Basic settings view. Information noteNote: This option is available only when you have installed the 8.0.1-R2023-04
Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
|
Custom DB Type | Select this check box to specify the DB type for each column in the
schema. This property is available only when you select an action with Create Table from the Table Action drop-down list in the Basic settings. |
Custom Date type mapping | Select this check box to use a custom mapping for your date type date, and
then select the mapping from the Convert Date values to
drop-down list. This option is available when you use a dynamic schema and when
you select the following option from the Table Action
drop-down list in the Basic settings view:
|
Use schema date pattern |
Select this option to convert data in schema columns that are of Date type using the date pattern defined in the schema. To achieve this, you need also to specify the DB type of the schema columns as STRING, TEXT, or VARCHAR in the Custom DB Type field. |
Delete Storage Files On Success | Delete all the files in the storage folder once the data is loaded to the
table successfully. This field is not available when you select Use Custom Storage Location. |
Use Custom Stage Path | Select this check box to upload the data to the files
generated in a folder under the stage. You need also to enter the path to
the folder in the field provided. For example, to upload data to the files
generated 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 S3 Connection Configuration | Select this check box if you wish to use your custom S3 configuration.
This field is available when you select S3 from the Storage drop-down list in the Basic settings view. |
Copy Command Options | Set parameters for the COPY INTO command by selecting
the following options from the drop-down list. The COPY INTO command is
provided by Snowflake. It loads data to a Snowflake database table.
|
Put Command Options | Set parameters for the PUT command by selecting the following options from
the drop-down list. The PUT command is provided by Snowflake. It uploads data to a
Snowflake stage folder.
This field is available when you select Internal from the Storage drop-down list in the Basic settings view. |
Put Command Error Retry | Specify the maximum data loading retries when an error occurs during loading
data to the internal Snowflake storage. 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 Internal from the Storage drop-down list in the Basic settings view. |
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. Information noteNote: This option is available when S3 is selected from the Storage drop-down list in the Basic settings view.
|
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. Information noteNote:
|
S3 Max Error Retry | 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. |
Azure Max Error Retry | 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. |
Non-empty Storage Folder Action | Select any of the following options:
|
Chunk Size (bytes) | Specify the size for the files generated, which defaults to 52428800
bytes. With this option specified, the incoming data may be stored in multiple files. Since data is stored in files on a record base, the actual size of each file generated can be larger or smaller than the specified value, but no more than the size of the last record stored in the file. This option can significantly affect the performance. So set it carefully. See File Sizing Best Practices and Limitations for related information. |
Number of file requests threads | Specify the number of threads used for sending Put requests in parallel when writing the data in the files. |
tStatCatcher Statistics |
Select this check box to gather the Job processing metadata at the Job level as well as at each component level. |
Global Variables
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
Usage rule |
This component is an end component of a data flow in your Job. It receives data from other components through the link.It can also send error messages to other components via a Row >
Rejects link. The provided information about an error could
be:
|