Generic JDBC - Schema List

In this article

Overview

You can use this Snap to display the list of schemas for the selected account in a database.

Generic_JDBC_Schema_list.png

Snap Type

The Generic JDBC - Schema List Snap is a Read type Snap.

Prerequisites

A valid account with the required permissions.

Support for Ultra Pipelines

Does not work in Ultra Pipelines

Known Issues and Limitations

None.

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.

  • type - The type of table. This value is currently set 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/Fieldset Name

Field Type

Description

Field/Fieldset Name

Field Type

Description

Label*

 

Default valueGeneric JDBC - Schema List

Example: Load Employee Schema

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.

Snap Execution

Default valueValidate & 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 schemas for the selected account. 

ex-pipeline-overview.jpg

Configure the Generic JDBC - Schema List Snap as follows.

On validation, the Snap displays the following output:

Download this pipeline.

Downloads

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts as applicable.

  3. Provide Pipeline parameters as applicable.

  File Modified

File example-jdbc_schemalist.slp

Feb 23, 2024 by Sneha Shiradkar

Snap Pack History


Related Content