Birst Query

Overview

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


Birst Query Overview

Prerequisites

None.

Limitations and Known Issues

None.

Snap Views

View Description Examples of Upstream and Downstream Snaps
Input This Snap has at most one document input view.
Output This Snap has exactly one document output view.
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 the Snap encounters an error.
  • 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

Note:
  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
  • Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
  • Add icon (): Indicates that you can add fields in the field set.
  • Remove icon (): Indicates that you can remove fields from the field set.
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: N/A

Example: 7d46ad8d-87b5-4c12-bbbe-ad4c4272522f
Query String/Expression Required. Specify the Birst logical query to execute.

Default: N/A

Example: select [leads.First], [leads.Last], [leads.City], [leads.State], [leads.Zip] from [leads]
Fields 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: N/A

Example:
  • first_name
  • last_name
  • city
  • state
  • zip
Snap Execution Dropdown list Select 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.