Catalog Query

Overview

The Catalog Query Snap enables you to read the metadata associated with a specific table in the SnapLogic data catalog.

Note: Accounts are not used with this Snap.


Prerequisites

Read access to the SnapLogic data catalog.

Snap views

View Description Examples of upstream and downstream Snaps
Input This Snap has at most one document input view.

A document stream containing information related to the metadata table that must be queried.
Output This Snap has exactly one document output view.

A document stream containing the contents of the metadata table that must be queried.
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. The available options are:

  • Stop Pipeline Execution Stops the current pipeline execution when an error occurs.
  • 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

Legend:
  • Expression icon (): Allows using pipeline parameters to set field values dynamically (if enabled). SnapLogic Expressions are not supported. If disabled, you can provide a static value.
  • SnapGPT (): Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
  • Suggestion icon (): Populates a list of values dynamically based on your Snap configuration. You can select only one attribute at a time using the icon. Type into the field if it supports a comma-separated list of values.
  • Upload : Uploads files. Learn more.
Learn more about the icons in the Snap settings dialog.
Field / Field set Type Description
Label String

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Catalog Query

Example: Catalog Query
Table Name Dropdown list/Expression

Required. The location and name of the table that you want to query.

Structure: /<Org>/<Project>/<Table_Name>

Default value: None.

Example: /TestOrg/shared/Docs_Test_Table
Partition Keys

The partition keys in the target table from which you want to extract metadata

Key Name String/Expression

The key you want to use to query a specific partition in a metadata table.

Default value: None.

Example: airline_code
Operator Dropdown list/Expression

The operator that you want to use in the condition required to locate the table partition.

Default value: =

Example: !=
Key Value Integer/Expression The value that you want to use in the condition required to locate the table partition.

Default value: None.

Example: 10
Snap execution Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • 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 value: Execute Only

Default value: Validate & Execute

Examples