tSnowflakeRow Standard properties
These properties are used to configure tSnowflakeRow running in the Standard Job framework.
The Standard tSnowflakeRow component belongs to the Cloud family.
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 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.
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.
|
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:
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. |
Guess Query |
Click the button to generate the query which corresponds to the table and the schema in the Query field. |
Query |
Specify the SQL command to be executed. For more information about Snowflake SQL commands, see SQL Command Reference. |
Die on error |
Select the check box to stop the execution of the Job when an error occurs. Clear the check box to skip any rows on error and complete the process for error-free rows. When errors are skipped, you can collect the rows on error using a connection. |
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. |
Use PreparedStatement |
Select this check box if you want to query the database using a prepared statement. In the Set PreparedStatement Parameters table displayed, specify the value for each parameter represented by a question mark ? in the SQL statement defined in the Query field.
For a related use case of this property, see Using PreparedStatement objects to query data. |
Commit every |
Specify the number of rows to be processed before committing batches of rows together into the database. When used with the tSnowflakeConnection component, tSnowflakeRow ignores the Auto Commit option set in the advanced settings of tSnowflakeConnection and uses this value at runtime instead. |
tStatCatcher Statistics |
Select this check box to gather the Job processing metadata at the Job level as well as at each component level. |
Dynamic settings
Dynamic settings |
Click the [+] button to add a row in the table and fill the Code field with a context variable to choose your database connection dynamically from multiple connections planned in your Job. This feature is useful when you need to access database tables having the same data structure but in different databases, especially when you are working in an environment where you cannot change your Job settings, for example, when your Job has to be deployed and executed independent of Talend Studio. For examples on using dynamic parameters, see Reading data from databases through context-based dynamic connections and Reading data from different MySQL databases using dynamically loaded connection parameters. For more information on Dynamic settings and context variables, see Dynamic schema and Creating a context group and define context variables in it. |
Global Variables
NB_LINE |
The number of rows processed. 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 offers the flexibility of the database query and covers all possible SQL queries. |