The name of the MongoDB database for authentication.

string

""

The name of the MongoDB database for authentication. Only needed if the authentication database is different from the database to retrieve data from.

The authentication mechanism that MongoDB will use to authenticate the connection.

string

"NONE"

Accepted values are MONGODB-CR, SCRAM-SHA-1, PLAIN, and NONE. The following authentication types correspond to the authentication values.

Generally, this property does not need to be set for this authentication type, as the adapter uses different challenge-response mechanisms by default to authenticate a user to different versions of MongoDB.

MongoDB 2: MongoDB 2 uses MONGODB-CR to authenticate.

MongoDB 3.x: MongoDB 3 uses SCRAM-SHA-1 by default; new users you create in MongoDB 3 use this authentication method. However, MongoDB 3 servers will continue to use MONGODB-CR to authenticate users created in MongoDB 2.6.

The User and Password properties correspond to a username and password stored in a MongoDB database. If you want to connect to data from one database and authenticate to another database, set both Database and AuthDatabase.

Set AuthMechanism to PLAIN to use LDAP authentication. Additionally, set AuthDatabase to the database storing the User and Password credentials.

This value specifies the SASL PLAIN mechanism; note that this mechanism transmits credentials over plain-text, so it is not suitable for use without TLS/SSL on untrusted networks. Set UseSSL and SSLServerCert to enable TLS/SSL negotiation with the Server.

The name of the MongoDB database.

string

""

The name of the MongoDB database.

A password used to authenticate to a proxy-based firewall.

string

""

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

The TCP port for a proxy-based firewall.

string

""

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The name or IP address of a proxy-based firewall.

string

""

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling.

The protocol used by a proxy-based firewall.

string

"NONE"

This property specifies the protocol that the adapter will use to tunnel traffic through the FirewallServer proxy.

 

The user name to use to authenticate with a proxy-based firewall.

string

""

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

By 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.

string

""

By 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. This is only recommended for arrays that are expected to be short.

Set FlattenArrays to the number of elements you want to return from nested arrays. The specified elements are returned as columns. The zero-based index is concatenated to the column name. Other elements are ignored.

For example, you can return an arbitrary number of elements from an array of strings:

When FlattenArrays is set to 1, the preceding array is flattened into the following table:

 

 

Setting FlattenArrays to -1 will flatten all the elements of nested arrays.

Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON.

bool

true

Set FlattenObjects to true to flatten object properties into columns of their own. Otherwise, objects nested in arrays are returned as strings of JSON. To generate the column name, the adapter concatenates the property name onto the object name with a dot.

For example, you can flatten the nested objects below at connection time:

When FlattenObjects is set to true and FlattenArrays is set to 1, the preceding array is flattened into the following table:

 

 

Indicates the user preference as to when schemas should be generated and saved.

string

"Never"

GenerateSchemaFiles enables you to persist the table definitions identified by Automatic Schema Discovery. This property outputs schemas to .rsd files in the path specified by Location.

Available settings are the following:

Never: A schema file will never be generated.

OnUse: A schema file will be generated the first time a table is referenced, provided the schema file for the table does not already exist.

OnStart: A schema file will be generated at connection time for any tables that do not currently have a schema file.

Note that if you want to regenerate a file, you will first need to delete it.

When you set GenerateSchemaFiles to OnUse, the adapter generates schemas as you execute SELECT queries. Schemas are generated for each table referenced in the query.

Another way to use this property is to obtain schemas for every table in your database when you connect. To do so, set GenerateSchemaFiles to OnStart and connect.

Schema files have a simple format that makes them easy to modify. See Custom Schema Definitions for an end-to-end guide using the MongoDB restaurants collection.

If your data structures are volatile, consider setting GenerateSchemaFiles to Never and using dynamic schemas, which change based on the metadata retrieved when you connect. Also, note that you cannot execute Free-Form Queries queries to a table that has a static schema definition.

The Kerberos Key Distribution Center (KDC) service used to authenticate the user.

string

""

The Kerberos properties are used when using Windows Authentication. The adapter will request session tickets and temporary session keys from the Kerberos Key Distribution Center (KDC) service. The Kerberos Key Distribution Center (KDC) service is conventionally colocated with the domain controller. If Kerberos KDC is not specified the adapter will attempt to detect these properties automatically from the following locations:

Java System Properties: Kerberos settings can be configured in Java using the config file krb5.conf, or using the system properties java.security.krb5.realm and java.security.krb5.kdc. The adapter will use the system settings if KerberosRealm and KerberosKDC are not explicitly set.

Domain Name and Host: The adapter will infer the Kerberos Realm and Kerberos KDC from the configured domain name and host as a last resort.

Note: Windows authentication is supported in JRE 1.6 and above only.

The Keytab file containing your pairs of Kerberos principals and encrypted keys.

string

""

The Keytab file containing your pairs of Kerberos principals and encrypted keys.

The Kerberos Realm used to authenticate the user with.

string

""

The Kerberos properties are used when using SPNEGO or Windows Authentication. The Kerberos Realm is used to authenticate the user with the Kerberos Key Distribution Service (KDC). The Kerberos Realm can be configured by an administrator to be any string, but conventionally it is based on the domain name. If Kerberos Realm is not specified the adapter will attempt to detect these properties automatically from the following locations:

Note: Kerberos-based authentication is supported in JRE 1.6 and above only.

The Kerberos KDC of the service.

string

""

The KerberosServiceKDC is used to specify the service Kerberos KDC when using cross-realm Kerberos authentication.

In most cases, a single realm and KDC machine are used to perform the Kerberos authentication and this property is not required.

This property is available for complex setups where a different realm and KDC machine are used to obtain an authentication ticket (AS request) and a service ticket (TGS request).

The Kerberos realm of the service.

string

""

The KerberosServiceRealm is the specify the service Kerberos realm when using cross-realm Kerberos authentication.

In most cases, a single realm and KDC machine are used to perform the Kerberos authentication and this property is not required.

This property is available for complex setups where a different realm and KDC machine are used to obtain an authentication ticket (AS request) and a service ticket (TGS request).

The Service Principal Name for the Kerberos Domain Controller.

string

""

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, set the Service Principal Name here.

The full file path to an MIT Kerberos credential cache file.

string

""

This property can be set if you wish to use a credential cache file that was created using the MIT Kerberos Ticket Manager or kinit command.

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

string

""

The path to a directory which contains the schema files for the adapter (.rsd files for tables and views, .rsb files for stored procedures). The Location property is only needed if you would like to customize definitions (e.g., change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

The schema files are deployed alongside the adapter assemblies. You must also ensure that Location points to the folder that contains the schema files. The folder location can be a relative path from the location of the executable.

Core modules to be included in the log file.

string

""

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

Limits 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.

string

"-1"

Limits 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.

The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.

bool

false

The server normally times out idle cursors after an inactivity period (10 minutes) to prevent excess memory use. Set this option to prevent that.

The other parameters necessary to connect to a data source, such as username and password, when applicable.

string

""

The Other property is a semicolon-separated list of name-value pairs used in connection parameters specific to a data source.

The maximum number of results to return per page from MongoDB.

int

4096

The Pagesize property affects the maximum number of results to return per page from MongoDB. Setting a higher value may result in better performance at the cost of additional memory eaten up per page consumed.

The password used to authenticate with MongoDB.

string

""

The password used to authenticate with MongoDB.

The port for the MongoDB database.

string

"27017"

The port for the MongoDB database.

This option passes the query to MongoDB as-is.

bool

false

When set to 'True', the specified query will be passed to MongoDB as-is. The supported query syntax are the Mongo Shell Methods. Currently only the 'db.collection.find()' method is supported. Thus the same query that you would enter in a Mongo Shell can be issued here when QueryPassthrough is set to 'True'.

Note that you can use the EVAL stored procedure to execute other JavaScript functions.

You can use this property to enforce read-only access to MongoDB from the provider.

bool

false

If this property is set to true, the adapter will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.

Set this to a strategy for reading from a replica set. Accepted values are primary, primaryPreferred, secondary, secondaryPreferred, and nearest.

string

""

This property enables you to execute queries to a member in a replica set other other than the primary member. Accepted values are the following:

primary: All SELECT queries are executed against the primary server.

primaryPreferred: If the primary server is not available, SELECT queries are executed to a secondary server.

secondary: All SELECT queries are executed to the secondary servers.

secondaryPreferred: SELECT queries are executed to a secondary server if one is available. Otherwise, the queries are executed to the primary server.

nearest: SELECT queries are executed to the server with the least latency.

When this property is set, query results may not reflect the latest changes if a write operation has not yet been replicated to a secondary machine. You can use ReadPreference to accomplish the following, with some risk that the adapter will return stale data:

Configure failover queries: If the primary server is unavailable, you can set this property to "primaryPreferred" to continue to execute queries online.

Execute faster queries to geographically distributed replica sets: If your deployment uses multiple data centers, setting ReadPreference to "nearest" can result in faster queries, as the adapter executes SELECT queries to whichever replica set member has the lowest latency.

When directing the adapter to execute SELECT statements to a secondary server, SlaveOK must also be set. Otherwise, the adapter will return an error response.

This 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.

string

""

To work with a replica set, you must specify all servers in the replica set in this property and Server and Port. Specify both a server name and port; separate servers with a comma. For example:

To find the primary the adapter queries the servers in ReplicaSet and the server specified by Server and Port.

Note that only the primary in a replica set is writable. Secondaries can be readable if the SlaveOK setting allows it. To configure a strategy executing SELECT queries to secondaries, see ReadPreference.

The maximum number of rows to scan to look for the columns available in a table. Set this property to gain more control over how the provider applies data types to collections.

string

"100"

Since MongoDB is schemaless, the columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned. The default value is 100.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

The host name or IP address of the server hosting the MongoDB database.

string

""

The host name or IP address of the server hosting the MongoDB database.

This property sets whether the provider is allowed to read from secondary (slave) servers.

bool

false

This property sets whether the adapter is allowed to read from secondary (slave) servers in a replica set. You can fine-tune how the adapter queries secondary servers with ReadPreference.

The authentication method to be used to log on to an SFTP server.

string

"Password"

A certificate to be used for authenticating the user.

string

""

In order to use public key authentication, SSHClientCert must contain a certificate with a valid private key. The certificate's public key value is sent to the server along with a signature produced using the private key. The server will first check to see if the public key values match what is known for the user and then will attempt to use those values to verify the signature.

The password of the SSHClientCert certificate if it has one.

string

""

This property is only used when authenticating to SFTP servers with SSHAuthMode set to PublicKey and SSHClientCert set to a private key.

The subject of the SSH client certificate.

string

"*"

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@cdata.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

The type of SSHClientCert certificate.

string

"PUBLIC_KEY_FILE"

The type of SSHClientCert certificate. This property can take one of the following values:

The SSH password.

string

""

The SSH password.

The SSH port.

string

"22"

The SSH port.

The SSH server.

string

""

The SSH server.

The SSH server fingerprint.

string

""

The SSH server fingerprint.

The SSH user.

string

""

The SSH user.

The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).

string

""

The name of the certificate store for the client certificate.

The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.

SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. Please refer to the SSLClientCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

 

 

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

The password for the TLS/SSL client certificate.

string

""

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

The subject of the TLS/SSL client certificate.

string

"*"

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@cdata.com". Common fields and their meanings are displayed below.

 

 

If a field value contains a comma it must be quoted.

The type of key store containing the TLS/SSL client certificate.

string

""

This property can take one of the following values:

 

 

The certificate to be accepted from the server when connecting using TLS/SSL.

string

""

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine will be rejected.

This property can take the forms:

 

 

If not specified, any certificate trusted by the machine will be accepted. Use '*' to signify to accept all certificates (not recommended for security concerns).

The value in seconds until the timeout error is thrown, canceling the operation.

string

"60"

If the Timeout property is set to 0, operations do not time out: They run until they complete successfully or encounter an error condition.

If Timeout expires and the operation is not yet complete, the adapter throws an exception.

Comma-separated options for how the provider will scan the data to determine the fields and datatypes in each document collection.

string

"RowScan,Recent"

Execute MongoDB queries using db.collection.find().

string

"False"

Amazon DocumentDB doesn't support the legacy OP_QUERY interface, so this must be set to True to query DocumentDB clusters with db.collection.find() instead.

The username used to authenticate with MongoDB.

string

""

The username used to authenticate with MongoDB.

Use SSH.

bool

false

Use SSH.

This field sets whether SSL is enabled.

bool

false

This field sets whether the adapter will attempt to negotiate TLS/SSL connections to the server. By default, the adapter checks the server's certificate against the system's trusted certificate store. To specify another certificate, set SSLServerCert.