Google BigQuery Standard SQL
Since Camel 2.23
Only producer is supported
The Google BigQuery SQL component provides access to Cloud BigQuery Infrastructure via the Google Client Services API.
The current implementation supports only standard SQL DML queries.
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 via one of the two options:
-
Service Account Email and Service Account Key (PEM format)
-
GCP credentials file location
If both are set, the Service Account Email/Key will take precedence.
Or 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.
Service Account Email and Service Account Key can be found in the GCP JSON credentials file as client_email and private_key respectively.
URI Format
google-bigquery-sql://project-id:query?[options]
Examples:
google-bigquery-sql://project-17248459:delete * from test.table where id=@myId
google-bigquery-sql://project-17248459:delete * from ${datasetId}.${tableId} where id=@myId
where
-
parameters in form ${name} are extracted from message headers and formed the translated query
-
parameters in form @name are extracted from body or message headers and sent to Google Bigquery
You can externalize your SQL queries to files in the classpath or file system as shown:
google-bigquery-sql://project-17248459::classpath:delete.sql
Options
The Google BigQuery Standard SQL component supports 4 options, which are listed below.
Name | Description | Default | Type |
---|---|---|---|
connectionFactory (producer) |
ConnectionFactory to obtain connection to Bigquery Service. If non 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 |
projectId (producer) |
Google Cloud Project Id |
String |
|
basicPropertyBinding (advanced) |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
The Google BigQuery Standard SQL endpoint is configured using URI syntax:
google-bigquery-sql:projectId:query
with the following path and query parameters:
Path Parameters (2 parameters):
Name | Description | Default | Type |
---|---|---|---|
query |
Required BigQuery standard SQL query |
String |
|
projectId |
Required Google Cloud Project Id |
String |
Query Parameters (4 parameters):
Name | Description | Default | Type |
---|---|---|---|
connectionFactory (producer) |
ConnectionFactory to obtain connection to Bigquery Service. If non 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 |
basicPropertyBinding (advanced) |
Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
boolean |
synchronous (advanced) |
Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
false |
boolean |
Ouput Message Headers
Name | Type | Description |
---|---|---|
|
|
Preprocessed query text |
Producer Endpoints
Google BigQuery SQL endpoint expects the payload to be either empty or a map of query parameters.
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 |
---|---|---|---|
camel.component.google-bigquery-sql.basic-property-binding |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
Boolean |
camel.component.google-bigquery-sql.connection-factory |
ConnectionFactory to obtain connection to Bigquery Service. If non provided the default one will be used. The option is a org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory type. |
String |
|
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.basic-property-binding |
Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities |
false |
Boolean |
camel.component.google-bigquery.connection-factory |
ConnectionFactory to obtain connection to Bigquery Service. If non provided the default one will be used. The option is a org.apache.camel.component.google.bigquery.GoogleBigQueryConnectionFactory type. |
String |
|
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 |