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.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | The type of authentication to use when connecting to Google BigQuery. |
| ProjectId | The ProjectId used to resolve unqualified tables and execute jobs. |
| DatasetId | The DatasetId used to resolve unqualified tables. |
| BillingProjectId | The ProjectId of the billing project for executing jobs. |
| Property | Description |
| AllowLargeResultSets | Whether or not to allow large datasets to be stored in temporary tables for large datasets. |
| DestinationTable | This property determines where query results are stored in Google BigQuery. |
| UseQueryCache | Specifies whether to use Google BigQuery's built-in query cache. |
| PageSize | The number of results to return per page from Google BigQuery. |
| PollingInterval | This determines how long to wait in seconds, between checks to see if a job has completed. |
| AllowUpdatesWithoutKey | Whether or not to allow update without primary keys. |
| FilterColumns | Please set `AllowUpdatesWithoutKey` to true before you could use this property. |
| UseLegacySQL | Specifies whether to use BigQuery's legacy SQL dialect for this query. By default, Standard SQL will be used. |
| Property | Description |
| UseStorageAPI | Specifies whether to use BigQuery's Storage API for bulk data reads. |
| UseArrowFormat | Specifies whether to use the Arrow format with BigQuery's Storage API. |
| StorageThreshold | The minimum number of rows a query must return to invoke the Storage API. |
| StoragePageSize | Specifies the page size to use for Storage API queries. |
| Property | Description |
| InsertMode | Specifies what kind of method to use when inserting data. By default streaming INSERTs are used. |
| WaitForBatchResults | Whether to wait for the job to complete when using the bulk upload API. Only active when InsertMode is set to Upload. |
| GCSBucket | Specifies the name of a GCS bucket to upload bulk data for staging. |
| GCSBucketFolder | Specifies the name of the folder in GCSBucket to upload bulk data for staging. |
| TempTableDataset | The prefix of the dataset that will contain temporary tables when performing bulk UPDATE or DELETE operations. |
| Property | Description |
| InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
| OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
| OAuthAccessToken | The access token for connecting using OAuth. |
| OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'. |
| Scope | Identifies the Google API access that your application is requesting. Scopes are space-delimited. |
| OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
| OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
| OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
| Property | Description |
| OAuthJWTCert | The JWT Certificate store. |
| OAuthJWTCertType | The type of key store containing the JWT Certificate. |
| OAuthJWTCertPassword | The password for the OAuth JWT certificate. |
| OAuthJWTCertSubject | The subject of the OAuth JWT certificate. |
| OAuthJWTIssuer | The issuer of the Java Web Token. |
| OAuthJWTSubject | The user subject for which the application is requesting delegated access. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| RefreshViewSchemas | Allows the provider to determine up-to-date view schemas automatically. |
| ShowTableDescriptions | Controls whether table descriptions are returned via the platform metadata APIs and sys_tables / sys_views. |
| PrimaryKeyIdentifiers | Set this property to define primary keys. |
| AllowedTableTypes | Specifies what kinds of tables will be visible. |
| FlattenObjects | Determines whether the provider flattens STRUCT fields into top-level columns. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheDriver | The database driver used to cache data. |
| CacheConnection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| StorageTimeout | How long a Storage API connection must remain idle before the provider reconnects. |
| AllowAggregateParameters | Allows raw aggregates to be used in parameters when QueryPassthrough is enabled. |
| ApplicationName | An application name in the form application/version. For example, AcmeReporting/1.0. |
| AuditLimit | The maximum number of rows which will be stored within an audit table. |
| AuditMode | What provider actions should be recorded to audit tables. |
| BigQueryOptions | A comma separated list of Google BigQuery options. |
| ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| ConnectOnOpen | This property specifies whether to connect to the Google BigQuery when the connection is opened. |
| GenerateSchemaFiles | Indicates the user preference as to when schemas should be generated and saved. |
| MaximumBillingTier | The MaximumBillingTier is a positive integer that serves as a multiplier of the basic price per TB. For example, if you set MaximumBillingTier to 2, the maximum cost for that query will be 2x basic price per TB. |
| MaximumBytesBilled | Limits how many bytes BigQuery will allow a job to consume before it is cancelled. |
| MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| Other | These hidden properties are used only in specific use cases. |
| PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
| PoolMaxSize | The maximum connections in the pool. |
| PoolMinSize | The minimum number of connections in the pool. |
| PoolWaitTime | The max seconds to wait for an available connection. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| QueryPassthrough | This option passes the query to the Google BigQuery server as is. |
| Readonly | You can use this property to enforce read-only access to Google BigQuery from the provider. |
| RTK | The runtime key used for licensing. |
| TableSamplePercent | This determines what percent of a table is sampled with the TABLESAMPLE operator. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UseConnectionPooling | This property enables connection pooling. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |