July 30, 2023

tMSSqlOutput – Docs for ESB 7.x


Executes the action defined on the table and/or on the data contained in the table,
based on the flow incoming from the preceding component in the Job.

tMSSqlOutput writes, updates, makes
changes or suppresses entries in a Microsoft SQL Server database or a Microsoft Azure
SQL database.

tMSSqlOutput Standard properties

These properties are used to configure tMSSqlOutput running in the Standard Job

The Standard
tMSSqlOutput component belongs to the Databases family.

The component in this framework is available in all Talend

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 Dynamic database components.

Basic settings


Select a type of database from the list and click

Property type

Either Built-in or Repository


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.


Click this icon to open a database connection
wizard and store the database connection parameters you set in the component
Basic settings

For more information about setting up and
storing database connection parameters, see
Talend Studio

User Guide.

Use an existing

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
    view of the connection component which creates that very database

  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

JDBC Provider

Select the provider of the JDBC driver to be used, either Microsoft (recommended) or Open
source JTDS

When using this component with Datasource in Talend Runtime, you need
to use the Open source JTDS driver.

Note that when Microsoft is selected, you
need to download the Microsoft JDBC Driver for SQL Server on Microsoft Download Center, unpack
the downloaded zip file, choose a jar in the unzipped folder based on your JRE version,
rename the jar to mssql-jdbc.jar and install it manually. For more
information about choosing the jar, see the System Requirements information on Microsoft Download Center.


Database server IP address.


Listening port number of DB server.


Name of the schema.


Name of the database.

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.


Name of the table to be written. Note that only
one table can be written at a time.

Action on table

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

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 not
: The table is created if it does not exist.

Drop table if exists and
: The table is removed if it already exists and created

Clear table: The table
content is deleted.

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

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

On the data of the table defined, you can

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, 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
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
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
for the Delete operation.


The dynamic schema feature can be used in
the following modes: Insert; Update; Insert
or update
; Update
or insert
; 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
, Create
, 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
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
list and if the specified table does not exist, only a
table will be created without inserting data into it.


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


When the Specify identity field check box is
selected, the INT IDENTITY DB
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

Click Edit
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

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,
Talend Studio

User Guide.

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.


Built-In: You create and store the schema locally for this component


Repository: You have already created the schema and stored it in the
Repository. You can reuse it in various projects and Job designs.

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.

You can find more details about how to
verify default values in retrieved schema in Talend Help Center (https://help.talend.com).

Specify a data source

Select this check box and specify the alias of a data source created on the
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
check box is selected.

Data source alias

Enter the alias of the data source created on the
Talend Runtime

This field is available only when the Specify a data
source alias
check box is selected.

Die on error

This check box is selected by default. Clear
the check box to skip the row on error and complete the process for error-free
rows. If needed, you can retrieve the rows on error via a Row > Rejects link.

Advanced settings

Additional JDBC

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.

This field is not available if the Use an existing
check box is selected.

Commit every

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

Additional Columns

This option is not offered if you create (with
or without drop) the DB 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 the tDBOutput can use to place or replace the new or altered

Use field options

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

Ignore date validation

Select this check box to ignore the date
validation and insert the data directly into the database for the data types of

Debug query mode

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

Support null in “SQL WHERE”

Select this check box if you want to deal
with the Null values contained in a DB 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.


If you select the Single Insert Query option
in the Action on
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

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.


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

Enable parallel

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.


  • The Action on
    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

Global Variables

Global Variables 

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.

QUERY: the query statement processed. This is an After
variable and it returns a string.

ERROR_MESSAGE: the error message generated by the
component when an error occurs. This is an After variable and it returns a string. This
variable functions only if the Die on error check box is
cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable
functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl +
to access the variable list and choose the variable to use from it.

For further information about variables, see
Talend Studio

User Guide.


Usage rule

This component offers the flexibility benefit
of the DB query and covers all of the SQL queries possible.

This component must be used as an output
component. It allows you to carry out actions on a table or on the data of a
table in a MSSql database. It also allows you to create a reject flow using a
Row > Rejects link to filter data in
error. For an example of tMysqlOutput in use, see Retrieving data in error with a Reject 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
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
and context variables, see Talend Studio
User Guide.


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.

Due to license incompatibility, one or more JARs required to use
this component are not provided. You can install the missing JARs for this particular
component by clicking the Install button
on the Component tab view. You can also
find out and add all missing JARs easily on the Modules tab in the
perspective of your studio. You can find more details about how to install external modules in
Talend Help Center (https://help.talend.com)

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