Generic JDBC - Table List

Overview

You can use this Snap to obtain a list of tables from a database. The table names are displayed in a topological order so that tables with the less dependencies are listed first. In other words, if table A has a foreign key reference to table B, table B will be displayed before A.



Limitations

A Schema name with special characters is not supported for some of the databases.

Snap views

View Description Examples of upstream and downstream Snaps
Input Structure or JSON data from an upstream Snap that can pass a document output view.
Output This Snap outputs a list of tables with the following fields:

  • name: The fully-qualified name of the table. To use the table name in another Snap, such as Select or Insert.

  • type1: The type of table. This value is currently fixed to the string "TABLE".

  • dependents: (If Compute table graph is selected) A list of table names with references to this table, including this table.
Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • Discard Error Data and Continue Ignores the error, discards that record, and continues with the remaining records.
  • Route Error Data to Error View Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap settings

Legend:
  • Expression icon (): Allows using pipeline parameters to set field values dynamically (if enabled). SnapLogic Expressions are not supported. If disabled, you can provide a static value.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / Field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Generic JDBC - Table List

Example: Load Employee Tables
Schema name String/Expression/ Suggestion Specify the database schema name. Alternatively, you can select a schema name associated with the table from the suggestion list.
Note: If we don’t specify any schema name in the input, the Snap returns all the tables associated with all the schemas in the database.

Default value: N/A

Example: schema_demo
Computable table graph Checkbox Select this checkbox to compute the dependents among tables and return each table with a list of tables it has foreign key references to. The ordering of tables in the output is from least dependent to most dependent.
Note: When you select this checkbox, the performance of the Snap might be affected. Therefore, we recommend you to deselect this checkbox unless needed.

Default status: Deselected
Snap execution Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Default value: Execute only

Example: Validate & Execute

Examples