tSnowflakeOutput Standard properties - 7.3

Snowflake

EnrichVersion
Cloud
7.3
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
EnrichPlatform
Talend Studio
task
Data Governance > Third-party systems > Cloud storages > Snowflake components
Data Quality and Preparation > Third-party systems > Cloud storages > Snowflake components
Design and Development > Third-party systems > Cloud storages > Snowflake components

These properties are used to configure tSnowflakeOutput running in the Standard Job framework.

The Standard tSnowflakeOutput component belongs to the Cloud family.

The component in this framework is available in all Talend products.

Note: This component is a specific version of a dynamic database connector. The properties related to database settings vary depending on your database type selection. For more information about dynamic database connectors, see pzz1550477830065.html.

Basic settings

Database

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 not available when other connection 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.

Authentication Type

Set the authentication type.
  • Basic: Select this option if key pair authentication is not enabled.
  • Key Pair: Select this option if key pair authentication is enabled. For information about key pair authentication, see Using Key Pair Authentication.
  • OAuth 2.0: Select this option to use external OAuth for data accessing. See External OAuth Overview for related information.
Note: 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.
  • Leave the TrustStore type field unchanged;
  • Set TrustStore file to "";
  • Clear the TrustStore password field;
  • Select Need Client authentication;
  • Enter the path to the key store file in double quotation marks in the KeyStore file field (or click the […] button to the right of the KeyStore file field and navigate to the key store file);
  • Enter the key store file password in the KeyStore password field;
  • Clear the Check server identity option.
Note: The OAuth 2.0 option is available only if you have installed the R2020-06 Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

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

Note: This option is available only if you have installed the R2020-10 Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

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.

Note: 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.

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

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.

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.

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.

Table

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

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 is end component of a data flow in your Job. It receives data from other components via a

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.

Table Action

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

  • INSERT: Insert new records in the Snowflake table.
  • 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.

Advanced settings

Additional JDBC Parameters

Specify additional JDBC parameters for the database connection created.

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.

Note: This field is available only when you have installed the R2021-04 Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.
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.

Convert empty strings to null

Select this option to convert empty strings to null.

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.

Note: This option is available only when you have installed the R2020-09 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.

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.

Note: This option is available only if you have installed the R2020-08 Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

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 end component of a data flow in your Job. It receives data fromRow > Main link.

It can also send error messages to other components via a Row > Rejects link. The provided information about an error could be:
  • The name of the column in error.

  • The number of the row in error.

  • The category of the error, such as a parsing error or a conversion error.

  • The character offset in the line in error.

  • The related error message.

  • The offset of the byte in error.

  • The number of the line in error.

  • SQLSTATE for the error.

  • Snowflake error code.