ODBC Driver for MongoDB

Build 24.0.9175

Miscellaneous

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


PropertyDescription
BatchSizeSpecifies the maximum number of rows included in each batch operation. Set to 0 to submit the entire batch as a single request.
BuiltInColumnMappingA list of column name mappings for MongoDB's built-in columns.
CompressionSpecify the compression method. Compression is not enabled when it is None.
DataModelBy default, the provider will not automatically discover the metadata for a child table as its own distinct table. To enable this functionality, set DataModel to Relational .
DefaultDomainThis property is used for the Oracle Database Gateway for ODBC.
EnableForeignKeyDetectionWhether to detect the foreign keys in ODBC.
FlattenArraysBy 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.
FlattenObjectsSet FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.
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.
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 rows returned for queries without aggregation or GROUP BY.
NoCursorTimeoutThe server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
OtherSpecifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PagesizeSpecifies the maximum number of results to return from MongoDB, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
QueryPassthroughThis option passes the query to MongoDB as-is.
ReadonlyToggles read-only access to MongoDB from the provider.
ReadPreferenceSet this to a strategy for reading from a replica set. Accepted values are primary, primaryPreferred, secondary, secondaryPreferred, and nearest.
ReadPreferenceTagsUse this property to target a replica set member or members that are associated with tags.
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. Use this property only in environments where the standard licensing method is unsupported or requires a runtime key.
ServiceKindSpecify the kind of service.
SlaveOKThis property sets whether the provider is allowed to read from secondary (slave) servers.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
TypeDetectionSchemeComma-separated options for how the provider will scan the data to determine the fields and datatypes in each document collection.
UpdateSchemeSets replacing or merging target document with updating fields is performed by executing update statement.
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.
UseFindAPIExecute MongoDB queries using db.collection.find().
UserDefinedViewsSpecifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
WriteConcernRequests acknowledgment that the write operation has propagated to the specified number of mongod instances.
WriteConcernJournaledRequires acknowledgment that the mongod instances, as specified in the WriteConcern property, have written to the on-disk journal.
WriteConcernTimeoutThis option specifies a time limit, in milliseconds, for the write concern.
WriteSchemeSets whether the object type for inserted or updated objects is determined from the existing column metadata or the input value type.

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