BigQuery Dataset List

In this article

Overview

You can use this Snap to list BigQuery Datasets.

Snap Type

BigQuery Datatset List Snap is a Read-type Snap that reads dataset from BigQuery.

Prerequisites

.A valid Google BigQuery Account with the required permissions.

Support for Ultra Pipelines  

Works in Ultra Pipelines.

Limitations and Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

 

  • Min: 0

  • Max: 1

  • Mapper

  • JSON Generator

The Project ID from which the Snap reads the dataset to be listed.

Output

Document

 

  • Min: 1

  • Max: 1

  • File Writer

  • Mapper

The dataset list.

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 while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current pipeline execution if 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

  • Asterisk ( * ): Indicates a mandatory field.

  • Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon ( ): Indicates 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 fieldset.

  • Remove icon ( ): Indicates that you can remove fields from the fieldset.

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

Default Value: BigQuery Dataset List
Example: List Emp Dataset

String

Specify a unique name for the Snap.

 

Project ID

Default Value: N/A
Example: Test-project-1234

String/Expression

Specify the Project ID from which the dataset is to be listed.

Detailed Information

Default value: Deselected

Checkbox

Select this checkbox to enable the Snap to access additional fields for displaying them in the output.

Snap Execution

Default Value: Execute only
Example: Validate & Execute

Dropdown list

Select one of the following three modes in which the Snap executes. Options include:

  • 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.

Example

Listing Datasets from a Project

This example Pipeline demonstrates how to use the Dataset List Snap to list the datasets from the specified Project ID.

First, we configure the BigQuery Dataset List Snap as highlighted below to list datasets from test-project-356213 Project ID.

On validation, the Snap reads the data and lists the datasets in the output.

Download this Pipeline. 

Downloads

  1. Download and import the Pipeline into SnapLogic.

  2. Configure Snap accounts, as applicable.

  3. Provide Pipeline parameters, as applicable.

 

  File Modified

File Example_BigQuery_Dataset_List_Snap.slp

Jul 26, 2022 by Kalpana Malladi

 


Related Links

Â