FME Transformers: 2025.2 BETA

Categories
Database

Database

Web

Web

Related Transformers
AmazonAthenaConnector
GoogleCloudPubSubConnector
GoogleCloudStorageConnector
GoogleDriveConnector
GoogleLanguageConnector
GoogleVisionConnector
Categories
Database

Database

Web

Web

Related Transformers
AmazonAthenaConnector
GoogleCloudPubSubConnector
GoogleCloudStorageConnector
GoogleDriveConnector
GoogleLanguageConnector
GoogleVisionConnector

GoogleBigQueryConnector

Connects to Google BigQuery to load and query tables .

Jump to Configuration

Typical Uses

  • Loading data into BigQuery tables
  • Linking data on Google Cloud Storage to BigQuery tables
  • Querying BigQuery tables

How does it work?

The GoogleBigQueryConnector uses your Google Cloud account credentials to load or query data on BigQuery.

CSV data can be loaded from a file or Google Cloud Storage (GCS). GCS source data can be either copied into a BigQuery table or linked to a table while remaining on GCS. Schemas may be defined in JSON or detected.

Query results are output from the transformer, and may be optionally saved as a table.

Configuration

Input Ports

This transformer accepts any feature.

Output Ports

Features with added attributes, as specified in parameters and according to Action:

Action

Output

Load

Input feature with details about the loaded item.

Query

One feature per returned row, including any attributes specified in the Exposed Attributes parameter, corresponding to the columns included in the query.

Geometry Attributes are output as WKT (well-known text).

Input features are output here unmodified, in addition to any other output locations (Output or <Rejected>).

Features that cause the operation to fail are output through this port. An fme_rejection_code attribute describing the category of the error will be added, along with a more descriptive fme_rejection_message which contains more specific details as to the reason for the failure.

If an Input feature already has a value for fme_rejection_code, this value will be removed.

Rejected Feature Handling: can be set to either terminate the translation or continue running when it encounters a rejected feature. This setting is available both as a default FME option and as a workspace parameter.

Parameters

Credential Source

Select the type of credentials to use:

  • Web Connection (Recommended): Use a Google BigQuery web connection.
  • Service Account Key File: Use credentials already configured on the system, in the key file specified in the environment variable GOOGLE_APPLICATION_CREDENTIALS.

Account

When Credential Source is Web Connection, select or create a Web Connection connecting to a Google BigQuery Web Service.

See Using Web Connections.

Project ID

When Credential Source is Web Connection, specify the Google Cloud project ID.

Action

Select an operation to perform. Choices include:

  • Load Data
  • Query

Data Source

Load Source

Select the source and load type:

  • File: Upload a CSV file into a BigQuery table.
  • GCS as Native Table: Load a CSV file stored on Google Cloud Storage (GCS) into a BigQuery table.
  • GCS as External Table: Link a CSV file stored on Google Cloud Storage (GCS) to a BigQuery table without copying the data into BigQuery.

File to Load

When Load Source is File, specify the location and name of the CSV file to be loaded.

Bucket

When Load Source is GCS as Native Table or GCS as External Table, specify the Google storage bucket containing the CSV file.

Path

When Load Source is GCS as Native Table or GCS as External Table, specify the Google storage path to the CSV file.

File Type

Only CSV is supported at this time.

Header Rows to Skip

Specify the number of rows to skip at the top of the file, such as headers.

Default is zero (0).

Auto Detect Schema

Select a method for defining the schema of the loaded data:

  • Yes: BigQuery will at best effort determine the data types.
  • No: A Defined Schema will be provided.

Defined Schema

When Auto Detect Schema is No, provide a schema using the following JSON format:

Copy 
[
{
"description": "[DESCRIPTION]",
"name": "[NAME]",
"type": "[TYPE]",
"mode": "[MODE]"
},
{
"description": "[DESCRIPTION]",
"name": "[NAME]",
"type": "[TYPE]",
"mode": "[MODE]"
}
]

For more information, see BigQuery's Specifying a schema documentation.

Load Options

Table Handling

When Load Source is File or GCS as Native Table, select an option for loading to existing tables:

  • Overwrite: Replace all data in the table.
  • Append: Append the loaded data to the end of the table.
  • Write if Empty: Load the data only if the table is empty.

If the specified Destination Table does not exist, it is created.

Destination Dataset

When Load Source is File or GCS as Native Table, specify the dataset of the destination table.

Destination Table

When Load Source is File or GCS as Native Table, specify the target table where results are loaded.

Added Attributes

Output features will receive these attributes:

_project_id

Name of the project_id loaded into.

_table

Name of the table loaded into.

_dataset

Name of the dataset loaded into.

_rows_written

Number of rows written to the specified table in the dataset.

Query Options

Query

Provide an SQL query to run.

Note that when querying the BigQuery type NUMERIC, FME will receive the type fme_string.

Enable Destination Table

When enabled, query results are stored in a BigQuery table in addition to being output from the transformer.

Table Handling

Select an option for loading to existing tables:

  • Overwrite: Replace all data in the table.
  • Append: Append the loaded data to the end of the table.
  • Write if Empty: Load the data only if the table is empty.

If the specified Destination Table does not exist, it is created.

Destination Dataset

Specify the dataset of the destination table.

Destination Table

Specify the target table where results are loaded.

Exposed Attributes

When running a SELECT query, the column names are not automatically exposed as attributes on the output features.

Attributes

List the attributes to expose on output features. Attributes should be the column names of the query.

Geometry Attributes

List any geometry attributes to expose.

Editing Transformer Parameters

Transformer parameters can be set by directly entering values, using expressions, or referencing other elements in the workspace such as attribute values or user parameters. Various editors and context menus are available to assist. To see what is available, click beside the applicable parameter.

Defining Values

There are several ways to define a value for use in a Transformer. The simplest is to simply type in a value or string, which can include functions of various types such as attribute references, math and string functions, and workspace parameters.

Using the Text Editor

The Text Editor provides a convenient way to construct text strings (including regular expressions) from various data sources, such as attributes, parameters, and constants, where the result is used directly inside a parameter.

Text Editor

Using the Arithmetic Editor

The Arithmetic Editor provides a convenient way to construct math expressions from various data sources, such as attributes, parameters, and feature functions, where the result is used directly inside a parameter.

Arithmetic Editor

Conditional Values

Set values depending on one or more test conditions that either pass or fail.

Parameter Condition Definition Dialog

Content

Expressions and strings can include a number of functions, characters, parameters, and more.

When setting values - whether entered directly in a parameter or constructed using one of the editors - strings and expressions containing String, Math, Date/Time or FME Feature Functions will have those functions evaluated. Therefore, the names of these functions (in the form @<function_name>) should not be used as literal string values.

String Functions

These functions manipulate and format strings.

Special Characters

 A set of control characters is available in the Text Editor.

Math Functions

Math functions are available in both editors.
Date/Time Functions Date and time functions are available in the Text Editor.

Math Operators

These operators are available in the Arithmetic Editor.

FME Feature Functions

These return primarily feature-specific values.

FME Parameters

FME and workspace-specific parameters may be used.
Creating and Modifying User Parameters Create your own editable parameters.

Table Tools

Transformers with table-style parameters have additional tools for populating and manipulating values.

Row Reordering

Enabled once you have clicked on a row item. Choices include:

  • Add a row
  • Remove a row
  • Move current row up one
  • Move current row down one
  • Move current row to top
  • Move current row to bottom

Cut, Copy, and Paste

Enabled once you have clicked on a row item. Choices include:

  • Cut a row - delete and copy to clipboard
  • Copy a row to the clipboard
  • Paste a row from the clipboard

Cut, copy, and paste may be used within a transformer, or between transformers.

Filter

Start typing a string, and the matrix will only display rows matching those characters. Searches all columns. This only affects the display of attributes within the transformer - it does not alter which attributes are output.

Import

Import populates the table with a set of new attributes read from a dataset. Specific application varies between transformers.

Reset/Refresh

Generally resets the table to its initial state, and may provide additional options to remove invalid entries. Behavior varies between transformers.

Note: Not all tools are available in all transformers.

For more information, see Transformer Parameter Menu Options.

Reference

Processing Behavior

Feature-Based

Feature Holding

No
Dependencies Google Cloud Storage Account
Aliases  
History Released FME 2019.1

FME Online Resources

The FME Community and Support Center Knowledge Base have a wealth of information, including active forums with 35,000+ members and thousands of articles.

Search for all results about the GoogleBigQueryConnector on the FME Community.

 

Examples may contain information licensed under the Open Government Licence – Vancouver, Open Government Licence - British Columbia, and/or Open Government Licence – Canada.