Vertica - Table List

Vertica - Table List

This page is no longer maintained (May 13, 2026). For the most current information, go to Vertica - Table List.


On this Page

Snap type:

Write

 

Description:

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: N/A

Expected output: Documents with the following fields:

Replicating a Subset of Tables

The output of the Table List Snap can be directly used to replicate an entire database.  However, if you are only interested in a subset of tables, you can use a Filter Snap to select the table names you are interested in as well as the tables that they reference. For example, given the following diamond-shaped table graph where A depends on B and C and they both depend on D:
 

A / \ B C \ / D

The Table List will output the following documents:

name=D; dependents=[A, B, C, D] name=C; dependents=[A, C] name=B; dependents=[A, B] name=A; dependents=[A]

So, if you wanted to copy just table 'A' and its dependencies, you can add a Filter Snap with the following expression:

$.dependents.indexOf('A') != -1

The filter will then remove any extra tables that happen to be in the schema. 

 

Prerequisites:

N/A

Support and limitations:

Works in Ultra Tasks.

Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Vertica Accounts for information on setting up this type of account.

Views:

Input

This Snap has exactly one input view.

Output

This Snap has at most one output view.

Error

This Snap has at most one error view and produces zero or more documents in the view.

Settings

Label

 

Required. 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.

Schema name 

 

 

The database schema name. Selecting a schema filters the Table name list to show only those tables within the selected schema. The property is suggestible and retrieves available database schemas during suggest values.

Example: public

Compute table graph

 

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. Note that as turning on this option will significantly slow down the Snap, it should be left as off unless you need it.

Default value: Not selected

Snap Execution

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.

Default ValueExecute only
Example: Validate & Execute

Examples

In this pipeline, the Vertica Table List Snap lists the tables present in the schema, 'public'.

The output preview: