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 scheme used for authentication. Accepted entries are Basic and Token. |
| Server | The host name or IP address of the server hosting the HarperDB database. For example, demo.harperdbcloud.com/hdbinstance or 127.0.0.1. |
| UseSSL | This field sets whether SSL is enabled. |
| Port | The 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. |
| User | The HarperDB user account used to authenticate. |
| Password | The password used to authenticate the user. |
| OperationToken | The operation_token used to authenticate to HarperDB. |
| RefreshToken | The refresh_token used to refresh an operation_token. |
| OperationTokenTimeout | The 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 . |
| RefreshTokenTimeout | The 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 . |
| CredentialsLocation | The location of the settings file where credentials are saved. |
| 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 | When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port that the proxy server (specified in the ProxyServer connection property) is running on. |
| ProxyAuthScheme | The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connnection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| 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. |
| 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 |
| BatchSize | The maximum size of each batch operation to submit. |
| 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 HarperDB when the connection is opened. |
| FlattenArrays | Set FlattenArrays to the number of array elements you want to return as table columns. Otherwise, arrays are returned as strings of JSON. |
| FlattenObjects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, nested objects are returned as strings of JSON. |
| 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 | Specify a set of pseudocolumns to expose as columns. |
| Readonly | You can use this property to enforce read-only access to HarperDB from the provider. |
| RefreshCachedSchemaAfterDDL | Whether 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. |
| RowScanDepth | The maximum number of rows to scan when generating table metadata. Set this property to gain more control over how the provider detects data types. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| TypeDetectionScheme | Comma-separated options for how the provider will scan the data to determine the fields and datatypes in each document collection. |
| UseConnectionPooling | This property enables connection pooling. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |