JDBC Driver for HarperDB

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.


AuthSchemeThe scheme used for authentication. Accepted entries are Basic and Token.
ServerThe host name or IP address of the server hosting the HarperDB database. For example, demo.harperdbcloud.com/hdbinstance or
UseSSLThis field sets whether SSL is enabled.
PortThe port for the connection to the HarperDB instance. If no port value should be used in the URL for your HarperDB instance, leave the Port connection property blank. The driver does not assign a default port value.
UserThe HarperDB user account used to authenticate.
PasswordThe password used to authenticate the user.
OperationTokenThe operation_token used to authenticate to HarperDB.
RefreshTokenThe refresh_token used to refresh an operation_token.
OperationTokenTimeoutThe lifetime of the retrieved operation_token. This setting defaults to the default operation_token lifetime for HarperDB. This setting only applies when OperationToken and RefreshToken are left unspecified, and the driver is instead retrieving and managing token credentials using the supplied User and Password .
RefreshTokenTimeoutThe lifetime of the retrieved refresh_token. This setting defaults to the default refresh_token lifetime for HarperDB. This setting only applies when OperationToken and RefreshToken are left unspecified, and the driver is instead retrieving and managing token credentials using the supplied User and Password .
CredentialsLocationThe location of the settings file where credentials are saved.


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


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.


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 .


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.


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.


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.


BatchSizeThe maximum size of each batch operation to submit.
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 HarperDB when the connection is opened.
FlattenArraysSet FlattenArrays to the number of array elements you want to return as table columns. Otherwise, arrays are returned as strings of JSON.
FlattenObjectsSet FlattenObjects to true to flatten object properties into columns of their own. Otherwise, nested objects are returned as strings of JSON.
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.
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 HarperDB from the provider.
RefreshCachedSchemaAfterDDLWhether or not the driver should refresh cached metadata, whether cached in memory or cached otherwise as configured by the driver's caching settings, after the successful execution of the driver's stored procedures, which all affect the schema in HarperDB itself.
RowScanDepthThe maximum number of rows to scan when generating table metadata. Set this property to gain more control over how the provider detects data types.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionSchemeComma-separated options for how the provider will scan the data to determine the fields and datatypes in each document collection.
UseConnectionPoolingThis property enables connection pooling.
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