JDBC Metadata transform Icon JDBC Metadata

Description

The JDBC Metadata transform allows you to fetch metadata from a database connection, this includes schemas, tables and other objects.

Supported Engines

Hop Engine

Supported

Spark

Maybe Supported

Flink

Maybe Supported

Dataflow

Maybe Supported

Method and Arguments tab

In this tab, you can specify the java method of the DatabaseMetaData object which is to be called to obtain metadata. It also controls some other aspects of the steps behavior.

Always pass the input row: Controls how this step behaves in case there is no metadata. If this option is not checked, the step will not produce any output rows. If this option is checked, the incoming row will still be passed. Any output fields that originate from the metadata resultset will be NULL in this case.

Metadata Method: This dropdown list can be used to specify which metadata method to call upon the DatabaseMetaData object to obtain metadata:

Get arguments from fields: If this option is checked, arguments to the method can be specified by selecting a field from the incoming stream, and the value of that field is used as actual argument value. If this option is not checked, argument values can be entered directly as a literal into the argument fields.

Remove argument fields: This option is applicable when the Get arguments from fields is checked. When checked, the fields that are selected as argument fields are removed from the output stream. This is typically a convenient option when you chain several JdbcMetaData steps in sequence, using the fields coming out of upstream steps as argument fields for downstream steps. In such a case using this option will remove a lot of duplicate fields.

Output Fields tab

This tab allows you to control how the output metadata is added to the outputstream.

Output Fields: This grid is automatically filled with the appropriate fields as you select a particular metadata method on the Method and Aruments tab. Use this gridview to remove or rename output fields.

Get fields: use this button to refill the grid. This will re-add any removed fields, but preserve any renamed fields.