Google BigQuery
Since Camel 2.20
Only producer is supported
The Google Bigquery component provides access to Cloud BigQuery Infrastructure via the Google Client Services API.
The current implementation does not use gRPC.
The current implementation does not support querying BigQuery i.e. is a producer only.
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-google-bigquery</artifactId>
<!-- use the same version as your Camel core version -->
<version>x.x.x</version>
</dependency>
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.
OBS! The location of the default credentials file is configurable - via GOOGLE_APPLICATION_CREDENTIALS environment variable.
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 |
The Google BigQuery endpoint is configured using URI syntax:
google-bigquery:projectId:datasetId:tableId
with the following path and query parameters:
Path Parameters (3 parameters):
Name | Description | Default | Type |
---|---|---|---|
projectId |
Required Google Cloud Project Id |
String |
|
datasetId |
Required BigQuery Dataset Id |
String |
|
tableId |
BigQuery table id |
String |
Query Parameters (3 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 |
|
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 |
useAsInsertId (producer) |
Field name to use as insert id |
String |
Message Headers
Name | Type | Description |
---|---|---|
|
|
Table suffix to use when inserting data |
|
|
InsertId to use when inserting data |
|
|
Partition decorator to indicate partition to use when inserting data |
|
|
Table id where data will be submitted. If specified will override endpoint configuration |
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.
Template tables
Templated tables can be specified using the GoogleBigQueryConstants.TABLE_SUFFIX
header.
I.e. 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.
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.
Ensuring data consistency
A 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 inserted the exchange header can’t
be used when the payload is a list - if the payload is a list the GoogleBigQueryConstants.INSERT_ID
will
be ignored. In that case use the query parameter useAsInsertId
.
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>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
The component supports 11 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
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 |
|
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 |
||
Whether to enable auto configuration of the google-bigquery-sql component. This is enabled by default. |
Boolean |
||
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 |
|
Google Cloud Project Id. |
String |
||
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 |
|
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 |
||
BigQuery Dataset Id. |
String |
||
Whether to enable auto configuration of the google-bigquery component. This is enabled by default. |
Boolean |
||
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 |
|
Google Cloud Project Id. |
String |