Google BigQuery V2 Connector Guide > Google BigQuery V2 Connections > Google BigQuery V2 connection properties
  

Google BigQuery V2 connection properties

When you create a Google BigQuery V2 connection, you must configure the connection properties.
The following table describes the Google BigQuery V2 connection properties:
Property
Description
Advanced Settings
Enable BigQuery Storage API
Uses the Google BigQuery Storage API to stage the files when you read or write data.
Default is No.
Storage Path
Path in Google Cloud Storage where the Secure Agent creates a local stage file to store the data temporarily. The Secure Agent uses this storage when it reads data in staging mode or writes data in bulk mode.
Use one of the following formats:
  • - gs://<bucket_name>
  • - gs://<bucket_name>/<folder_name>
When you enable cross-region replication in Google BigQuery, enter a Google Cloud Storage path that supports dual region storage.
This property is not applicable if you use Google BigQuery Storage to stage the files.
Connection mode
The mode that you want to use to read data from or write data to Google BigQuery.
Select one of the following connection modes:
  • - Simple. Flattens each field within the Record data type field as a separate field in the process.
  • - Hybrid. Displays all the top-level fields in the Google BigQuery table including Record data type fields. Google BigQuery Connector displays the top-level Record data type field as a single field of the String data type in the process.
  • - Complex. Displays all the columns in the Google BigQuery table as a single field of the String data type in the process.
Default is Simple.
This property is applicable if you use Google Cloud Storage to stage the files.
Use Legacy SQL for Custom Query
Select this option to use legacy SQL to define a custom query. If you clear this option, use standard SQL to define a custom query.
This property is applicable if you use Google Cloud Storage to stage the files.
This property doesn't apply if you configure the Google BigQuery V2 connection in hybrid or complex mode.
Default is No.
Dataset Name for Custom Query
The name of the Google BigQuery dataset that you want to specify in a custom query.
Schema Definition File Path
Directory on the Secure Agent machine where the Secure Agent creates a JSON file with the sample schema of the Google BigQuery table. The JSON file name is the same as the Google BigQuery table name.
Alternatively, you can specify a storage path in Google Cloud Storage where the Secure Agent creates a JSON file with the sample schema of the Google BigQuery table. You can download the JSON file from the specified storage path in Google Cloud Storage to a local machine.
When you use a serverless runtime environment, specify a storage path in Google Cloud Storage.
This property is applicable if you use Google Cloud Storage to stage the files.
Region ID
The region name where the Google BigQuery dataset that you want to access resides.
Note: Ensure that you specify a bucket name or the bucket name and folder name in the Storage Path property that resides in the specified region.
Staging Dataset
The Google BigQuery dataset name where you want to create the staging table to stage the data. You can define a Google BigQuery dataset that is different from the source or target dataset.
This property is applicable if you use Google Cloud Storage to stage the files.
Provide Optional Properties
Comma-separated key-value pairs of custom properties in the Google BigQuery V2 connection to configure certain source and target functionalities.
Retry Strategy
Enable Retry
Select this option if you want the Secure Agent to attempt a retry to receive the response from the Google BigQuery endpoint. You can configure the retry strategy to read data from Google BigQuery in direct or staging mode and write data to Google BigQuery in bulk mode.
Maximum Retry Attempts
The maximum number of retry attempts that the Secure Agent performs to receive the response from the Google BigQuery endpoint.
If the Secure Agent fails to connect to Google BigQuery within the maximum retry attempts, the connection fails.
Default is 6 attempts.
Initial Retry Delay
The initial wait time in seconds before the Secure Agent attempts to retry the connection.
Default is 1 second.
Retry Delay Multiplier
The multiplier that the Secure Agent uses to exponentially increase the wait time between successive retry attempts up to the maximum retry delay time.
Default multiplier is 2. You can also use fractional values.
Maximum Retry Delay
The maximum wait time in seconds that the Secure Agent waits between successive retry attempts.
Default is 32 seconds.
Total Timeout
The total time duration in seconds that the Secure Agent attempts to retry the connection after which the connection fails.
Default is 50 seconds.
Object Properties
Dataset
Required. Name of the dataset that contains the source table and target table that you want to connect to.
Note: Google BigQuery supports the datasets that reside only in the US region.
Object Filter
Configure an object filter to add conditions to filter the objects. You can specify multiple object names separated by a comma. Application Integration populates the metadata only for the specified objects and their related objects.
Note: Ensure that you specify valid credentials in the connection properties. A connection test is successful even if you specify incorrect credentials in the connection properties.