Connection Parameters
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 type of authentication to use when connecting to Couchbase. |
User | The Couchbase user account used to authenticate. |
Password | The password used to authenticate the user. |
CredentialsFile | Use this property if you need to provide credentials for multiple users or buckets. This file takes priority over other forms of authentication. |
Server | The address of the Couchbase server or servers to which you are connecting. |
CouchbaseService | Determines the Couchbase service to connect to. Default is N1QL. Available options are N1QL and Analytics. |
ConnectionMode | Determines how to connect to the Couchbase server. Must be either Direct or Cloud. |
DNSServer | Determines what DNS server to use when retrieving Couchbase Capella information. |
N1QLPort | The port or URL for connecting to the Couchbase N1QL Endpoint. |
AnalyticsPort | The port or URL for connecting to the Couchbase Analytics Endpoint. |
WebConsolePort | The port or URL for connecting to the Couchbase Web Console. |
Property | Description |
SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
UseSSL | Whether to negotiate TLS/SSL when connecting to the Couchbase server. |
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 | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
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. |
Dataverse | Which Analytics dataverse to scan when discovering tables. |
TypeDetectionScheme | Determines how the provider builds tables and columns from the buckets found in Couchbase. |
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. |
FlexibleSchemas | Whether the provider allows queries to use columns that it has not discovered. |
ExposeTTL | Specifies whether document TTL information should be exposed. |
NumericStrings | Whether to allow string values to be treated as numbers. |
IgnoreChildAggregates | Whether the provider exposes aggregate columns that are also available as child tables. Ignored if TableSupport is not set to Full. |
TableSupport | How much effort the provider will put into discovering tables on the Couchbase server. |
NewChildJoinsMode | Determines the kind of child table model the provider exposes. |
Property | Description |
AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
CacheProvider | The name of the provider to be 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 |
AllowJSONParameters | Allows raw JSON to be used in parameters when QueryPassthrough is enabled. |
ChildSeparator | The character or characters used to denote child tables. |
CreateTableRamQuota | The default RAM quota, in megabytes, to use when inserting buckets via the CREATE TABLE syntax. |
DataverseSeparator | The character or characters used to denote Analytics dataverses and scopes/collections. |
FlattenArrays | The number of elements to expose as columns from nested arrays. Ignored if IgnoreChildAggregates is enabled. |
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. |
InsertNullValues | Determines whether an INSERT should include fields that have NULL values. |
MaximumColumnSize | The maximum column size. |
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. |
Pagesize | The maximum number of results to return per page from Couchbase. |
PeriodsSeparator | The character or characters used to denote hierarchy. |
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 rows to scan to look for the columns available in a table. |
RTK | The runtime key used for licensing. |
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. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TransactionDurability | Specifies how a document must be stored for a transaction to succeed. Specifies whether to use N1QL transactions when executing queries. |
TransactionTimeout | This sets the amount of time a transaction may execute before it is timed out by Couchbase. |
UpdateNullValues | Determines whether an UPDATE writes NULL values as NULL, or removes them. |
UseCollectionsForDDL | Whether to assume that CREATE TABLE statements use collections instead of flavors. Only takes effect when connecting to Couchbase v7+ and GenerateSchemaFiles is set to OnCreate. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
UseTransactions | Specifies whether to use N1QL transactions when executing queries. |
ValidateJSONParameters | Allows the provider to validate that string parameters are valid JSON before sending the query to Couchbase. |