Birst Query
Overview
You can use this Snap to execute a query on Birst and return the results.
Read-type Snap
Works in Ultra Tasks
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:
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 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:
|
| Snap execution | Dropdown list | Select one of the three modes in which the Snap executes.
Available options are:
|