In this article

1 Overview
- 1.1 Snap Type
- 1.2 Prerequisites
- 1.3 Support for Ultra Pipelines
- 1.4 Known Issues
- 1.5 Limitations
2 Snap Views
3 Snap Settings
4 Examples
- 4.1 Downloads
5 Snap Pack History

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.

Snap Type

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.

Prerequisites

A valid account with the required permissions.

Support for Ultra Pipelines

Does not work for Ultra Pipelines.

Known Issues

None.

Limitations

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

Snap Views

Type	Format	Number of Views	Examples of Upstream and Downstream Snaps	Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min: 0
Max: 1

Mapper
Copy

Structure or JSON data from an upstream Snap that can pass a document output view.

Output

Document

Min: 1
Max: 1

JSON Formatter

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:

Stop Pipeline Execution: Stops the current Pipeline execution if the Snap encounters an error.
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

Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the fieldset.
Remove icon ( ): Indicates that you can remove fields from the fieldset.
Upload icon ( ): Indicates that you can upload files.

Field Name	Field Type	Description
Label* Default value: Generic JDBC - Table List Example: Load Employee Tables	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 Example: schema_demo	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.
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.
Snap Execution Default value: Validate & Execute Example: Execute only	Dropdown list	Select one of the following three modes in which the Snap executes: 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.

Examples

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.

Download this pipeline.

Downloads

	File	Modified
Labels No labels Preview View	File example-jdbc_tableList.slp	Feb 23, 2024 by Sneha Shiradkar

Snap Pack History

JDBC Snap Pack

SnapLogic Documentation

Generic JDBC - Table List