...
Table of Contents | ||||||
---|---|---|---|---|---|---|
|
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 are displayed display in a topological order in the output so that tables with few dependencies are displayed display first in the output. For example, if table A has a foreign key reference to table B, then table B is displayed 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
Multiexcerpt fast include block macro | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| The schema name from where the Snap must list the tables. |
Output | Document |
|
| 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:
Learn more about Error handling in Pipelines. |
Snap Settings
Info |
---|
|
Field | Field Type | Description | |
Label* Default Value: AlloyDB Table List | 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 | 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 | 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 | Dropdown list | Select one of the following three modes in which the Snap executes:
|
|
Snap Pack History
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|
...
Related Links
...
...