On this Page
Overview
The Catalog Query Snap enables you to read the metadata associated with a specific table in the SnapLogic data catalog.
Expected Input and Output
- Expected Input: A document stream containing information related to the metadata table that must be queried.
- Expected Output: A document stream containing the contents of the the metadata table that must be queried.
- Expected Upstream Snaps: Any Snap that offers document streaming data. Examples: Catalog Insert, Mapper.
- Expected Downstream Snaps: Required. Any Snap that accepts document streaming data in its input view. Examples: JSON Formatter, Catalog Insert.
Prerequisites
Read access to the SnapLogic metadata catalog.
Configuring Accounts
Accounts are not used with this Snap.
Configuring Views
Input | This Snap has at most one document input view. |
|---|---|
| Output | Required. This Snap has exactly one document output view. |
| Error | This Snap has at most one document error view. |
Troubleshooting
None.
Describe typical issues the user may encounter while using this Snap, provide instructions on how to work around them.
Known Issues
- Does not work in Ultra pipelines.
List out limitations in the usage of this Snap, if the limitation is imposed by the endpoint mention so with links to relevant documentation in the endpoint's official documentation where the limitation is described (as done in SQS Producer and Consumer). For new Snaps this information may not be readily available, get in touch with the corresponding Developers to get this information.
The idea is to enable the user to get a good idea of the Snap's functionality, prerequisites, limitations, accounts, and views. Fill all the relevant sections, and if the information is not available (perhaps it is a new Snap and you don't know its limitations), then just add "None at this time".
Snap Settings
| Label | Required. The name for the Snap. Modify this to be more specific, especially if there are more than one of the same Snap in the pipeline. |
|---|---|
| Table Name | The location and name of the table that you want to query. Structure: /<Org>/<Project>/<Table_Name> Example: /TestOrg/shared/Docs_Test_Table Default value: None. |
| Partition Keys | The partition keys in the target table from which you want to extract metadata |
| Key Name | The key you want to use to query a specific partition in a metadata table. Example: airline_code Default value: None |
| Operator | The operator that you want to use in the condition required to locate the table partition. Example: != Default value: = |
| Key Value | The value that you want to use in the condition required to locate the table partition. Example: 10 Default value: None |
Examples
Downloads
