Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
| Property | Description |
| AuthScheme | Specifies the authentication method used to connect to Google BigQuery. |
| ProjectId | Specifies the Google Cloud project used to resolve unqualified table names and execute jobs in Google BigQuery. |
| DatasetId | Specifies the dataset used to resolve unqualified table references in SQL queries. |
| BillingProjectId | Specifies the Project ID of the billing project used to execute Google BigQuery jobs. |
| Property | Description |
| AllowLargeResultSets | Specifies whether large result sets are allowed to be stored in temporary tables. |
| DestinationTable | Specifies the Google BigQuery table where query results are stored. |
| UseQueryCache | Specifies whether to use Google BigQuery's built-in query cache for eligible queries. |
| PageSize | Specifies the number of results to return per page from Google BigQuery when paging through query results. |
| PollingInterval | Specifies the number of seconds to wait between status checks when polling for query completion. |
| UseLegacySQL | Specifies whether to use Google BigQuery's Legacy SQL dialect instead of Standard SQL when generating queries. |
| PrivateEndpointNameAccessTokenUrl | Specifies the custom endpoint name to use for retrieving an OAuth authorization Url when connecting with Private Service Connect. |
| PrivateEndpointNameAuthUrl | Specifies the custom endpoint name to use for retrieving an OAuth authorization Url when connecting with Private Service Connect. |
| PrivateEndpointNameCloudStorage | Specifies the custom endpoint name to use for Google Cloud Storage when connecting with Private Service Connect. |
| PrivateEndpointNameBigQuery | Specifies the custom endpoint name to use for the REST API when connecting with Private Service Connect. |
| PrivateEndpointNameStorage | Specifies the custom endpoint name to use for the Storage Read API when connecting with Private Service Connect. |
| PrivateEndpointNameSts | Specifies the custom endpoint name to use for STS when connecting with Private Service Connect. |
| Property | Description |
| UseStorageAPI | Specifies whether to use the Google BigQuery Storage API for bulk data reads instead of the standard REST API. |
| UseArrowFormat | Specifies whether to use the Arrow format instead of Avro when reading data through the Google BigQuery Storage API. |
| StorageThreshold | Specifies the minimum number of rows a query must return for the provider to use the Google BigQuery Storage API to read results. |
| StoragePageSize | Specifies the number of rows to buffer per page when executing queries using the Google BigQuery Storage API. |
| StorageTimeout | Specifies the maximum time, in seconds, that a Storage API connection may remain active before the provider resets the connection. |
| Property | Description |
| InsertMode | Specifies the method used to insert data into Google BigQuery. |
| WaitForBatchResults | Specifies whether the provider should wait for Google BigQuery batch load jobs to complete before returning from an INSERT operation. |
| GCSBucket | Specifies the name of the Google Cloud Storage (GCS) bucket where bulk data is uploaded for staging. |
| GCSBucketFolder | Specifies the name of the folder within the GCS bucket where bulk data is uploaded for staging. |
| TempTableDataset | Specifies the prefix of the dataset used to store temporary tables during bulk UPDATE or DELETE operations. |
| Property | Description |
| InitiateOAuth | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| OAuthAccessToken | Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
| DelegatedServiceAccounts | Specifies a space-delimited list of service account emails for delegated requests. |
| RequestingServiceAccount | Specifies a service account email to make a delegated request. |
| OAuthSettingsLocation | Specifies the location of the settings file where OAuth values are saved. |
| CallbackURL | Identifies the URL users return to after authenticating to Google BigQuery via OAuth (Custom OAuth applications only). |
| Scope | Specifies the OAuth scopes requested by the provider. Scopes are space-delimited and determine the level of access to Google APIs. |
| OAuthVerifier | Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
| OAuthRefreshToken | Specifies the OAuth refresh token used to request a new access token after the original has expired. |
| OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
| OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created. |
| Property | Description |
| OAuthJWTCert | Supplies the name of the client certificate's JWT Certificate store. |
| OAuthJWTCertType | Identifies the type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | Provides the password for the OAuth JWT certificate used to access a password-protected certificate store. If the certificate store does not require a password, leave this property blank. |
| OAuthJWTCertSubject | Identifies the subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| BrowsableCatalogs | Optional setting that restricts the catalogs reported to a subset of all available catalogs. For example, BrowsableCatalogs=CatalogA,CatalogB,CatalogC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| RefreshViewSchemas | Specifies whether the provider should automatically refresh view schemas by querying the views directly. |
| ShowTableDescriptions | Specifies whether table descriptions are returned through platform metadata APIs and system views like sys_tables and sys_views. |
| PrimaryKeyIdentifiers | Specifies rules for assigning primary keys to tables. |
| AllowedTableTypes | Specifies which types of tables are visible when listing tables in the dataset. |
| FlattenObjects | Specifies whether STRUCT fields in Google BigQuery are flattened into individual top-level columns. |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheDriver | The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations. |
| CacheConnection | Specifies the connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True. |
| Offline | Gets the data from the specified cache database instead of live Google BigQuery data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| AllowAggregateParameters | Specifies whether raw aggregate values can be used in parameters when the QueryPassthrough connection property is enabled. |
| ApplicationName | Specifies the name of the application using the provider, in the format application/version. For example, AcmeReporting/1.0. |
| AuditLimit | Specifies the maximum number of rows that can be stored in the in-memory audit table. |
| AuditMode | Specifies which provider actions should be recorded in audit tables. |
| AWSWorkloadIdentityConfig | Configuration properties to provide when using Workload Identity Federation via AWS. |
| AzureWorkloadIdentityConfig | Configuration properties to provide when using Workload Identity Federation via Azure. |
| BigQueryOptions | Specifies a comma-separated list of custom Google BigQuery provider options. |
| ConnectionLifeTime | Specifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection. |
| ConnectOnOpen | Specifies whether the provider establishes a connection to Google BigQuery immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary. |
| EmptyArraysAsNull | Specifies whether empty arrays are represented as null or as an empty array. |
| GenerateSchemaFiles | Indicates the user preference as to when schemas should be generated and saved. |
| HidePartitionColumns | Specifies whether the pseudocolumns _PARTITIONDATE and _PARTITIONTIME are hidden in partitioned tables. |
| MaximumBillingTier | Specifies the maximum billing tier for a query, represented as a positive integer multiplier of the standard cost per terabyte. |
| MaximumBytesBilled | Specifies the maximum number of bytes a Google BigQuery job is allowed to process before it is cancelled. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| PoolIdleTimeout | Specifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. Requires UseConnectionPooling=True. |
| PoolMaxSize | Specifies the maximum number of connections allowed in the connection pool. |
| PoolMinSize | Specifies the minimum number of connections to be maintained in the connection pool at all times. |
| PoolWaitTime | Specifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| QueryPassthrough | This option passes the query to the Google BigQuery server as is. |
| Readonly | Toggles read-only access to Google BigQuery from the provider. |
| RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key. |
| SupportCaseSensitiveTables | Specifies whether the provider distinguishes between tables and datasets with the same name but different casing. |
| TableSamplePercent | Specifies the percentage of each table to sample when generating queries using the TABLESAMPLE clause. |
| Timeout | Specifies the maximum number of seconds to wait before timing out an operation. |
| UseConnectionPooling | Enables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| WorkloadPoolId | The ID of your Workload Identity Federation pool. |
| WorkloadProjectId | The ID of the Google Cloud project that hosts your Workload Identity Federation pool. |
| WorkloadProviderId | The ID of your Workload Identity Federation pool provider. |