JDBC Driver for Quickbase

Build 22.0.8462

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 Quickbase.
DomainYour Quickbase domain name.
UserTokenThe user token used to authenticate the user.
UserThe Quickbase user account used to authenticate.
PasswordThe password used to authenticate the user.
ApplicationTokenThe application token used to authenticate the user.

Connection


PropertyDescription
SchemaSpecify the Quickbase database you want to work with.
IncludeTableReportsDetermines if Quickbase table reports should be listed as views.

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. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
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.

Caching


PropertyDescription
AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
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
BatchSizeThe size of batches to submit when performing a bulk insert/update/delete operation.
CharsetSpecifies the session character set for encoding and decoding character data transferred to and from the Quickbase API. The default value is UTF-8.
ConnectionLifeTimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectOnOpenThis property specifies whether to connect to the Quickbase when the connection is opened.
MaxRowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
MaxThreadsSpecifies the number of concurrent requests.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Quickbase.
PoolIdleTimeoutThe allowed idle time for a connection before it is closed.
PoolMaxSizeThe maximum connections in the pool.
PoolMinSizeThe minimum number of connections in the pool.
PoolWaitTimeThe max seconds to wait for an available connection.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
ReadonlyYou can use this property to enforce read-only access to Quickbase from the provider.
RTKThe runtime key used for licensing.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UseConnectionPoolingThis property enables connection pooling.
UseDefaultOrderByIndicates if a default order by should be applied if none is specified in the query.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462