JDBC Driver for Couchbase

Build 20.0.7587

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.
Allow JSON ParametersAllows raw JSON to be used in parameters when QueryPassthrough is enabled.
Analytics PortThe port for connecting to the Couchbase Analytics Endpoint.
Auth SchemeThe type of authentication to use when connecting to Couchbase.
Auto CacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
Batch SizeThe maximum size of each batch operation to submit.
Cache ConnectionThe 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.
Cache DriverThe database driver to be used to cache data.
Cache LocationSpecifies the path to the cache when caching to a file.
Cache MetadataThis property determines whether or not to cache the table metadata to a file store.
Cache ToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
Child SeparatorThe character or characters used to denote child tables.
Connection Life TimeThe maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
Connect On OpenThis property species whether to connect to the Couchbase when the connection is opened.
Couchbase ServiceDetermines the Couchbase service to connect to. Default is N1QL. Available options are N1QL and Analytics.
Create Table Ram QuotaThe default RAM quota, in megabytes, to use when inserting buckets via the CREATE TABLE syntax.
Credentials FileUse this property if you need to provide credentials for multiple users or buckets. This file takes priority over other forms of authentication.
DataverseWhich Analytics dataverse to scan when discovering tables.
Dataverse SeparatorThe character or characters used to denote Analytics dataverses.
Expose TTLSpecifies whether document TTL information should be exposed.
Firewall PasswordA password used to authenticate to a proxy-based firewall.
Firewall PortThe TCP port for a proxy-based firewall.
Firewall ServerThe name or IP address of a proxy-based firewall.
Firewall TypeThe protocol used by a proxy-based firewall.
Firewall UserThe user name to use to authenticate with a proxy-based firewall.
Flatten ArraysThe number of elements to expose as columns from nested arrays. Ignored if IgnoreChildAggregates is enabled.
Flatten ObjectsSet FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.
Flavor SeparatorThe character or characters used to denote flavors.
Flexible SchemasWhether the provider allows queries to use columns that it has not discovered.
Generate Schema FilesIndicates the user preference as to when schemas should be generated and saved.
Ignore Child AggregatesWhether the provider exposes aggregate columns that are also available as child tables. Ignored if TableSupport is not set to Full.
Infer Num Sample ValuesThe maximum number of values for every field to scan before determining its data type. Applies to Automatic Schema Discovery when TypeDetectionScheme is set to INFER.
Infer Sample SizeThe maximum number of documents to scan for the columns available in the bucket. Applies to Automatic Schema Discovery when TypeDetectionScheme is set to INFER.
Infer Similarity MetricSpecifies the similarity degree where different schemas will be considered to be the same flavor. Applies to Automatic Schema Discovery when TypeDetectionScheme is set to INFER.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA filepath which designates the name and location of the log file.
Log ModulesCore modules to be included in the log file.
Max Log File CountA string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
Max Log File SizeA string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Max RowsLimits 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.
N1QL PortThe port for connecting to the Couchbase N1QL Endpoint.
OfflineUse offline mode to get the data from the cache instead of the live source.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Couchbase.
PasswordThe password used to authenticate the user.
Periods SeparatorThe character or characters used to denote hierarchy.
Pool Idle TimeoutThe allowed idle time for a connection before it is closed.
Pool Max SizeThe maximum connections in the pool.
Pool Min SizeThe minimum number of connections in the pool.
Pool Wait TimeThe max seconds to wait for an available connection.
Proxy Auth SchemeThe authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto DetectThis 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.
Proxy ExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Proxy PasswordA password to be used to authenticate to the ProxyServer proxy.
Proxy PortThe TCP port the ProxyServer proxy is running on.
Proxy ServerThe hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL TypeThe SSL type to use when connecting to the ProxyServer proxy.
Proxy UserA user name to be used to authenticate to the ProxyServer proxy.
Pseudo ColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
Query Execution TimeoutThis sets the server-side timeout for the query, which governs how long Couchbase will execute the query before returning a timeout error.
Query PassthroughThis option passes the query to the Couchbase server as is.
ReadonlyYou can use this property to enforce read-only access to Couchbase from the provider.
Row Scan DepthThe maximum number of rows to scan to look for the columns available in a table.
RTKThe runtime key used for licensing.
ServerThe address of the Couchbase server or servers to which you are connecting.
SSL Client CertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSL Client Cert PasswordThe password for the TLS/SSL client certificate.
SSL Client Cert SubjectThe subject of the TLS/SSL client certificate.
SSL Client Cert TypeThe type of key store containing the TLS/SSL client certificate.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
Strict ComparisonAdjusts how precisely to translate filters on SQL input queries into Couchbase queries. This can be set to a comma-separated list of values, where each value can be one of: date, number, boolean, or string.
Support Enhanced SQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Table SupportHow much effort the provider will put into discovering tables on the Couchbase server.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
Type Detection SchemeDetermines how the provider builds tables and columns from the buckets found in Couchbase.
Use Connection PoolingThis property enables connection pooling.
UserThe Couchbase user account used to authenticate.
Use SSLWhether to negotiate TLS/SSL when connecting to the Couchbase server.
Validate JSON ParametersAllows the provider to validate that string parameters are valid JSON before sending the query to Couchbase.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Web Console PortThe port for connecting to the Couchbase Web Console.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587