Birst Query

This page is no longer maintained (Jul 12, 2023). For the most current information, go to Birst Query.

On this Page

Snap type:

Read


Description:

This Snap executes a Birst logical query and returns the results as documents.


Prerequisites:

[None]


Support and limitations:Works in Ultra Task Pipelines.
Account: 

This Snap uses account references created on the Accounts page of the SnapLogic Manager to handle access to this endpoint. See Birst Account for information on setting up this type of account.


Views:
InputThis Snap has at most one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label


Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Space id


Required. The Space ID from the Birst application to execute a query against.
Example: c99dfb81-2fd9-4133-902e-3607dd666a07
Default value: [None]


Query

Required. The Birst logical query to execute.
Example: select [leads.First], [leads.Last], [leads.City], [leads.State], [leads.Zip] from [leads]
Default value: [None]


Fields 

Required. 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.
Example

Default value: [None]

Snap Execution

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.

Snap Pack History

 Click to view/expand
ReleaseSnap Pack Version DateTypeUpdates
August 2023main22460 StableUpdated and certified against the current SnapLogic Platform release.
May 2023main21015 StableUpdated and certified against the current SnapLogic Platform release.
February 2023main19844 StableUpdated and certified against the current SnapLogic Platform release.
November 2022main18944 StableUpdated and certified against the current SnapLogic Platform release.
August 2022main17386 StableUpdated and certified against the current SnapLogic Platform release.
4.29main15993 StableUpdated and certified against the current SnapLogic Platform release.
4.28main14627 StableUpdated and certified against the current SnapLogic Platform release.

4.27

main12833

 

Stable

Updated and certified against the current SnapLogic Platform release.
4.26main11181 StableUpdated and certified against the current SnapLogic Platform release.
4.25main9554
 
StableUpdated and certified against the current SnapLogic Platform release.
4.24main8556
StableUpdated and certified against the current SnapLogic Platform release.
4.23main7430
 
StableUpdated and certified against the current SnapLogic Platform release.
4.22main6403
 
StableUpdated and certified against the current SnapLogic Platform release.
4.21snapsmrc542

 

StableUpdated and certified against the current SnapLogic Platform release.
4.20snapsmrc535
 
StableUpdated and certified against the current SnapLogic Platform release.
4.19birst8471
 
Latest

Fixes the Birst Upload Snap where the Snap fails to log in with a token error.

4.19snaprsmrc528
 
StableUpdated and certified against the current SnapLogic Platform release.
4.18snapsmrc523
 
StableUpdated and certified against the current SnapLogic Platform release.
4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
Latest

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16snapsmrc508
 
StableUpdated and certified against the current SnapLogic Platform release.
4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14birst5671 
 
Latest
Updated the Birst Upload Snap with the following:
  • Renamed the "Uploaded Filename" field to "Data Source" to ensure that the field name aligns with Birst.
  • Parameterized the "Sub groups" field.
  • Routed timeout exception to the Error view.
4.14snapsmrc490
 
StableUpdated and certified against the current SnapLogic Platform release.
4.13

snapsmrc486

 
StableUpdated and certified against the current SnapLogic Platform release.
4.12birst5000
 
Latest

Fixed an issue with the Birst Upload Snap Pack that fails upon account configuration.

4.12

snapsmrc480

 
StableUpdated and certified against the current SnapLogic Platform release.
4.11snapsmrc465
 
StableUpdated and certified against the current SnapLogic Platform release.
4.10

snapsmrc414

 
StableUpdated and certified against the current SnapLogic Platform release.
4.9snapsmrc405
 
StableUpdated and certified against the current SnapLogic Platform release.
4.8

snapsmrc398

 
StableUpdated and certified against the current SnapLogic Platform release.
4.7

snapsmrc382

 
StableUpdated and certified against the current SnapLogic Platform release.
4.6snapsmrc362
 
StableUpdated and certified against the current SnapLogic Platform release.
4.5.1

snapsmrc344

 
StableUpdated and certified against the current SnapLogic Platform release.
4.5

snapsmrc344

 
Stable

Doc Enhancement: Example added to Foursquare Snap Pack.

January 2015NA
Latest
  • Account validation added.
  • An optional input error view added to both Birst Snaps.
  • Birst Upload now has a document input view (instead of a binary input view) and accepts documents which will get formatted into Birst's csv format internally. This is not backwards compatible.

December 20, 2014

NA
StableUpdated and certified against the current SnapLogic Platform release.