Connection String Parameters for Couchbase
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.
| Name | Description |
| AllowJSONParameters | Allows raw JSON to be used in parameters when QueryPassthrough is enabled. |
| AnalyticsPort | The port for connecting to the Couchbase Analytics Endpoint. |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| 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. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| CacheProvider | The name of the provider to be used to cache data. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| ChildSeparator | The character or characters used to denote child tables. |
| ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
| CouchbaseService | Determines the Couchbase service to connect to. Default is N1QL. Available options are N1QL and Analytics. |
| CreateTableRamQuota | The default RAM quota, in megabytes, to use when inserting buckets via the CREATE TABLE syntax. |
| CredentialsFile | 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. |
| DataverseSeparator | The character or characters used to denote Analytics dataverses. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FlattenArrays | 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. |
| FlattenObjects | Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON. |
| FlavorSeparator | The character or characters used to denote flavors. |
| GenerateSchemaFiles | Indicates the user preference as to when schemas should be generated and saved. |
| InferNumSampleValues | 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. |
| InferSampleSize | 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. |
| InferSimilarityMetric | 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. |
| Logfile | A path to the log file. |
| MaxLogFileCount | A 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. |
| MaxLogFileSize | A 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. |
| MaxRows | 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. |
| N1QLPort | The port for connecting to the Couchbase N1QL Endpoint. |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| Other | These hidden properties are used only in specific use cases. |
| PageSize | The number of results to return per page of data retrieved from the Couchbase server. |
| Password | The password used to authenticate to Couchbase. |
| PeriodsSeparator | The character or characters used to denote hierarchy. |
| 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. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyAutoDetect | 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. |
| ProxyExceptions | A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer . |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| QueryExecutionTimeout | This sets the server-side timeout for the query, which governs how long Couchbase will execute the query before returning a timeout error. |
| QueryPassthrough | This option passes the query to the Couchbase server as is. |
| Readonly | You can use this property to enforce read-only access to Couchbase from the provider. |
| RowScanDepth | The maximum number of documents to scan for the columns available in the bucket. |
| RTK | The runtime key used for licensing. |
| Server | The address of the Couchbase server or servers to which you are connecting. |
| SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
| SSLClientCertPassword | The password for the TLS/SSL client certificate. |
| SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
| SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| StrictComparison | 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. |
| SupportEnhancedSQL | If the property is set to true, allow the provider to perform queries client-side when Couchbase does not support them. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| TableSupport | 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. |
| TypeDetectionScheme | Determines how the provider builds tables and columns from the buckets found in Couchbase. |
| UseConnectionPooling | This property enables connection pooling. |
| User | The user who is authenticating to Couchbase. |
| UseSSL | Whether to negotiate TLS/SSL when connecting to the Couchbase server. |
| ValidateJSONParameters | Allows the provider to validate that string parameters are valid JSON before sending the query to Couchbase. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| WebConsolePort | The port for connecting to the Couchbase Web Console. |