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.

---

Allow JSON Parameters	Allows raw JSON to be used in parameters when QueryPassthrough is enabled.
Analytics Port	The port for connecting to the Couchbase Analytics Endpoint.
Child Separator	The character or characters used to denote child tables.
Couchbase Service	Determines the Couchbase service to connect to. Default is N1QL. Available options are N1QL and Analytics.
Create Table Ram Quota	The default RAM quota, in megabytes, to use when inserting buckets via the CREATE TABLE syntax.
Credentials File	Use this property if you need to provide credentials for multiple users or buckets. This file takes priority over other forms of authentication.
Dataverse	Which Analytics dataverse to scan when discovering tables.
Dataverse Separator	The character or characters used to denote Analytics dataverses.
Firewall Password	A password used to authenticate to a proxy-based firewall.
Firewall Port	The TCP port for a proxy-based firewall.
Firewall Server	The name or IP address of a proxy-based firewall.
Firewall Type	The protocol used by a proxy-based firewall.
Firewall User	The user name to use to authenticate with a proxy-based firewall.
Flatten Arrays	By default, nested arrays are returned as strings of JSON. The FlattenArrays property can be used to flatten the elements of nested arrays into columns of their own. Set FlattenArrays to the number of elements you want to return from nested arrays.
Flatten Objects	Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.
Flavor Separator	The character or characters used to denote flavors.
Generate Schema Files	Indicates the user preference as to when schemas should be generated and saved.
Infer Num Sample Values	The 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 Size	The 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 Metric	Specifies 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.
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
Max Rows	Limits 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 Port	The port for connecting to the Couchbase N1QL Endpoint.
Other	These hidden properties are used only in specific use cases.
Page Size	The number of results to return per page of data retrieved from the Couchbase server.
Password	The password used to authenticate to Couchbase.
Periods Separator	The character or characters used to denote hierarchy.
Proxy Auth Scheme	The authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto Detect	This 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 Exceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Proxy Password	A password to be used to authenticate to the ProxyServer proxy.
Proxy Port	The TCP port the ProxyServer proxy is running on.
Proxy Server	The hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL Type	The SSL type to use when connecting to the ProxyServer proxy.
Proxy User	A user name to be used to authenticate to the ProxyServer proxy.
Query Execution Timeout	This sets the server-side timeout for the query, which governs how long Couchbase will execute the query before returning a timeout error.
Readonly	You can use this property to enforce read-only access to Couchbase from the provider.
Row Scan Depth	The maximum number of documents to scan for the columns available in the bucket.
Server	The address of the Couchbase server or servers to which you are connecting.
SSL Client Cert	The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSL Client Cert Password	The password for the TLS/SSL client certificate.
SSL Client Cert Subject	The subject of the TLS/SSL client certificate.
SSL Client Cert Type	The type of key store containing the TLS/SSL client certificate.
SSL Server Cert	The certificate to be accepted from the server when connecting using TLS/SSL.
Strict Comparison	Adjusts 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.
Table Support	How much effort the provider will put into discovering tables on the Couchbase server.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
Type Detection Scheme	Determines how the provider builds tables and columns from the buckets found in Couchbase.
User	The user who is authenticating to Couchbase.
Use SSL	Whether to negotiate TLS/SSL when connecting to the Couchbase server.
Validate JSON Parameters	Allows the provider to validate that string parameters are valid JSON before sending the query to Couchbase.
Web Console Port	The port for connecting to the Couchbase Web Console.