In this article
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.
The Generic JDBC - Table List Snap is a Read-type Snap that reads the tables' metadata from database and displays a document for each table found in the database.
A valid account with the required permissions.
Does not work for Ultra Pipelines.
None.
A Schema name with special characters is not supported for some of the databases.
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| Structure or JSON data from an upstream Snap that can pass a document output view. |
Output | Document |
|
| This Snap outputs a list of tables with the following fields:
|
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:
Learn more about Error handling in Pipelines. |
|
Field Name | Field Type | Description |
---|---|---|
Label* Default value: Generic JDBC - Table List | String | Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline. |
Schema name Default value: N/A | String/Expression/Suggestion | Specify the database schema name. Alternatively, you can select a schema name associated with the table from the suggestion list. 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. 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. |
Compute table graph Default value: Deselected | 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. When you select this checkbox, the performance of the Snap might be affected. Therefore, we recommend you to deselect this checkbox unless needed. When you select this checkbox, the performance of the Snap might be affected. Therefore, we recommend you to deselect this checkbox unless needed. |
Snap Execution Default value: Validate & Execute | Dropdown list | Select one of the following three modes in which the Snap executes:
|
The following example pipeline demonstrates how to retrieve all the tables for the selected schema.
Configure the Generic JDBC - Table List Snap as follows.
On validation, the Snap displays the following output.
|