Chapter 26. Google BigQuery

Since Camel 2.20

Only producer is supported.

The Google Bigquery component provides access to the Cloud BigQuery Infrastructure via the link:https://developers.google.com/api-client-library/java/apis/bigquery/v2 [Google Client Services API].

The current implementation does not use gRPC.

The current implementation does not support querying BigQuery, it is only a producer.

Add the following dependency to your pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-google-bigquery</artifactId>
    <version>3.20.1.redhat-00031</version>
    <!-- use the same version as your Camel core version -->
</dependency>

26.1. Authentication Configuration

Google BigQuery component authentication is targeted for use with the GCP Service Accounts. For more information please refer to Google Cloud Platform Auth Guide.

Google security credentials can be set explicitly by providing the path to the GCP credentials file location.

Or they are set implicitly, where the connection factory falls back on Application Default Credentials.

When you have the service account key you can provide authentication credentials to your application code. Google security credentials can be set through the component endpoint:

String endpoint = "google-bigquery://project-id:datasetId[:tableId]?serviceAccountKey=/home/user/Downloads/my-key.json";

You can also use the base64 encoded content of the authentication credentials file if you don’t want to set a file system path.

String endpoint = "google-bigquery://project-id:datasetId[:tableId]?serviceAccountKey=base64:<base64 encoded>";

Or by setting the environment variable GOOGLE_APPLICATION_CREDENTIALS :

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/my-key.json"

26.2. URI Format

google-bigquery://project-id:datasetId[:tableId]?[options]

26.3. Configuring Options

Camel components are configured on two separate levels:

component level
endpoint level

26.3.1. Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

26.3.2. Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

26.4. Component Options

The Google BigQuery component supports 5 options, which are listed below.

Name	Description	Default	Type
connectionFactory (producer)	Autowired ConnectionFactory to obtain connection to Bigquery Service. If not provided the default one will be used.		GoogleBigQueryConnectionFactory
datasetId (producer)	BigQuery Dataset Id.		String
lazyStartProducer (producer)	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
projectId (producer)	Google Cloud Project Id.		String
autowiredEnabled (advanced)	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	boolean

26.5. Endpoint Options

The Google BigQuery endpoint is configured using URI syntax:

google-bigquery:projectId:datasetId:tableId

with the following path and query parameters:

26.5.1. Path Parameters (3 parameters)

Name	Description	Type
projectId (common)	Required Google Cloud Project Id.	String
datasetId (common)	Required BigQuery Dataset Id.	String
tableId (common)	BigQuery table id.	String

26.5.2. Query Parameters (4 parameters)

Name	Description	Default	Type
connectionFactory (producer)	Autowired ConnectionFactory to obtain connection to Bigquery Service. If not provided the default one will be used.		GoogleBigQueryConnectionFactory
useAsInsertId (producer)	Field name to use as insert id.		String
lazyStartProducer (producer (advanced))	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
serviceAccountKey (security)	Service account key in json format to authenticate an application as a service account to google cloud platform.		String

26.6. Message Headers

The Google BigQuery component supports 4 message header(s), which is/are listed below:

Name	Description	Type
CamelGoogleBigQueryTableSuffix (producer) Constant: TABLE_SUFFIX	Table suffix to use when inserting data.	String
CamelGoogleBigQueryTableId (producer) Constant: TABLE_ID	Table id where data will be submitted. If specified will override endpoint configuration.	String
CamelGoogleBigQueryInsertId (producer) Constant: INSERT_ID	InsertId to use when inserting data.	String
CamelGoogleBigQueryPartitionDecorator (producer) Constant: PARTITION_DECORATOR	Partition decorator to indicate partition to use when inserting data.	String

26.7. Producer Endpoints

Producer endpoints can accept and deliver to BigQuery individual and grouped exchanges alike. Grouped exchanges have Exchange.GROUPED_EXCHANGE property set.

Google BigQuery producer will send a grouped exchange in a single api call unless different table suffix or partition decorators are specified in which case it will break it down to ensure data is written with the correct suffix or partition decorator.

Google BigQuery endpoint expects the payload to be either a map or list of maps. A payload containing a map will insert a single row and a payload containing a list of map’s will insert a row for each entry in the list.

26.8. Template tables

Templated tables can be specified using the GoogleBigQueryConstants.TABLE_SUFFIX header. For example, the following route will create tables and insert records sharded on a per day basis:

from("direct:start")
  .header(GoogleBigQueryConstants.TABLE_SUFFIX, "_${date:now:yyyyMMdd}")
  .to("google-bigquery:sampleDataset:sampleTable")

Note

It is recommended to use partitioning for this use case.

For more information about Template table, see Template Tables.

26.9. Partitioning

Partitioning is specified when creating a table and if set data will be automatically partitioned into separate tables. When inserting data a specific partition can be specified by setting the GoogleBigQueryConstants.PARTITION_DECORATOR header on the exchange.

For more information about partitioning, see Creating partitioned tables.

26.10. Ensuring data consistency

An insert id can be set on the exchange with the header GoogleBigQueryConstants.INSERT_ID or by specifying query parameter useAsInsertId. As an insert id need to be specified per row, the inserted the exchange header can’t be used when the payload is a list. If the payload is a list then the GoogleBigQueryConstants.INSERT_ID will be ignored. In that case use the query parameter useAsInsertId.

For more information, see Data consistency

26.11. Spring Boot Auto-Configuration

When using google-bigquery with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-google-bigquery-starter</artifactId>
</dependency>

The component supports 11 options, which are listed below.

Name	Description	Default	Type
camel.component.google-bigquery-sql.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.google-bigquery-sql.connection-factory	ConnectionFactory to obtain connection to Bigquery Service. If not provided the default one will be used. The option is a org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory type.		GoogleBigQueryConnectionFactory
camel.component.google-bigquery-sql.enabled	Whether to enable auto configuration of the google-bigquery-sql component. This is enabled by default.		Boolean
camel.component.google-bigquery-sql.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.google-bigquery-sql.project-id	Google Cloud Project Id.		String
camel.component.google-bigquery.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.google-bigquery.connection-factory	ConnectionFactory to obtain connection to Bigquery Service. If not provided the default one will be used. The option is a org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory type.		GoogleBigQueryConnectionFactory
camel.component.google-bigquery.dataset-id	BigQuery Dataset Id.		String
camel.component.google-bigquery.enabled	Whether to enable auto configuration of the google-bigquery component. This is enabled by default.		Boolean
camel.component.google-bigquery.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.google-bigquery.project-id	Google Cloud Project Id.		String