tMSSqlOutputBulkExec Standard properties

MSSql

author
Talend Documentation Team
EnrichVersion
6.5
EnrichProdName
Talend Real-Time Big Data Platform
Talend Data Management Platform
Talend Open Studio for MDM
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Data Integration
Talend Open Studio for Big Data
Talend ESB
Talend Big Data
Talend Data Fabric
Talend Big Data Platform
Talend MDM Platform
Talend Data Services Platform
task
Design and Development > Third-party systems > Database components > MSSql components
Data Quality and Preparation > Third-party systems > Database components > MSSql components
Data Governance > Third-party systems > Database components > MSSql components
EnrichPlatform
Talend Studio

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

The Standard tMSSqlOutputBulkExec component belongs to the Databases family.

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

Basic settings

Action

Select the action to be carried out

Bulk insert Bulk update

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.

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.

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.

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 (columns) to Repository. 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. 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 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 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 connection check box is selected.

Field separator

Character, string or regular expression to separate fields.

Row separator

String (ex: "\n"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.

Usage

Usage rule

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

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 Scenario: Reading data from databases through context-based dynamic connections and Scenario: 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

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.