July 30, 2023

tMSSqlColumnList – Docs for ESB 7.x

tMSSqlColumnList

Lists all column names of a given MSSql table.

tMSSqlColumnList iterates on all
columns of a given table through a defined MS SQL connection.

tMSSqlColumnList Standard properties

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

The Standard
tMSSqlColumnList component belongs to the Databases family.

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

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

Database

Select a type of database from the list and click
Apply.

Component list

Select the tMSSqlConnection
component in the list if more than one connection are planned for
the current job.

Table name

Enter the name of the table.

Advanced settings

tStatCatcher Statistics

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

Global Variables

Global Variables 

COLUMN_NAME: the name of the column currently iterated
upon. This is a Flow variable and it returns a string.

COLUMN_DEFAULT: the default value of the column currently
iterated upon. This is a Flow variable and it returns a string.

IS_NULLABLE: nullability of the column currently
uiterated upon. This is a Flow variable and it returns YES if the column allows NULL;
otherwise, NO.

DATA_TYPE: the data type of the column currently iterated
upon. This is a Flow variable and it returns a string.

CHARACTER_MAXIMUM_LENGTH: the maximum length in number of
characters of the column currently iterated upon. This is a Flow variable, and it returns a
numeric string for binary or character data types and NULL for other types.

CHARACTER_OCTET_LENGTH: the maximum length in bytes of
the column currently iterated upon. This is a Flow variable, and it returns a numeric string
for binary or character data types and NULL for other types.

NUMERIC_PRECISION: the data precision of the column
currently iterated upon. This is a Flow variable, and it returns a numeric string for
approximate numeric data, exact numeric data, integer data, or monetary data and NULL for
other data types.

NUMERIC_PRECISION_RADIX: the data precision radix of the
column currently iterated upon. This is a Flow variable, and it returns a numeric string for
approximate numeric data, exact numeric data, integer data, or monetary data and NULL for
other data types.

NUMERIC_SCALE: the scale in digits allowed in the column
currently iterated upon. This is a Flow variable, and it returns a numeric string for
approximate numeric data, exact numeric data, integer data, or monetary data and NULL for
other data types.

DATETIME_PRECISION: the datetime precision in fractional
seconds of the column currently iterated upon. This is a Flow variable, and it returns a
numeric string if the data type is datetime or smalldatetime; otherwise, it returns
NULL.

COLUMN_KEY: the key indicator of the column currently
iterated upon. This is a Flow variable and it returns a string if the column is set to Key;
otherwise it returns nothing.

NB_COLUMN: the number of columns iterated upon so far.
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. 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 +
Space
to access the variable list and choose the variable to use from it.

For further information about variables, see
Talend Studio

User Guide.

Usage

Usage rule

This component is to be used along with MSSql components,
especially with tMSSqlConnection.

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.

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.

Related scenario

For tMSSqlColumnList related scenario, see Iterating on a DB table and listing its column names.


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