Read Table

Operation name

Read Table

Function overview

Reads data stored in a table.

Data model

The data model of this component is table model type.

Tutorials

For details about how to create a connection to a MySQL database, refer to the following tutorial:

Create a connection to a MySQL database

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Table name	Required	Available	Select or enter a table name to be read.	The number of tables listed is determined in the settings for connection resources. When a schema name or table name in the database includes a period (.), you can ensure the name is handled properly by enclosing the schema name or table name with quotation marks. For example, when the quotation mark is " and the schema name and table name are A.B and C.D respectively, the proper way to enclose is "A.B"."C.D".
Enclose table name with quotation marks	Optional	Not available	Select whether or not to enclose the specified table name with quotation marks. Selected Enclose the table name displayed in Table name with quotation marks. Not selected (Default) Don't enclose the table name displayed in Table name with quotation marks. If the table name includes a character like a space, you need to enclose the table name with quotation marks. For details on characters that need to be enclosed with quotation marks, contact the database vendor.	Quotation marks which is set in each database connector is as follows: Oracle, DB2, PostgreSQL, Amazon Athena, Amazon RDS for Oracle, Amazon RDS for PostgreSQL "" (double quotations) SQL Server, Amazon RDS for SQL Server, Azure SQL Database [] (square brackets) MySQL, Amazon RDS for MySQL, Amazon Aurora for MySQL `` (backquotes) Note JDBC Connector doesn't have this property. The table name input in Table name is applied as is during execution. If the table name entered in Table name is enclosed with quotation marks, a query will be issued with the table name enclosed with quotation marks also during execution. If the table name entered in Table name isn't enclosed with quotation marks, this property will be checked during execution, and if this property is selected, a query will be issued with the table name enclosed with quotation marks. When environment variables are used in Table name, the value is deployed when selecting/unselecting this property.
Schema definition	Required	-	The schema definition of the table specified in Table name is displayed.	Among the columns displayed in Schema definition, the column names for which Target is selected will be displayed in Mapper schema. Schema definition can't be displayed in the following cases: When the user don't have read permission to the specified table When the specified table doesn't exist When a variable is specified in Table name When Table name isn't entered When an error has occurred in Table name
Schema definition/Target	Optional	Not available	Select whether to include each column of the table specified in Table Name in the target to read or not. Selected (Default) Include in the target to read. Not selected Don't include in the target to read.	The selected column names will be displayed in Mapper schema. You can operate all checkboxes at once by clicking the checkbox displayed in the header. Note One or more columns must be selected.
Schema definition/Column name	Required	Not available	A column name in the table specified in Table name is displayed.
Schema definition/Type	Required	Not available	The type of Column name is displayed.	It's displayed in "<Native type> (<Internal data type>)" format. Native type RDBMS specific data type. Internal data type Data type used internally. For details, refer to Internal data types.

Property actions

Item name	Description	Remarks
Extraction test	Issue a SELECT statement for the specified table. The number of retrieved records will be displayed as a result.	It can't be executed in the following cases: When the user don't have read permission to the specified table When the specified table doesn't exist When a variable is specified in Table name When Table name isn't entered When an error has occurred in Table name
Update schema definition	Update the schema definition of the table specified in Table name.	It can't be executed in the following cases: When the specified table doesn't exist When a variable is specified in Table name When Table name isn't entered When an error has occurred in Table name

Read settings

Item name	Required/Optional	Use of variables	Description	Remarks
Fetch size	Optional	Available	Specify the JDBC fetch size.	Allowed values are from 0 to 2147483647. The value input in this property will be specified as an argument for JDBC setFetchSize() method. Generally, the number of rows to get from the database at once is specified for fetch size, but the behavior might be different depending on the database or the JDBC driver used. When omitted or when a non-numeric value is entered, the behavior of the JDBC driver when the fetch size isn't set will be applied. Note If a large value is set for Fetch size, the memory usage increases and a memory shortage error may occur. The following connectors don't have this property: SQL Server Connector Amazon RDS for SQL Server Connector Azure SQL Database Connector
Enable query timeout	Required	Not available	Select whether or not to enable the query timeout. Selected Set the query timeout. Not selected (Default) Don't set the query timeout.	When this field isn't selected, the behavior of the JDBC driver when the query timeout isn't set will be applied.
Query timeout (seconds)	Required	Available	Set the query timeout.	Enabled when Enable query timeout is selected. Allowed values are from 0 to 2147483647. The value input in this property will be specified as an argument for JDBC setQueryTimeout() method. Generally, the seconds to wait for execution is specified for a query timeout, but the behavior might be different depending on the database or the JDBC driver used.

Item name

Required/Optional

Use of variables

Description

Remarks

Fetch size

Optional

Available

Specify the JDBC fetch size.

Allowed values are from 0 to 2147483647.
The value input in this property will be specified as an argument for JDBC setFetchSize() method.
Generally, the number of rows to get from the database at once is specified for fetch size, but the behavior might be different depending on the database or the JDBC driver used.
When omitted or when a non-numeric value is entered, the behavior of the JDBC driver when the fetch size isn't set will be applied.

Note

If a large value is set for Fetch size, the memory usage increases and a memory shortage error may occur.
The following connectors don't have this property:
- SQL Server Connector
- Amazon RDS for SQL Server Connector
- Azure SQL Database Connector

Enable query timeout

Required

Not available

Select whether or not to enable the query timeout.

Selected

Set the query timeout.

Not selected

(Default)

Don't set the query timeout.

When this field isn't selected, the behavior of the JDBC driver when the query timeout isn't set will be applied.

Query timeout (seconds)

Required

Available

Set the query timeout.

Enabled when Enable query timeout is selected.
Allowed values are from 0 to 2147483647.
The value input in this property will be specified as an argument for JDBC setQueryTimeout() method.
Generally, the seconds to wait for execution is specified for a query timeout, but the behavior might be different depending on the database or the JDBC driver used.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not available	Select a data processing method. Apply script settings (Default) The setting for mass data processing in the script properties is applied to the connector. Do not perform mass data processing Mass data processing isn't performed. Perform mass data processing Mass data processing is performed.

Item name

Required/Optional

Use of variables

Description

Remarks

Data processing method

Required

Not available

Select a data processing method.

Apply script settings

(Default)

The setting for mass data processing in the script properties is applied to the connector.

Do not perform mass data processing

Mass data processing isn't performed.

Perform mass data processing

Mass data processing is performed.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

The number of columns varies depending on the Schema definition settings.

= Remarks =

For schema structure, refer to Table model type .

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Transaction

Transaction is supported.

Mass data processing

Mass data processing is supported.

Parallel Stream Processing

PSP is supported.

= Remarks =

For details on PSP, refer to Parallel Stream Processing.

Available component variables

Component variable name	Description	Remarks
count	The number of read data records is stored.	The default value is null. Note Value isn't stored when using PSP.
error_code	When an error (SQLException) occurs, the error code corresponding to the error is stored.	The default value is null. 0 is stored when finishing successfully. Note Error codes are based on the specifications of each driver.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the DB2 connector
Messages and limitations of the MySQL connector
Messages and limitations of the Oracle connector
Messages and limitations of the PostgreSQL connector
Messages and limitations of the SQL Server connector
Messages and limitations of the JDBC connector
Messages and limitations of the Amazon Athena connector
Messages and limitations of the Amazon Aurora for MySQL connector
Messages and limitations of the Amazon RDS for MySQL connector
Messages and limitations of the Amazon RDS for Oracle connector
Messages and limitations of the Amazon RDS for PostgreSQL connector
Messages and limitations of the Amazon RDS for SQL Server connector
Messages and limitations of the Azure SQL Database connector
Messages and limitations of the Snowflake connector