Birst Query

Overview

You can use this Snap to execute a query on Birst and return the results.

This is a Read-type Snap.
Works in Ultra Tasks

Prerequisites

None.

Limitations and known issues

None.

Snap views


Type	Description	Examples of upstream and downstream Snaps
Input	This Snap has at most one document input view.	File Reader Mapper SOAP Execute
Output	This Snap has exactly one document output view.	Mapper Union Binary Copy
Learn more about Error handling.

Snap settings

Legend:

Expression icon (): Allows using JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
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 there are more than one of the same Snap in the pipeline.
Space id	String/Expression	Required. Specify the Space ID from the Birst application to execute a query against. Default value: N/A Example: 7d46ad8d-87b5-4c12-bbbe-ad4c4272522f
Query	String/Expression	Required. Specify the Birst logical query to execute. Default value: N/A Example: select [leads.First], [leads.Last], [leads.City], [leads.State], [leads.Zip] from [leads]
Fields	Use this field set to list down the result set of fields.
Field	String	Required. Specify the column names for the Birst query result. This property maps each column from Birst to a name that is provided. If more column names are defined than the number of columns in the query result, the pipeline fails. Click the icon to add required column names. Default value: N/A Example: first_name last_name city state zip
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.