Skip to end of banner
Go to start of banner

Redshift - 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 14 Next »

On this Page

Snap Type:

Read

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: [None]
  • Expected output: Documents with the following fields:
    • name -  The fully-qualified name of the 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.
    • type - The type of table. This value is currently fixed to the string "TABLE".
    • dependents - (If Compute table graph is selected) A list of table names that have references to this table, including this table.

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.

ETL Transformations & Data Flow

This snap is a data source. It works by performing a standard JDBC DatabaseMetaData#getTables() query for the tables within the database. The Schema name value is used to populate the schemaPattern parameter in that query.

This snap does not require any temporary files or other external resources.


Input & Output

  • Input:  [None]

    Any input documents are ignored.

    • Input Schema Provided: No

    • Output: This snap produces one document per table upon successful execution. The fields are:

      • name -  The fully-qualified name of the 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.
      • type - The type of table. This value is currently fixed to the string "TABLE".
      • dependents - (If Compute table graph is selected) A list of table names that have references to this table, including this table.

    • Output Schema Provided: Yes

    • Preview Supported: Yes

    • Passthrough Supported: No

    • Output Examples:

      • Example output upon successful execution without Compute table graph selected:

        [
  {
    "name": "\"demo\".\"'redshiftbulkload'\"",
    "type": "TABLE"
  },
  {
    "name": "\"demo\".\"'shankaradp'\"",
    "type": "TABLE"
  },
  {
    "name": "\"demo\".\"'shankaradp1'\"",
    "type": "TABLE"
  },
  {
    "name": "\"demo\".\"'shankardemo'\"",
    "type": "TABLE"
  },
  {
    "name": "\"demo\".\"'shankardemo1'\"",
    "type": "TABLE"
  }
]

      • Example output upon successful execution with Compute table graph selected:

          {
    "name": "\"demo\".\"account\"",
    "type": "TABLE",
    "dependents": [
      "\"demo\".\"account\""
    ]
  },
  {
    "name": "\"demo\".\"account_transaction\"",
    "type": "TABLE",
    "dependents": [
      "\"demo\".\"account_transaction\""
    ]
  },
  {
    "name": "\"demo\".\"accounts_oy\"",
    "type": "TABLE",
    "dependents": [
      "\"demo\".\"accounts_oy\""
    ]
  }
]

Expected upstream Snaps: Any Snap with a document output view. Note: the contents of  the input view are ignored so pipelines should only be used to sequence operations.

Expected downstream Snaps: Any Snap with a document input view, such as JSON Formatter, Mapper, and so on. The CSV Formatter Snap cannot be connected directly to this Snap since the output document map data is not flat.

Modes

Prerequisites:
  • The Redshift account does need to specify the Endpoint, Database name, Username, and Password.
  • The Redshift account does not need to specify the S3 Access-key ID, S3 Secret key, S3 Bucket, and S3 Folder.
  • The Redshift account security settings does need to allow access from the IP Address of the cloudplex or groundplex.
Limitations and Known IssuesNone at the moment.
Configurations: 

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


Views:
Input

This Snap has at most one document input view.

All input documents are ignored.

Output

This Snap has exactly one document output view.

The output document contains map data:

  • a "name" field containing the fully-qualified name of the table.
  • a "type" field containing the type of table. This is currently limited to "TABLE".
  • an optional "dependents" field containing a list of tables with foreign references to this table.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.
Troubleshooting:None at the moment.

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


This field appears to support expressions but does not.

Example: test

Default value: [None]

Expression property: No

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. 

Turning on this option will significantly slow down the Snap; it should be left as off unless you need it.

Default value: Not selected

Page lookup error: page "Anaplan Read" not found.

If you're experiencing issues please see our Troubleshooting Guide.

Page lookup error: page "Anaplan Read" not found.

If you're experiencing issues please see our Troubleshooting Guide.

Examples

Basic Use Case

The following pipeline describes how the Snap functions in a standalone Snap in a pipeline.

  • Below is a preview of the output from the Redshift Table List Snap depicting that all the tables records from ALL schema:

Refer to the "Redshift Table List_ALL.slp" in the Downloads section for the pipeline reference

  • Below is a preview of the output from the Redshift Table List Snap depicting that all the tables records from the mentioned schema:

Refer to the "Redshift Table List_1.slp" in the Downloads section for the pipeline reference

  • Below is a preview of the output from the Redshift Table List Snap depicting that all the tables records from the mentioned schema with the dependents:


Refer to the "Redshift Table List_2.slp" in the Downloads section for the pipeline reference

Typical Snap Configurations

  • Listing the tables in ALL schema without the graph of dependents as depicted in the first example of Basic Use case by providing the "Schema name"
  • Listing the tables in the schema without the graph of dependents as depicted in the second example of Basic Use case by providing the "Schema name"
  • Listing the tables in the schema with the graph of dependents as depicted in the third example of Basic Use case by providing the "Schema name" and selecting the "Compute table graph"

Downloads

  File Modified
You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.
No files shared here yet.
  • Drag and drop to upload or browse for files

    • Snap Pack History

     Click to view/expand
    Release Snap Pack VersionDateType  Updates
    February 2024main25112 StableUpdated and certified against the current SnapLogic Platform release.
    November 2023main23721

     

    		StableUpdated and certified against the current SnapLogic Platform release.
    August 2023main22460 Stable
    • The Redshift-Bulk Load and Redshift-Bulk Upsert Snaps now support expression enablers for the Additional options field that enables you to use parameters.
    • The Redshift - Execute Snap now includes a new Query type field. When Auto is selected, the Snap tries to determine the query type automatically.


    Behavior Change

    Starting with version main22460, in the Redshift Select Snap:

    • When you create a table in Redshift, by default, all column names are displayed in lowercase in the output.

    • When you enter column names in uppercase in the Output Field property, the column names are displayed in lowercase in the output.

    May 2023

    		main21015 

    Stable

    Upgraded with the latest SnapLogic Platform release.

    February 2023

    432patches20500

    		 Latest

    The Redshift Account no longer fails when a URL is entered in the JDBC URL field and no driver is specified.

    February 2023432patches20166 Latest

    Updated the description for S3 Security Token field as follows:

    Specify the S3 security token part of AWS Security Token Service (STS) authentication. It is not required unless a particular S3 credential is configured to require it.

    February 2023432patches20101

      

    		Latest

    • The JDBC driver class for Redshift accounts is bundled with the com.amazon.redshift.jdbc42.Driver as the default driver. This upgrade is backward-compatible. The existing pipelines will continue to work as expected and the new pipelines will use the Redshift Driver as the default driver. SnapLogic will support providing fixes for the issues you might encounter with accounts that use the PostgreSQL driver only until November 2023.
      After November 2023, SnapLogic will not provide support for the issues with the PostgreSQL driver. Therefore, we recommend you to migrate from the PostgreSQL JDBC driver to the Redshift JDBC driver. Learn more about migrating from the PostgreSQL JDBC Driver to the Amazon Redshift Driver. (432patches20101)

    • The Instance type option in the Redshift Bulk Load Snap enables you to use the Amazon EC2 R6a instance. This property appears only when the parallelism value is greater than one.

    February 2023432patches20035

     

    		Latest

    The Redshift Snaps that earlier supported only Redshift Cluster now support Redshift Serverless as well. With Redshift Serverless, you can avoid setting up and managing data warehouse infrastructure when you run or scale analytics.

    February 2023main19844 StableUpgraded with the latest SnapLogic Platform release.
    November 2022main18944 Stable

    The Redshift - 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.

    August 2022430patches17189 Latest
    August 2022main17386 Stable

    The Redshift accounts support:

    • Expression enabler to pass values from Pipeline parameters.

    • Security Token for S3 bucket external staging.

    4.29 Patch429patches16908 Latest

    • Enhanced the Redshift accounts with the following:

      • Expression enabler to pass values from Pipeline parameters.

      • Support for Security Token for S3 bucket external staging.

    • Fixed an issue with Redshift - Execute Snap where the Snap failed when the query contained comments with single or double quotes in it. Now the Pipeline executes without any error if the query contains a comment.

    4.29 Patch

    429patches15806

    		 Latest

    Fixed an issue with Redshift Account and Redshift SSL Account where the Redshift Snaps failed when the S3 Secret key or S3 Access-key ID contained special characters, such as +.

    4.29

    main15993

     

    Stable

    Upgraded with the latest SnapLogic Platform release.

    4.28main14627 StableUpdated the label for Delete Condition to Delete Condition (Truncates Table if empty) in the Redshift Delete Snap.
    4.27 Patch427patches12999 LatestFixed an issue with the Redshift Bulk Load Snap, where the temporary files in S3 were not deleted for aborted or interrupted Pipelines.
    4.27 Patch427patches12999 Latest
    4.27main12833 Stable

    Enhanced the Redshift - Execute Snap to invoke stored procedures.

    4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
    4.25 Patch425patches11008 Latest

    Updated the AWS SDK from version 1.11.688 to 1.11.1010 in the Redshift Snap Pack and added a custom SnapLogic User Agent header value.

    4.25main9554
     
    		StableUpgraded with the latest SnapLogic Platform release.
    4.24main8556
    		Stable
    4.23main7430
     
    		Stable

    Fixed an issue with the Redshift Bulk Load Snap that fails while displaying a Failed to commit transaction error.

    4.22main6403
     
    		StableUpgraded with the latest SnapLogic Platform release.
    4.21 Patch421patches6144 Latest

    Fixed the following issues with DB Snaps:

    • The connection thread waits indefinitely causing the subsequent connection requests to become unresponsive.
    • Connection leaks occur during Pipeline execution.
    4.21 PatchMULTIPLE8841 Latest

    Fixed the connection issue in Database Snaps by detecting and closing open connections after the Snap execution ends. 

    4.21snapsmrc542

     

    		StableUpgraded with the latest SnapLogic Platform release.
    4.20 Patch db/redshift8774
    		Latest

    Fixed the Redshift - Execute Snap that hangs if the SQL statement field contains only a comment ("-- comment"). 

    4.20snapsmrc535
     
    		StableUpgraded with the latest SnapLogic Platform release.
    4.19 Patch db/redshift8410 Latest

    Fixed an issue with the Redshift - Update Snap wherein the Snap is unable to perform operations when:

    • An expression is used in the Update condition property.
    • Input data contain the character '?'.
    4.19snaprsmrc528
     
    		StableUpgraded with the latest SnapLogic Platform release.
    4.18 Patch db/redshift8043 Latest

    Enhanced the Snap Pack to support AWS SDK 1.11.634 to fix the NullPointerException issue in the AWS SDK. This issue occurred in AWS-related Snaps that had HTTP or HTTPS proxy configured without a username and/or password. 

    4.18 PatchMULTIPLE7884 Latest

    Fixed an issue with the PostgreSQL grammar to better handle the single quote characters.

    4.18 PatchMULTIPLE7778 Latest

    Updated the AWS SDK library version to default to Signature Version 4 Signing process for API requests across all regions.

    4.18snapsmrc523
     
    		StableUpgraded with the latest SnapLogic Platform release.
    4.17 Patchdb/redshift7433 Latest

    Fixed an issue with the Redshift Bulk Load Snap wherein the Snap fails to copy the entire data from source to the Redshift table without any statements being aborted.

    4.17ALL7402
     
    		Latest

    Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

    4.17snapsmrc515
     
    		Latest
    • Fixed an issue with the Redshift Execute Snap wherein the Snap would send the input document to the output view even if the Pass through field is not selected in the Snap configuration. With this fix, the Snap sends the input document to the output view, under the key original, only if you select the Pass through field.
    • Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview checkbox.
    4.16 Patch db/redshift6821 Latest

    Fixed an issue with the Lookup Snap passing data simultaneously to output and error views when some values contained spaces at the end.

    4.16snapsmrc508
     
    		StableUpgraded with the latest SnapLogic Platform release.
    4.15 Patch db/redshift6286 Latest

    Fixed an issue with the Bulk Upsert Snap wherein there was no output for any input schema.

    4.15 Patch db/redshift6334 Latest

    Replaced Max idle time and Idle connection test period properties with Max life time and Idle Timeout properties, respectively, in the Account configuration. The new properties fix the connection release issues that were occurring due to default/restricted DB Account settings.

    4.15snapsmrc500
     
    		StableUpgraded with the latest SnapLogic Platform release.
    4.14 Patch db/redshift5786 Latest

    Fixed an issue wherein the Redshift Upload snap logged the access and secret keys without encryption in the error logs. The keys are now masked.

    4.14 Patch db/redshift5667 Latest
    • Added "Validate input data" property in the Redshift Bulk Load Snap to enable users to troubleshoot input data schema.
    • Enhanced a check to identify whether the Provided Query in the Redshift Execute Snap is of read or write type.
    4.14snapsmrc490
     
    		StableUpgraded with the latest SnapLogic Platform release.
    4.13 Patch db/redshift/5303 Latest

    Added a new property "Validate input data" in the Redshift Bulk Load Snap to help users troubleshoot the input data schema.

    4.13 Patch db/redshift5186 Latest

    Fixed the Bulk Load and Unload Snaps wherein the KMS encryption type property is failing with validation error.

    4.13

    snapsmrc486

     
    		Stable

    Added KMS encryption support to these Snaps: Redshift Unload, Redshift Bulk Load, Redshift Bulk Upsert, and Redshift S3 Upsert.

    4.12 Patch db/redshift5027 Latest

    Fixed an issue wherein the Redshift Snaps timeout and fail to retrieve a database connection.

    4.12 Patch

    		MULTIPLE4967 Latest

    Provided an interim fix for an issue with the Redshift accounts by re-registering the driver for each account validation. The final fix is being shipped in a separate build.

    4.12 Patch

    		MULTIPLE4744 Latest

    Added support for Redshift grammar to recognize window functions as being part of the query statement.

    4.12

    snapsmrc480

     
    		StableUpgraded with the latest SnapLogic Platform release.
    4.11 Patch db/redshift4589 Latest

    Fixed an issue when creating a Redshift table via the second/metadata input view for the Redshift Bulk Load Snap.

    4.11snapsmrc465
     
    		Stable

    Added SSL support to the Configuring Redshift Accounts.

    4.10 Patch db/redshift4115 Latest

    The Upsert or BulkUpdate/BulkLoad shall not execute and produce output when no inputView has been provided.

    4.10 Patchredshift3936 Latest

    Addressed an issue in Redshift Execute with a Select that hangs after extracting 13 million in the morning or 30 million in the evening 

    4.10

    snapsmrc414

     
    		Stable

    Added Auto commit property to the Select and Execute Snaps at the Snap level to support overriding of the Auto commit property at the Account level.

    4.9.0 Patch

    		redshift3229 Latest

    Addressed an issue in Redshift Multiple Execute where INSERT INTO SELECT statement generated a 'transaction, commit and rollback statements are not supported' exception.

    4.9.0 Patch

    		redshift3073 Latest

    Fixed an issue regarding connection not closed after login failure; Expose autocommit for "Select into" statement in PostgreSQL Execute Snap and Redshift Execute Snap

    4.9snapsmrc405
     
    		Stable

    • Updated the Bulk Load, Bulk Upsert and S3 Upsert Snaps with the properties Vacuum type & Vacuum threshold (%) (replaced the original Vacuum property).

    • Update the S3 Upsert Snap with the properties, IAM role and Server-side encryption to support data upsert across two VPCs.

    • Added support for the Redshift driver under the account setting for JDBC jars.

    4.8.0 Patchredshift2852 Latest

    • Addressed an issue with Redshift Insert failing with 'casts smallint as varchar'

    • Addressed an issue with Redshift Bulk Upsert fails to drop temp table

    4.8.0 Patchredshift2799 Latest

    • Addressed an issue with Redshift Snaps with the default driver failing with could not load JDBC driver for url file.

    • Added the properties, JDBC Driver Class, JDBC jars and JDBC Url to enable the users to upload the Redshift JDBC drivers that can override the default driver.
    4.8.0 Patchredshift2758 Latest

    Potential fix for JDBC deadlock issue.

    4.8.0 Patch

    		redshift2713 Latest

    Fixed Redshift Snap Pack rendering dates that are one hour off from the date returned by database query for non-UTC Snaplexes

    4.8.0 Patch

    		redshift2697 Latest

    Addresses an issue where some changes made in the platform patch MRC294 to improve performance caused Snaps in the listed Snap Packs to fail.

    4.8

    snapsmrc398

     
    		Stable

    • Redshift MultiExecute Snap introduced in this release.

    • Redshift Account: Info tab added to accounts.

    • Database accounts now invalidate connection pools if account properties are modified and login attempts fail.

    • Info tab added to accounts.
    • Database accounts now invalidate connection pools if account properties are modified and login attempts fail.
    4.7.0 Patchredshift2434 Latest

    Replaced newSingleThreadExecutor() with a fixed thread pool.

    4.7.0 Patch

    		redshift2387 Latest

    Addressed an issue in Redshift Bulk Load Snap where Load Empty String was setting not working after release.

    4.7.0 Patch

    		redshift2223 Latest

    Auto-commit is turned off automatically for SELECT

    4.7.0 Patch

    		redshift2201

     

    		Latest

    Fixed an issue for database Select Snaps regarding Limit rows not supporting an empty string from a pipeline parameter.

    4.7

    snapsmrc382

     
    		Stable

    • Updated the Redshift Snap Account Settings with the IAM properties that include AWS account ID , IAM role name, and Region name.

    • Redshift Bulk Load Snap updated with the properties IAM Role & Server-side encryption.

    • Redshift Bulk Upsert Snap updated with the properties Load empty strings, IAM Role & Server-side encryption.

    • Updated the Redshift Upsert Snap with Load empty strings property.

    • Updated the Redshift Unload Snap with the property IAM role.

    4.6snapsmrc362
     
    		Stable

    • Redshift Execute Snap enhanced to fully support SQL statements with/without expressions & SQL bind variables.

    • Resolved an issue in Redshift Execute Snap that caused errors when executing a command Select current_schemas(true).

    • Resolved an issues in Redshift Execute Snap that caused errors when a Select * from <table_name> into statement was executed.

    • Enhanced error reporting in Redshift Bulk Load Snap to provided appropriate resolution messages.

    4.5.1

    redshift1621

     
    		Latest

    • Redshift S3 Upsert Snap introduced in this release.

    • Resolved an issue that occurred while inserting mismatched data type values in Redshift Insert Snap.

    4.5

    snapsmrc344

    		 Stable

    • Resolved an issue in Redshift Bulk Upsert Snap that occurred when purging temp tables.

    • Resolved an issue in Redshift Upload/Upsert Snap that occurred when using IAM credentials in an EC2 instance with an S3 bucket.

    4.4.1NA Latest

    Resolved an issue with numeric precision when trying to use create table if not present in Redshift Insert Snap.

    4.4NA StableUpgraded with the latest SnapLogic Platform release.
    4.3.2NA Stable

    • Redshift Select Where clause property now has expression support.

    • Redshift Update Update condition property now has expression support.

    • Resolved an issue with Redshift Select Table metadata being empty if the casing is different from the suggested one for table name

    4.3NA Stable

    • Table List Snap: A new option, Compute table graph, now lets you determine whether or not to generate dependents data into the output.

    • Redshift Unload Snap Parallel property now explicitly adds 'PARALLEL [OFF|FALSE]' to the UNLOAD query.

    4.2NA Latest

    • Resolved an issue where Redshift SCD2 Snap historized the current row when no Cause-historization fields had changed.

    • Ignore empty result added to Execute and Select Snaps. The option will not any document to the output view for select statements.

    • Resolved an issue with Redshift Select Snap returning a Date object for DATE column data type instead of a LocalDate object.

    • Resolved an issue in RedShift SCD2 failing to close database cursor connection.

    • Resolved an issue with Redshift Lookup Snap not handling values with spaces in the prefix.

    • Updated driver not distributed with the Redshift Snap Pack.

    • Output fields table property added to Select Snap.

    • Resolved an issue with Redshift - Bulk Loader incorrectly writing to wrong location on S3 and disable data compression not working

    • Resolved an issue in Execute and Select Snaps where the output document was the same as the input document if the query produces no data. When there is no result from the SELECT query, the input document will be passed through to the output view as a value to the 'original' key. The new property Pass through with true default.

    NANA NA

    • Redshift Account: Enhanced error messaging

    • Redshift SCD2: Bug fixes with compound keys

    • RedShift Lookup: Bug fixes on lookup failures; Pass-though on no lookup match property added to allow you to pass the input document through to the output view when there is no lookup matching.

    • No labels

    Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
    © 2017-2024 SnapLogic, Inc.