Navigation

Schema Management Changes in 2.11

The MongoDB Connector for BI version 2.11 release introduces significant improvements to stored schema management. The new stored-schema format is equivalent to DRDL files. These improvements are incompatible with BI Connector configurations from versions 2.10 and earlier. If you are running BI Connector 2.10 or earlier, use the following sections to update your configuration to be compatible with version 2.11 or later.

If you are already running version 2.11 or later, no further configuration changes are required. To learn more about the different schema management configurations introduced in version 2.11, see the Sampling Mode Reference Chart.

Standalone Reader Changes

Use the following table to modify your BI Connector version 2.10 or earlier Standalone Reader configuration to be compatible with version 2.11 and later:

  Version 2.10 and Earlier Version 2.11 and Later
Mode Standalone Reader Standalone Reader
Behavior mongosqld samples data upon startup and holds the schema in memory. mongosqld samples data upon startup and holds the schema in memory.
Options
  • --sampleMode read
  • --sampleSource not used

To learn more about version 2.10’s schema options, see the 2.10 documentation.

None. The --sampleMode option is deprecated in version 2.11. Remove this command line option or configuration file setting to continue using standalone mode.

Any other standalone mode configurations that worked in earlier releases will continue to work with version 2.11 and later.

Example

The following example launches BI Connector versions 2.10 and earlier in Standalone Reader mode:

mongosqld --sampleMode read

The following example launches BI Connector versions 2.11 and later in Standalone Reader mode:

mongosqld

To learn more about sampling modes, see the Sampling Mode Reference Chart.

Clustered-Reader Mode to Custom Mode

Use the following table to modify your BI Connector version 2.10 or earlier Clustered-Reader configuration to be compatible with the version 2.11 and later:

  Version 2.10 and Earlier Version 2.11 and Later
Mode Clustered-Reader Mode Custom Mode
Behavior The BI Connector does not sample the schema and uses the MongoDB schema stored in the --sampleSource database to build its relational schema. The BI Connector does not sample the schema and uses the DRDL schema from the --schemaSource database.
Options
  • --sampleMode read
  • --sampleSource <dbName>

To learn more about version 2.10’s schema options, see the 2.10 documentation.

Example

The following example launches BI Connector versions 2.10 and earlier in Clustered-Reader mode:

mongosqld --sampleMode read \
          --sampleSource schemaDb

The following example launches BI Connector versions 2.11 and later in Custom mode:

mongosqld --schemaMode custom \
          --schemaSource schemaDb

To learn more about sampling modes, see the Sampling Mode Reference Chart.

Clustered-Writer Mode to Auto Mode

Use the following table to modify your BI Connector version 2.10 or earlier Clustered-Writer configuration to be compatible with version 2.11 and later:

  Version 2.10 and Earlier Version 2.11 and Later
Mode Clustered-Writer Mode Auto Mode
Behavior The BI Connector obtains its schema by sampling, and persists information about the schema to the --sampleSource database. The BI Connector obtains its schema by sampling and persists each sampled schema to the --schemaSource database in the DRDL format.
Options
  • --sampleMode write
  • --sampleSource <dbName>

To learn more about version 2.10’s schema options, see the 2.10 documentation.

Example

The following example launches BI Connector versions 2.10 and earlier in Clustered-Writer mode:

mongosqld --sampleMode write \
          --sampleSource schemaDb

The following example launches BI Connector versions 2.11 and later in Auto mode:

mongosqld --schemaMode auto \
          --schemaSource schemaDb

To learn more about sampling modes, see the Sampling Mode Reference Chart.

Deprecations

The --sampleRefreshIntervalSecs flag and its corresponding config file setting schema.sample.refreshIntervalSecs were deprecated in favor of --schemaRefreshIntervalSecs and schema.refreshIntervalSecs. The old command line option and configuration file setting will continue to work in the 2.11 release, but switching to the new command line option or configuration file setting is recommended.