August 17, 2023

tMSSqlOutputBulkExec – Docs for ESB 5.x

tMSSqlOutputBulkExec

tMSSqlOutputBulkExec_icon32_white.png

tMSSqlOutputBulkExec properties

The tMSSqlOutputBulk and tMSSqlBulkExec components are used together in a two step process. In
the first step, an output file is generated. In the second step, this file is used in
the INSERT operation used to feed a database. These two steps are fused together in the
tMSSqlOutputBulkExec component.

Component family

Databases/MSSql

 

Function

Executes actions on the provided data provided.

Purpose

As a dedicated component, it allows gains in performance during
Insert operations to a MSSql database.

Basic settings

Action

Select the action to be carried out

Bulk insert
Bulk update

 

Property type

Either Built-in or
Repository
.

Since version 5.6, both the Built-In mode and the Repository mode are
available in any of the Talend solutions.

 

 

Built-in: No property data stored
centrally.

 

 

Repository: Select the repository
file in which the properties are stored. The fields that follow are
completed automatically using the data retrieved.

 

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.

Note

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
.

 

Host

Database server IP address.

Currently, only localhost,
127.0.0.1 or the exact IP
address of the local machine is allowed for proper functioning. In
other words, the database server must be installed on the same
machine where the Studio is installed or where the Job using
tMSSqlOutputBulkExec is
deployed.

 

Port

Listening port number of DB server.

 

DB name

Name of the database

 

Schema

Name of the schema.

 

Username and
Password

DB user authentication data.

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

Name of the table to be written.

Note that only one table can be written at a time and that the
table must exist for the insert operation to succeed.

 

Action on table

On the table defined, you can perform one of the following
operations:

None: No operation is carried
out.

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

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

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

Truncate table: The table content
is deleted. You do not have the possibility to rollback the
operation.

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

 

Schema and Edit
schema

A schema is a row description. It defines the number of fields to be processed and passed on
to the next component. The schema is either Built-In or
stored remotely in the Repository.

Since version 5.6, both the Built-In mode and the Repository mode are
available in any of the Talend solutions.

 

 

Built-In: You create and store the schema locally for this
component only. Related topic: see Talend Studio
User Guide.

 

 

Repository: You have already created the schema and
stored it in the Repository. You can reuse it in various projects and Job designs. Related
topic: see Talend Studio User Guide.

When the schema to be reused has default values that are integers or functions, ensure that
these default values are not enclosed within quotation marks. If they are, you must remove
the quotation marks manually.

For more details, see https://help.talend.com/display/KB/Verifying+default+values+in+a+retrieved+schema.

   

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.

 

File Name

Name of the file to be generated and loaded.

Warning

This file is generated on the machine specified by the URI in
the Host field so it should be
on the same machine as the database server.

 

Append

Select this check box to add the new rows at the end of the
records

Advanced settings

Additional JDBC parameters

Specify additional connection properties for the DB connection you
are creating. This option is not available if you have selected the
Use an existing connection
check box in the Basic
settings
.

Note

You can press Ctrl+Space to
access a list of predefined global variables.

 

Field separator

Character, string or regular expression to separate fields.

 

Row separator

String (ex: ”
“on Unix) to distinguish rows.

 

First row

Type in the number of the row where the action should
start.

 

Include header

Select this check box to include the column header.

 

Code page

OEM code pages used to map a
specific set of characters to numerical code point values.

 

Data file type

Select the type of data being handled.

 

Encoding

Select the encoding from the list or select Custom and define it
manually. This field is compulsory for DB data handling.

 

tStatCatcher statistics

Select this check box to collect log data at the component
level.

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 more information on Dynamic settings and context
variables, see Talend Studio User Guide.

Usage

This component is mainly used when no particular transformation is
required on the data to be loaded onto the database.

Limitation

The database server must be installed on the same machine where
the Studio is installed or where the Job using tMSSqlOutputBulkExec is deployed, so that the
component functions properly.

Related scenarios

For use cases in relation with tMSSqlOutputBulkExec,
see the following scenarios:


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