Skip to end of banner
Go to start of banner

AlloyDB Table List

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

In this article

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 in topological order in the output so that tables with few dependencies are displayed first in the output.  For example, if table A has a foreign key reference to table B, then table B is displayed 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

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 

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 while 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 ((blue star)): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ((blue star) ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ( (blue star) ): Indicates that you can add fields in the fieldset.

  • Remove icon ( (blue star)): Indicates that you can remove fields from the fieldset.

  • Upload icon ((blue star) ): 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
Exampletest

String/Expression/Suggestion

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 ValueNot 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; it should be left as off unless you need it.

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.

Snap Pack History

Google AlloyDB Snap Pack

Release

Snap Pack Version

Date

Type

Updates

May 2024

main26341

Stable

Updated the Delete Condition (Truncates a Table if empty) field in the AlloyDB Delete Snap to Delete condition (deletes all records from a table if left blank) to indicate that all entries will be deleted from the table when this field is blank, but no truncate operation is performed.

February 2024

main25112

Stable

Updated and certified against the current SnapLogic Platform release.

November 2023

main23721

Stable

Updated and certified against the current SnapLogic Platform release.

August 2023

main22460

Stable

The AlloyDB Execute Snap now includes a new Query type field. When Auto is selected, the Snap tries to determine the query type automatically.

May 2023

main21015

Stable

Upgraded with the latest SnapLogic Platform release.

February 2023

main19844

Stable

Upgraded with the latest SnapLogic Platform release.

November 2022

main18944

Stable

The AlloyDB Insert Snap now creates the target table only from the table metadata of the second input view when the following conditions are met:

  • The Create table if not present checkbox is selected.

  • The target table does not exist.

  • The table metadata is provided in the second input view.

September 2022

430patches18149

Latest

The AlloyDB Select and AlloyDB Execute Snaps now read NaN values in Numeric columns.

4.30Patches

430patches17841

Latest

Introduced the Google AlloyDB Snap Pack— a fully managed PostgresSQL-compatible database service that you can use for all your database workloads. This Snap Pack offers the following Snaps:


  • No labels