Connection property descriptions
- Last Updated: December 23, 2020
- 1 minute read
The following tables contain the supported connection properties and their default values by functionality:
Required properties
The following table summarizes connection properties that are required to connect to a Google BigQuery instance.
| Property | Default |
|---|---|
| AccessToken | None |
| ClientID | None |
| ClientSecret | None |
| Dataset | None |
| Project | None |
| RefreshToken | None |
OAuth 2.0 properties
The following table summarizes connection properties that are used for OAuth 2.0 authentication.
| Property | Default |
|---|---|
| AccessToken | None |
| ClientID | None |
| ClientSecret | None |
| RefreshToken | None |
| Scope | https://www.googleapis.com/ auth/bigquery |
Storage API properties
The following table summarizes connection properties that are used to leverage the Google BigQuery Storage API when fetching large result sets.
| Property | Default |
|---|---|
| StorageAPIMinPageCount | 3 |
| StorageAPIThreshold | 10000
|
| UseStorageAPI | false |
Legacy SQL properties
The following table summarizes connection properties that can be used to execute queries using legacy SQL.
| Property | Default |
|---|---|
| AllowLargeResults | false |
| LegacyDataset |
_queries_
|
| LegacyTable |
_sql_* |
| Syntax |
standard
|
Web Service properties
The following table summarizes Web service connection properties, including those related to timeouts.
| Property | Default |
|---|---|
| WSFetchSize | 10000 |
| WSRetryCount | 1 |
| WSTimeout | 120 (seconds) |
Timeout properties
The following table summarizes timeout connection properties.
| Property | Default |
|---|---|
| JobTimeout |
0 (no timeout) |
| WSRetryCount | 0 |
| WSTimeout | 120 (seconds) |
Additional properties
The following table summarizes additional connection properties.
| Property | Default |
|---|---|
| EnableCatalogSupport | false |
| FetchSize | 100 (rows) |
| JsonFormat | raw |
| Location | None |
| MaximumBytesBilled |
0 (no limit) |
| RefreshSchemaForDDL | true |
| UseQueryCache | 1 |
Related Links
- AccessToken
- AllowLargeResults
- ClientID
- ClientSecret
- ConfigOptions
- Dataset
- EnableCatalogSupport
- FetchSize
- JobTimeout
- JsonFormat
- KMSKeyName
- LegacyDataset
- LegacyTable
- Location
- MaximumBytesBilled
- Project
- RefreshSchemaForDDL
- RefreshToken
- Scope
- StorageAPIMinPageCount
- StorageAPIThreshold
- Syntax
- UseQueryCache
- UseStorageAPI
- WSFetchSize
- WSRetryCount
- WSTimeout