TDV Adapter for MongoDB

Build 21.0.8137

Connection String Options

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 Basic Tab.

Authentication


PropertyDescription
AuthSchemeThe authentication mechanism that MongoDB will use to authenticate the connection.
ServerThe host name or IP address of the server hosting the MongoDB database.
PortThe port for the MongoDB database.
UserThe MongoDB user account used to authenticate.
PasswordThe password used to authenticate the user.
DatabaseThe name of the MongoDB database.
UseSSLThis field sets whether SSL is enabled.
AuthDatabaseThe name of the MongoDB database for authentication.
ReplicaSetThis property allows you to specify multiple servers in addition to the one configured in Server and Port . Specify both a server name and port; separate servers with a comma.
DNSServerSpecify the DNS server when resolving MongoDB seed list.

Kerberos


PropertyDescription
KerberosKDCThe Kerberos Key Distribution Center (KDC) service used to authenticate the user.
KerberosRealmThe Kerberos Realm used to authenticate the user with.
KerberosSPNThe service principal name (SPN) for the Kerberos Domain Controller.
KerberosKeytabFileThe Keytab file containing your pairs of Kerberos principals and encrypted keys.
KerberosServiceRealmThe Kerberos realm of the service.
KerberosServiceKDCThe Kerberos KDC of the service.
KerberosTicketCacheThe full file path to an MIT Kerberos credential cache file.

SSL


PropertyDescription
SSLClientCertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertTypeThe type of key store containing the TLS/SSL client certificate.
SSLClientCertPasswordThe password for the TLS/SSL client certificate.
SSLClientCertSubjectThe subject of the TLS/SSL client certificate.
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

SSH


PropertyDescription
SSHAuthModeThe authentication method to be used to log on to an SFTP server.
SSHClientCertA certificate to be used for authenticating the user.
SSHClientCertPasswordThe password of the SSHClientCert certificate if it has one.
SSHClientCertSubjectThe subject of the SSH client certificate.
SSHClientCertTypeThe type of SSHClientCert certificate.
SSHServerThe SSH server.
SSHPortThe SSH port.
SSHUserThe SSH user.
SSHPasswordThe SSH password.
SSHServerFingerprintThe SSH server fingerprint.
UseSSHWhether to tunnel the MongoDB connection over SSH. Use SSH.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Logging


PropertyDescription
LogModulesCore modules to be included in the log file.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.

Miscellaneous


PropertyDescription
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 .
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.
MaxRowsLimits 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.
NoCursorTimeoutThe server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from MongoDB.
QueryPassthroughThis option passes the query to MongoDB as-is.
ReadonlyYou can use this property to enforce 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.
RowScanDepthThe maximum number of rows to scan to look for the columns available in a table.
SlaveOKThis property sets whether the provider is allowed to read from secondary (slave) servers.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionSchemeComma-separated options for how the provider will scan the data to determine the fields and datatypes in each document collection.
UseFindAPIExecute MongoDB queries using db.collection.find().
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) 2022 CData Software, Inc. - All rights reserved.
Build 21.0.8137