tMSSqlColumnList – Docs for ESB 5.x

Component family

Databases/MS SQL

Function

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

Purpose

Lists all column names of a given MSSql table.

Basic settings

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.

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

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

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

Log4j

The activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User
Guide.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Limitation

n/a