Connection property descriptions

You can use connection properties to customize the driver for your environment. This section lists the connection properties supported by the driver and describes each property. You can use these connection properties with either the JDBC DriverManager or a JDBC DataSource. For a DriverManager connection, a property is expressed as a key value pair and takes the form property=value. For a data source connection, a property is expressed as a JDBC method and takes the form setproperty(value). Connection property names are case-insensitive. For example, Password is the same as password.

Note: In a JDBC DataSource, string values must be enclosed in double quotation marks, for example, setUser("abc@defcorp.com").

Note: The data type listed for each connection property is the Java data type used for the property value in a JDBC data source.

The following tables provide a summary of the connection properties supported by the driver, their corresponding data source methods, and their default values.

Required properties

The following table summarizes connection properties that are required to connect to a Google BigQuery instance when the default authentication method, OAuth 2.0, is used for authentication.

Table 3. Required properties
Property	Data Source Method	Default
AccessToken	setAccessToken	None
ClientID	setClientID	None
ClientSecret	setClientSecret	None
Dataset	setDataset	None
Project	setProject	None
RefreshToken	setRefreshToken	None

Mapping properties

The following table summarizes connection properties 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 properties
Property	Data Source Method	Default
ConfigOptions	setConfigOptions	VarcharLength=65535; SchemaSet=;
CreateMap	setCreateMap	notExist
SchemaMap	setSchemaMap	For Windows: <application_data_folder>\ Local\Progress\DataDirect \GoogleBigQuery_Schema\ <user_name>.config For Unix/Linux: ˜/progress/datadirect/ GoogleBigQuery_Schema/ <user_name>.config

OAuth 2.0 properties

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

Table 5. OAuth 2.0 properties
Property	Data Source Method	Default
AccessToken	setAccessToken	None
ClientID	setClientID	None
ClientSecret	setClientSecret	None
RefreshToken	setRefreshToken	None
Scope	setScope	https://www.googleapis.com/ auth/bigquery

Service account properties

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

Table 6. Service account properties
Property	Data Source Method	Default
ServiceAccountEmail	setServiceAccountEmail	None
ServiceAccountPrivateKey	setServiceAccountPrivateKey	None

Legacy SQL properties

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

Table 7. Legacy SQL properties
Property	Data Source Method	Default
AllowLargeResults	setAllowLargeResults	false
LegacyDataset	setLegacyDataset	_queries_
LegacyTable	setLegacytable	_sql_*
Syntax	setSyntax	standard

Failover properties

The following table summarizes connection properties that can be used to implement failover.

Table 8. Failover properties
Property	Data Source Method	Default
ConnectionRetryCount	setConnectionRetryCount	5
ConnectionRetryDelay	setConnectionRetryDelay	1 (second)

Proxy server properties

The following table summarizes proxy server connection properties.

Table 9. Proxy Server properties
Property	Data Source Method	Default
ProxyHost	setProxyHost	None
ProxyPassword	setProxyPassword	None
ProxyPort	setProxyPort	0
ProxyUser	setProxyUser	None

Web Service properties

The following table summarizes Web service connection properties, including those related to timeouts.

Table 10. Web Service properties
Property	Data Source Method	Default
WSFetchSize	setWSFetchSize	10000
WSPoolSize	setWSPoolSize	1
WSRetryCount	setWSRetryCount	1
WSTimeout	setWSTimeout	120 (seconds)

Timeout properties

The following table summarizes timeout connection properties.

Table 11. Timeout properties
Property	Data Source Method	Default
JobTimeout	setJobTimeout	0 (no timeout)
LoginTimeout	setLoginTimeout	0
WSRetryCount	setWSRetryCount	0
WSTimeout	setWSTimeout	120 (seconds)

Statement pooling properties

The following table summarizes statement pooling connection properties.

Table 12. Statement pooling properties
Property	Data Source Method	Default
ImportStatementPool	setImportStatementPool	None
MaxPooledStatements	setMaxPooledStatements	0
RegisterStatementPoolMonitorMBean	setRegisterStatementPoolMonitorMBean	false

Additional properties

The following table summarizes additional connection properties.

Table 13. Additional properties
Property	Data Source Method	Default
ConvertNull	setConvertNull	1
FetchSize	setFetchSize	100 (rows)
JavaDoubleToString	setJavaDoubleToString	false
JsonFormat	setJsonFormat	raw
Location	setLocation	None
LogConfigFile	setLogConfigFile	ddlogging.properties
MaximumBytesBilled	setMaximumBytesBilled	0 (no limit)
RefreshSchema	setRefreshSchema	true
RefreshSchemaForDDL	setRefreshSchemaForDDL	true
SpyAttributes	setSpyAttributes	None
UseQueryCache	setUseQueryCache	1