In this article
Overview
This Snap outputs a list of tables in a database. The Snap will connect to the database, read its metadata, and output a document for each table found in the database. The table names are output in a topological order so that tables with the fewest dependencies are output first. In other words, if table A has a foreign key reference to table B, then table B will be output before A. The ordering is intended to ease the process of replicating a group of tables from one database to another.
Expected input: [None]
Expected output: Documents with a "name" field containing the fully-qualified name of the table and a "type" field that is currently fixed to the string "TABLE". To use the table name in another Snap, like a Select or Insert, you can pass it through a ForEach Snap to another pipeline with the Select or Insert.
Snap Type
AlloyDB Table List Snap is a Read Snap.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input |
|
| This Snap has at most one document input view. | |
Output | Document |
|
| This Snap has exactly one document output view. |
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 while 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. | |||
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.
Label* Default Value: AlloyDB Table List | String | N/A | 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 | String/Expression/Suggestion | N/A | The database schema name. In case 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 | Checkbox | N/A | 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; it should be left as off unless you need it. | |
Snap Execution Default Value: Validate & Execute | Dropdown list | N/A | Select one of the following three modes in which the Snap executes:
| |
Example
Download and import the Pipeline into SnapLogic.
Configure Snap accounts, as applicable.
Provide Pipeline parameters, as applicable.