The following connection option descriptions are listed alphabetically by the GUI name that appears on the driver Setup dialog box. The connection string attribute name, along with its short name, is listed immediately underneath the GUI name.

In most cases, the GUI name and the attribute name are the same; however, some exceptions exist. If you need to look up an option by its connection string attribute name, please refer to the alphabetical table of connection string attribute names.

Also, a few connection string attributes do not have equivalent options that appear on the GUI. They are in the list of descriptions alphabetically by their attribute names.

Note: The driver does not support specifying values for the same connection option multiple times in a connection string or DSN. If a value is specified using the same attribute multiple times or using both long and short attributes, the connection may fail or the driver may not behave as intended.

The following tables list the connection string attributes supported by the Google BigQuery driver.

General attributes

The following table summarizes the general attributes that are required to connect to a Google BigQuery instance.

Table 1. General attributes
Attribute (Short Name) Default
AuthenticationMethod (AM) oauth2.0
Dataset (DS) None
DataSourceName (DSN) None
Description (n/a) None
Project (PT) None

OAuth 2.0 attributes

The following table summarizes attributes that are used for OAuth 2.0 authentication.

Table 2. OAuth 2.0 attributes
Attribute (Short Name) Default
AccessToken (AT) None
Auth URI (o2au) https://accounts.google.com/ o/oauth2/auth
ClientID (CI) None
ClientSecret (CS) None
Enable Login Prompt (elp) 0 (false)
Redirect URI (o2ru) None
RefreshToken (RT) None
Scope (SC) https://www.googleapis.com/ auth/bigquery
Token URI (o2tu) https://accounts.google.com/ o/oauth2/token

Service account attributes

The following table summarizes attributes that are used for service account authentication.

Table 3. Service account attributes
Attribute (Short Name) Default
JWTAudience (JWTA) https://accounts.google.com/ o/oauth2/token
ServiceAccountEmail (SAE) None
ServiceAccountKeyContent (SAKC) None
ServiceAccountPrivateKey (SAPK) None
Token URI (o2tu) https://accounts.google.com/ o/oauth2/token

Mapping attributes

The following table summarizes attributes involved in mapping the remote Google BigQuery data model to a local schema map used to support SQL queries against Google BigQuery.

Table 4. Mapping attributes
Attribute (Short Name) Default
ConfigOptions (CFGO) VarcharLength=65535; SchemaSet=;
CreateMap (CM) 2 (NotExist)
SchemaMap (SMP) Default value depends on environment

Storage API attributes

The following table summarizes attributes that are used to leverage the Google BigQuery Storage API when fetching large result sets.

Table 5. Storage API attributes
Attribute (Short Name) Default
StorageAPIMinPageCount (SAMPC) 3 (pages)
StorageAPIThreshold (SAT) 10000 (pages)
UseStorageAPI (USA) false

Legacy SQL attributes

The following table summarizes attributes that can be used to execute queries using legacy SQL.

Table 6. Legacy SQL attributes
Attribute (Short Name) Default
AllowLargeResults (ALR) false
LegacyDataset (LD) _queries_
LegacyTable (LT) _sql_*
Syntax (SY) standard

Proxy server attributes

The following table summarizes proxy server attributes.

Table 7. Proxy server attributes
Attribute (Short Name) Default
ProxyHost (PXHN) Empty string
ProxyPassword (PXPW) Empty string
ProxyPort (PXPT) Empty string
ProxyUser (PXUN) Empty string

Web service attributes

The following table summarizes web service attributes, including those related to timeouts.

Table 8. Web service attributes
Attribute (Short Name) Default
WSFetchSize (WSFS) 1000000
WSPoolSize (WSPS) 1
WSRetryCount (WSRC) 5
WSTimeout (WST) 120 (seconds)

Timeout attributes

The following table summarizes timeout attributes.

Table 9. Timeout attributes
Attribute (Short Name) Default
JobTimeout (JT) 0 (no timeout)
LoginTimeout (LT) 15
WSRetryCount (WSRC) 5
WSTimeout (WST) 120 (seconds)

Pooling attributes

The following table summarizes pooling attributes.

Table 10. Statement pooling attributes
Attribute (Short Name) Default
Pooling (POOL) 0
ConnectionReset (CR) 0
LoadBalanceTimeout (LBT) 0
MaxPoolSize (MXPS) 100
MinPoolSize (MNPS) 0

Additional attributes

The following table summarizes additional attributes.

Table 11. Additional attributes
Attribute (Short Name) Default
ApplicationUsingThreads (AUT) 1
BinaryLength (BL) 65535
EnableCatalogSupport (ECS) 0
FetchSize (FS) 100 (rows)
Host Name www.googleapis.com
IANAAppCodePage (IACP) UNIX ONLY 4 (ISO 8559-1 Latin-1)
JsonFormat (JF) raw
JVMArgs (JVMA) For the 32-bit driver when the SQL Engine Mode is set to 2 (Direct):

-Xmx256m

For all other configurations:

-Xmx1024m
JVMClasspath (JVMC) install_dir\java\lib\googlebigquery.jar
KMSKeyName (KKN) None
Location (LN) None
LogConfigFile (LCF) Empty string
MaximumBytesBilled (MBB) 0 (no limit)
MaximumBilling Tier (MBT) 0
PrimaryKeyPattern (PKP) None
RefreshSchema (RS) 1
RefreshSchemaForDDL (RSFD) true
ReportCodepageConversionErrors (RCCE) 0(Ignore Errors)
RetryExceptions (REX) 0(False)
ServerPortNumber (SPN) 32-bit: 19946

64-bit: 19945
SQLEngineMode (SEM)

For Windows: 1 (Server)

For UNIX/Linux: 2 (Direct)
UseStreamingInsert (USI) 1
UseQueryCache (UQC) 1