Purpose

Specifies the string of characters that replace leading underscores used in identifiers for documents and arrays.

Valid Values

string

where:

string

is comprised of any Unicode character or group of characters, including spaces.

Example

MongoDB collections automatically include the _id field. By specifying LeadingUnderscoreReplacement=XX, the _id field becomes the XXID column in the relational view of the data. In addition, any other fields with a leading underscore would be modified in the same manner.

Notes

  • The setting for this property is written to the configuration file when generating the schema map. If you attempt a subsequent connection using the configuration file and specify a different value for this property, the driver will return an error.

Data Source Methods

public String getLeadingUnderscoreReplacement()

public void setLeadingUnderscoreReplacement(String)

Default Value

None. When no value is specified, a leading underscore is used in identifiers.

Data Type

String