July 30, 2023

tSQLDWHOutput – Docs for ESB 7.x

tSQLDWHOutput

Writes, updates, makes changes or suppresses entries in an Azure SQL Data Warehouse
database.

tSQLDWHOutput Standard properties

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

The Standard
tSQLDWHOutput component belongs to two families: Cloud and Databases.

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

Basic settings

Use an existing connection

Select this check box and in the Component List click the relevant connection component to
reuse the connection details you already defined.

When a Job contains the parent Job and the child Job, if you need to
share an existing connection between the two levels, for example, to share the
connection created by the parent Job with the child Job, you have to:

  1. In the parent level, register the database connection to be shared
    in the Basic settings view of the connection
    component which creates that very database connection.

  2. In the child level, use a dedicated connection component to read
    that registered database connection.

For an example about how to share a database connection across Job
levels, see

Talend Studio
User Guide
.

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.

JDBC Provider

Select the provider of the JDBC driver to be used.

Host

Specify the IP address or hostname of the Azure SQL Data Warehouse to be used.

Port

Specify the listening port number of the Azure SQL Data Warehouse to be used.

Schema

Enter the name of the Azure SQL Data Warehouse schema.

Database

Specify the name of the Azure SQL Data Warehouse to be used.

Username and Password

Enter the user authentication data to access the Azure SQL Data Warehouse.

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.

Table

Specify the name of the table to be used.

Action on table

Select an operation to be performed on the table defined.

  • Default: No operation is carried out.

  • Drop and create table: The table is removed
    and created again.

  • Create table: The table does not exist and
    gets created.

  • Create table if does not exist: The table is
    created if it does not exist.

  • Drop table if exist and create: The table is
    removed if it already exists and created again.

  • Clear table: The table content is
    deleted. You have the possibility to rollback the operation.

  • Truncate: The table content
    is deleted.

Turn on identity insert

Select this check box to use your own sequence for the identity value of the inserted
records (instead of having the SQL Server pick the next sequential value).

Action on data

Select an action to be performed on data of the table defined.

  • Insert: Add new entries to the table. If
    duplicates are found, job stops.

  • Single Insert Query: Add entries to the table
    in a batch.

  • Update: Make changes to existing
    entries.

  • Insert or update: Insert a new record. If
    the record with the given reference already exists, an update would be made.

  • Update or insert: Update the record with the
    given reference. If the record does not exist in the index pool, a new record would be
    inserted.

  • Delete: Remove entries corresponding to
    the input flow.

  • Insert if not exist: Add new entries to the
    table if they do not exist.

It is necessary to specify at least one column as a primary key on which the
Update and Delete
operations are based. You can do that by clicking Edit
Schema
and selecting the check box(es) next to the column(s)
you want to set as primary key(s). For an advanced use, click the
Advanced settings view where you can
simultaneously define primary keys for the Update and
Delete operations. To do that, select the
Use field options check box and then in the
Key in update column, select the check boxes next
to the column names you want to use as a base for the
Update operation. Do the same in the
Key in delete column for the
Delete operation.

The dynamic schema feature can be used in the following modes:
Insert, Update,
Insert or update, Update or
insert
, and Delete.

Specify identity field

Select this check box to specify the identity field, which is made up of an
automatically incrementing identification number.

When this check box is selected, three other fields are displayed:

  • Identity field: select the column you want to define as
    the identity field from the list.

  • Start value: type in a start value, used for the very
    first row loaded into the table.

  • Step: type in an incremental value, added to the value of
    the previous row that was loaded.

This check box is available only when you select Drop and create
table
, Create table, Create table if
not exists
, or Drop table if exists and create
from the Action on table list , and will disappear if you
select the Enable parallel execution check box in the
Advanced settings view. If you select this check box with the
Turn on identity insert check box cleared and the
Create table if not exists option selected from the
Action on table list and if the specified table does not
exist, only a table will be created without inserting data into it.

Note that you can also specify the identity field from the schema of the component.
To do so, set the DB Type of the relevant column to
INT IDENTITY.

When the Specify identity field check box is selected, the DB
Type INT IDENTITY in the schema is ignored.

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.

Click Edit
schema
to make changes to the schema.

Note: If you
make changes, the schema automatically becomes built-in.
  • 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.

Specify a data source alias

Select this check box and in the
Data source alias field displayed, specify the alias of
a data source created on Talend Runtime side to use
the shared connection pool defined in the data source configuration. This option
works only when you deploy and run your Job in Talend Runtime.

This check box is not available when the Use an existing
Connection
check box is selected.

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.

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, encrypt=true;trustServerCertificate=false;
hostNameInCertificate=*.database.windows.net;loginTimeout=30; for
Azure SQL database connection.

Commit every

Enter the number of rows to be completed before committing batches of rows together
into the database. This option ensures transaction quality (but not rollback) and
above all better performance on executions.

Additional Columns

This option is not offered if you create (with or without drop) the database table.
This option allows you to call SQL functions to perform actions on columns, which are
not insert, nor update or delete actions, or action that require particular
preprocessing.

  • Name: Type in the name of the schema column to be altered
    or inserted as new column.

  • SQL expression: Type in the SQL statement to be executed
    in order to alter or insert the relevant column data.

  • Position: Select Before,
    Replace or After following the
    action to be performed on the reference column.

  • Reference column: Type in a column of reference that can
    be used to place or replace the new or altered column.

Use field options

Select this check box to customize a request, especially when there is double action
on data.

Ignore date out of range

Select this check box to ignore the date validation and insert the data directly into
the database for the data types of DATE, DATETIME, DATETIME2 and DATETIMEOFFSET.

Debug query mode

Select this check box to display each step during processing entries
in a database.

Support null in “SQL WHERE” statement

Select this check box if you want to deal with the Null values contained in a
database table.

Make sure that the Nullable check box is selected for the
corresponding columns in the schema.

Use Batch

Select this check box to activate the batch mode for data processing.

This check box is available only when you have selected the
Insert, the Update, the
Single Insert Query or the Delete
option in the Action on data list.

Note that if you select the Single Insert Query option in the
Action on data list, be aware that the batch size must be
lower than or equal to the limit of parameter markers authorized by the JDBC driver
(generally 2000) divided by the number of columns. For more information, see related
description in Limitation below.

Batch Size

Specify the number of records to be processed in each batch.

This field appears only when the Use batch mode
check box is selected.

tStatCatcher Statistics

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

Enable parallel execution

Select this check box to perform high-speed data processing, by treating
multiple data flows simultaneously. Note that this feature depends on the database or
the application ability to handle multiple inserts in parallel as well as the number of
CPU affected. In the Number of parallel executions
field, either:

  • Enter the number of parallel executions desired.
  • Press Ctrl + Space and select the
    appropriate context variable from the list. For further information, see
    Talend Studio User Guide
    .

Note that when parallel execution is enabled, it is not possible to use global
variables to retrieve return values in a subjob.

Warning:

  • The Action on
    table
    field is not available with the
    parallelization function. Therefore, you must use a tCreateTable component if you
    want to create a table.
  • When parallel execution is enabled, it is not
    possible to use global variables to retrieve return values in a
    subjob.

Global Variables

ERROR_MESSAGE

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

NB_LINE

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

NB_LINE_UPDATED

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

NB_LINE_INSERTED

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

NB_LINE_DELETED

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

NB_LINE_REJECTED

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

Usage

Usage rule

This component is usually used as an end component of a Job or
subJob and it always needs an input link.

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.

The Dynamic settings table is
available only when the Use an existing
connection
check box is selected in the Basic settings view. Once a dynamic parameter is
defined, the Component List box in the
Basic settings view becomes unusable.

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 Talend Studio
User Guide.

Limitation

When the Single Insert Query option is selected in the
Action on data list, an SQL Prepared Statement is generated,
for example, INSERT INTO table (col1, col2, col3) VALUES (?,?,?) , (?,?,?) ,
(?,?,?) ,(?,?,?)
. Within brackets are the groups of parameters the number
of which cannot exceed 2000, generally, depending on the JBDC driver. Therefore, the
batch size should be set so that this limit is respected.

Note that some features that are supported by
other databases are not supported by Azure SQL Data Warehouse. For more information,
see Unsupported table features.

Also note that when creating or deleting a table with this
component, it is recommended to use the auto commit function by reusing the database
connection created by a tSQLDWHConnection component and
selecting the Auto Commit check box on the Advanced
settings
view of the tSQLDWHConnection component,
instead of using a tSWLDWHCommit component.

Related scenario

No scenario is available for this component yet.


Document get from Talend https://help.talend.com
Thank you for watching.
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x