CData Python Connector for Google BigQuery

Build 23.0.8839

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.

Authentication


PropertyDescription
AuthSchemeThe type of authentication to use when connecting to Google BigQuery.
ProjectIdThe ProjectId used to resolve unqualified tables and execute jobs.
DatasetIdThe DatasetId used to resolve unqualified tables.
BillingProjectIdThe ProjectId of the billing project for executing jobs.

BigQuery


PropertyDescription
AllowLargeResultSetsWhether or not to allow large datasets to be stored in temporary tables for large datasets.
DestinationTableThis property determines where query results are stored in Google BigQuery.
UseQueryCacheSpecifies whether to use Google BigQuery's built-in query cache.
PageSizeThe number of results to return per page from Google BigQuery.
PollingIntervalThis determines how long to wait in seconds, between checks to see if a job has completed.
AllowUpdatesWithoutKeyWhether or not to allow update without primary keys.
FilterColumnsPlease set `AllowUpdatesWithoutKey` to true before you could use this property.
UseLegacySQLSpecifies whether to use BigQuery's legacy SQL dialect for this query. By default, Standard SQL will be used.

Storage API


PropertyDescription
UseStorageAPISpecifies whether to use BigQuery's Storage API for bulk data reads.
UseArrowFormatSpecifies whether to use the Arrow format with BigQuery's Storage API.
StorageThresholdThe minimum number of rows a query must return to invoke the Storage API.
StoragePageSizeSpecifies the page size to use for Storage API queries.

Uploading


PropertyDescription
InsertModeSpecifies what kind of method to use when inserting data. By default streaming INSERTs are used.
WaitForBatchResultsWhether to wait for the job to complete when using the bulk upload API. Only active when InsertMode is set to Upload.
GCSBucketSpecifies the name of a GCS bucket to upload bulk data for staging.
GCSBucketFolderSpecifies the name of the folder in GCSBucket to upload bulk data for staging.
TempTableDatasetThe prefix of the dataset that will contain temporary tables when performing bulk UPDATE or DELETE operations.

OAuth


PropertyDescription
InitiateOAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuthSettingsLocationThe 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://'.
ScopeIdentifies the Google API access that your application is requesting. Scopes are space-delimited.
OAuthVerifierThe verifier code returned from the OAuth authorization URL.

JWT OAuth


PropertyDescription
OAuthJWTCertThe JWT Certificate store.
OAuthJWTCertTypeThe type of key store containing the JWT Certificate.
OAuthJWTCertPasswordThe password for the OAuth JWT certificate.
OAuthJWTCertSubjectThe subject of the OAuth JWT certificate.
OAuthJWTIssuerThe issuer of the Java Web Token.
OAuthJWTSubjectThe user subject for which the application is requesting delegated access.

SSL


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogfileA filepath which designates the name and location of the log file.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
RefreshViewSchemasAllows the provider to determine up-to-date view schemas automatically.
ShowTableDescriptionsControls whether table descriptions are returned via the platform metadata APIs and sys_tables / sys_views.
PrimaryKeyIdentifiersSet this property to define primary keys.
AllowedTableTypesSpecifies what kinds of tables will be visible.
FlattenObjectsDetermines whether the provider flattens STRUCT fields into top-level columns.

Caching


PropertyDescription
AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheProviderThe name of the provider to be used to cache data.
CacheDriverThe database driver used to cache data.
CacheConnectionThe 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.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
OfflineUse offline mode to get the data from the cache instead of the live source.
CacheMetadataThis property determines whether or not to cache the table metadata to a file store.

Miscellaneous


PropertyDescription
StorageTimeoutHow long a Storage API connection must remain idle before the provider reconnects.
AllowAggregateParametersAllows raw aggregates to be used in parameters when QueryPassthrough is enabled.
ApplicationNameAn application name in the form application/version. For example, AcmeReporting/1.0.
AuditLimitThe maximum number of rows which will be stored within an audit table.
AuditModeWhat provider actions should be recorded to audit tables.
BigQueryOptionsA comma separated list of Google BigQuery options.
GenerateSchemaFilesIndicates the user preference as to when schemas should be generated and saved.
MaximumBillingTierThe 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.
MaximumBytesBilledLimits how many bytes BigQuery will allow a job to consume before it is cancelled.
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
OtherThese hidden properties are used only in specific use cases.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
QueryPassthroughThis option passes the query to the Google BigQuery server as is.
ReadonlyYou can use this property to enforce read-only access to Google BigQuery from the provider.
RTKThe runtime key used for licensing.
TableSamplePercentThis determines what percent of a table is sampled with the TABLESAMPLE operator.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839