Navigation
This version of the documentation is archived and no longer supported.

Install BI Connector on Windows

Note

The MongoDB Connector for BI and associated utilities are compatible only with MongoDB server version 3.2 or greater.

To set up MongoDB Connector for BI with a business intelligence tool such as Tableau, follow the steps on this page.

Prerequisites

Install the BI Connector

1

Download the MongoDB Connector for BI.

Download the BI Connector from the MongoDB Download Center.

2

Install the MongoDB Connector for BI.

  1. Run the downloaded .msi file.
  2. Follow the wizard to install the files. The binaries install into a bin directory inside the installation directory.
3

Generate your schema definition file. (Optional)

Changed in version 2.3.

Though you do not need to create a .drdl schema file to use BI Connector, you can if it meets your use case. To review the use cases, see Map Relational Schemas to MongoDB.

If you wish to create a schema file, use the mongodrdl command.

Authentication not enabled:

"C:\Program Files\MongoDB\Connector for BI\2.2\bin\mongodrdl.exe" --host <your.mongohost.com> `
            --db <dbname> `
            [--collection collname] `
            --out schema.drdl

Authentication enabled:

"C:\Program Files\MongoDB\Connector for BI\2.2\bin\mongodrdl.exe" --host <your.mongohost.com> `
            --db <dbname> `
            [--collection collname] `
            --out schema.drdl  `
            --username <username> `
            --password <password> `
            --authenticationDatabase <dbname>

Note

The --host option only accepts a hostname. You cannot provide a MongoDB connection string.

You can examine the generated schema.drdl file in a text editor and remove any fields or tables that are not part of your intended schema.

For more information, see mongodrdl.

4

Start mongosqld.

You can either launch mongosqld manually from the command line or configure it as a system service to run on startup. Depending on your use case and deployment, start mongosqld using only one of the following methods:

Start mongosqld manually:

Using Command Line Options
"C:\Program Files\MongoDB\Connector for BI\2.2\bin\mongosqld.exe"

For the list of command line options, see Command Line Options.

Using a Configuration File

Using your preferred text editor, create a mongosqld.conf file. To review the configuration file options, see Configuration File.

"C:\Program Files\MongoDB\Connector for BI\2.2\bin\mongosqld.exe" --config <pathToConfigFile>\mongosqld.conf

Note

All the file paths in your configuration file must be absolute and wrapped in single quotes. For example:

systemLog:
  path: 'C:\logs\mongosqld.log'

Start mongosqld as a system service:

The BI Connector requires a configuration file with the systemLog.path setting specified when running as a system service. Using your preferred text editor, create a mongosqld.conf file. To review the configuration file options, see Configuration File. For example:

systemLog:
  path: 'C:\logs\mongosqld.log'
net:
  bindIp: "127.0.0.1"
  port: 3307

Note

All the file paths in your configuration file must be absolute and wrapped in single quotes. For example:

systemLog:
  path: 'C:\logs\mongosqld.log'

To install and run mongosqld as a system service, run the following commands:

"C:\Program Files\MongoDB\Connector for BI\2.2\bin\mongosqld.exe" install --config <pathToConfigFile>\mongosqld.conf
net start mongosql

Windows returns mongosql service installed if your installation succeeded.

5

Install the Authentication Plugin

If using authentication without SSL, install the C Authentication Plugin as described in Install the C Authentication Plugin.

6

Connect to the BI Connector

Launch your business intelligence tool, and connect to the BI Connector using a MySQL driver and the following settings:

Host The hostname of the server on which you installed the BI Connector.
Port 3307 by default.

For more details on connecting to the BI Connector, see Connect BI Tools.