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 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.
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
Configuring Options
Camel components are configured on two separate levels:
-
component level
-
endpoint level
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.
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.
Component Options
The Google BigQuery Standard SQL component supports 4 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 |
|
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. |
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 |
Endpoint Options
The Google BigQuery Standard SQL endpoint is configured using URI syntax:
google-bigquery-sql:projectId:queryString
with the following path and query parameters:
Path Parameters (2 parameters)
| Name | Description | Default | Type |
|---|---|---|---|
projectId (common) |
Required Google Cloud Project Id. |
String |
|
queryString (common) |
Required BigQuery standard SQL query. |
String |
Query Parameters (2 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. |
boolean |
Output 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.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 |