JDBC Driver for MongoDB

Build 25.0.9434

Miscellaneous

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


PropertyDescription
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 .
BuiltInColumnMappingA comprehensive list detailing the mappings of column names for the built-in fields used in MongoDB.
CompressionSpecifies the compression method used for network communication between the client and the MongoDB server.
ConnectionLifeTimeSpecifies the maximum lifetime of a connection in seconds. When the specified time elapses, the provider closes the connection.
ConnectOnOpenSpecifies whether the provider establishes a connection to MongoDB immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary.
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 .
DatetimeFormatDetermines the format of datetime values returned by the Document function. This property only takes effect when StrictMode=true.
FlattenArraysThis property specifies whether nested array elements are flattened into individual columns. By default, nested arrays are returned as JSON strings. Set this property to the number of elements to extract from nested arrays.
FlattenObjectsThis property specifies whether the attributes of objects are flattened into separate columns.
GenerateSchemaFilesIndicates the user preference as to when schemas should be generated and saved.
MaxRowsSpecifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
NoCursorTimeoutThe server typically terminates idle cursors after 30 minutes of inactivity to prevent excessive memory usage. Set this option to true to avoid automatic timeouts and keep your cursors active.
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 MongoDB.
PoolIdleTimeoutSpecifies the maximum idle time, in seconds, that a connection can remain in the pool before being closed. Requires UseConnectionPooling=True.
PoolMaxSizeSpecifies the maximum number of connections allowed in the connection pool.
PoolMinSizeSpecifies the minimum number of connections to be maintained in the connection pool at all times.
PoolWaitTimeSpecifies the maximum number of seconds a connection request waits for an available connection in the pool. If the wait exceeds this time, an error is returned.
PseudoColumnsSpecifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
QueryPassthroughDetermines whether queries are sent directly to MongoDB without modification.
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.
ReadPreferenceTagsThis property is used to identify and interact with one or more members of a replica set that are linked to specific 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. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key.
ServiceKindSpecifies the type of service the provider can interact with.
SlaveOKDetermines the provider's capability to read data from secondary (slave) servers. It controls whether the provider can access and retrieve information from these backup systems.
TimeoutSpecifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
TypeDetectionSchemeSpecifies the method for detecting metadata discovery.
UpdateSchemeSpecifies the strategy that can be used when executing an update statement.
UseConnectionPoolingEnables the connection pooling feature, which allows the provider to reuse existing connections instead of creating new ones for each request.
UseFindAPISpecifies whether MongoDB queries using the method db.collection.find(), allow retrieval of documents from a specific collection based on defined criteria.
UserDefinedViewsSpecifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
WriteConcernDetermines the level of acknowledgment requested for write operations in MongoDB, applicable to standalone mongod, replica sets, or sharded clusters.
WriteConcernJournaledDetermines whether write operations can be recorded in the on-disk journal before being acknowledged as successful.
WriteConcernTimeoutThe WriteConcernTimeout property specifies the maximum time (in milliseconds) that the server should wait for a write concern to be acknowledged before returning an error.
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 25.0.9434