ODBC Driver for Couchbase

Build 25.0.9434

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection settings for this provider.


PropertyDescription
AllowJSONParametersAllows raw JSON to be used in parameters when QueryPassthrough is enabled.
BatchSizeSpecifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 .
ChildSeparatorThe character or characters used to denote child tables.
ConnectOnOpenSpecifies whether the provider establishes a connection to Couchbase immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary.
CreateTableRamQuotaThe default RAM quota, in megabytes, to use when inserting buckets via the CREATE TABLE syntax.
DataverseSeparatorThe character or characters used to denote Analytics dataverses and scopes/collections.
DefaultDomainThis property is used for the Oracle Database Gateway for ODBC.
EnableForeignKeyDetectionWhether to detect the foreign keys in ODBC.
FlattenArraysThe number of elements to expose as columns from nested arrays. Ignored if IgnoreChildAggregates is enabled.
FlattenObjectsSet FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.
FlavorSeparatorThe character or characters used to denote flavors.
GenerateSchemaFilesIndicates the user preference as to when schemas should be generated and saved.
IncludeDualTableSet this property to mock the Oracle DUAL table for better compatibility with Oracle database.
InsertNullValuesDetermines whether an INSERT should include fields that have NULL values.
LimitKeySizeThe maximum length of a primary key column.
MapBigintToVarcharThis property controls whether or not the bigint type maps to SQL_VARCHAR instead of SQL_BIGINT. This property is false by default.
MapToIntThis property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default.
MapToLongVarcharThis property controls whether or not a column is returned as SQL_LONGVARCHAR.
MapToWVarcharThis property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default.
MaximumColumnSizeThe maximum column size.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
OtherSpecifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details.
PagesizeSpecifies the maximum number of records per page the provider returns when requesting data from Couchbase.
PeriodsSeparatorThe character or characters used to denote hierarchy.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
QueryExecutionTimeoutThis sets the server-side timeout for the query, which governs how long Couchbase will execute the query before returning a timeout error.
QueryPassthroughThis option passes the query to the Couchbase server as is.
ReadonlyToggles read-only access to Couchbase from the provider.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
RTKSpecifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
StrictComparisonAdjusts 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.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
TransactionDurabilitySpecifies how a document must be stored for a transaction to succeed. Specifies whether to use N1QL transactions when executing queries.
TransactionTimeoutThis sets the amount of time a transaction may execute before it is timed out by Couchbase.
UpdateNullValuesDetermines whether an UPDATE writes NULL values as NULL, or removes them.
UpperCaseIdentifiersThis property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway.
UseCollectionsForDDLWhether 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.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UseTransactionsSpecifies whether to use N1QL transactions when executing queries.
ValidateJSONParametersAllows the provider to validate that string parameters are valid JSON before sending the query to Couchbase.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434