Overview

You can use this Snap to list the tables in a database. This Snap connects to the database, reads its metadata, and outputs a document for each table found in the database. The table names display in topological order in the output so that tables with few dependencies display first in the output. For example, if table A has a foreign key reference to table B, then table B displays first in the output before A. The ordering is intended to ease the process of replicating a group of tables from one database to another.

Snap Type

The AlloyDB Table List Snap is a Read Snap.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations and Known Issues

None.

Behavior Change

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
JSON Generator

The schema name from where the Snap must list the tables.

Output

Document

Min: 1
Max: 1

JSON Parser
File Writer

This Snap outputs a list of tables in a database. Documents with a "name" field containing the fully-qualified name of the table and a "type" field. To use the table name in another Snap, like a Select or Insert, you can pass it through for each Snap to another Pipeline with the Select or Insert.

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 field set.
Remove icon ( ): Indicates that you can remove fields from the field set.
Upload icon ( ): Indicates that you can upload files.

Field	Field Type	Description
Label* Default Value: AlloyDB Table List Example: List Tables	String	Specify a unique name for the Snap. Modify this to be more specific, especially if you have more than one Snap of the same type in your Pipeline.
Schema name Default Value: N/A Example: test	String/Expression/Suggestion	The database schema name. If it is not defined, then the suggestion for the table name will retrieve all tables names of all schemas. The property is suggestible and will retrieve available database schemas during suggest values.
Compute table graph Default Value: Not selected Example: Selected	Checkbox	Computes the dependents among tables and returns each table with a list of tables it has foreign key references to. The ordering of outputted tables is from least dependent to most dependent. Turning on this option will significantly slow down the Snap; leave it as off unless you need it.
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 runtime without generating preview data. Disabled: Disables the Snap and all Snaps that are downstream from it.

Snap Pack History

Google AlloyDB Snap Pack

SnapLogic Documentation

AlloyDB Table List