Docs Menu
Docs Home
BI Connector

Launch BI Connector

On this page

  • Overview
  • Prerequisites
  • Launching mongosqld
  • Next Steps

mongosqld is the BI Connector program which connects your MongoDB instance to your BI tool. mongosqld requires a data schema which maps to your MongoDB collections and databases. You have several options for creating a schema and launching mongosqld. This guide will help you choose the best option for your needs.

By default, mongosqld generates a default data schema and stores it in memory. Alternatively, if you prefer to create a custom schema and edit it manually, use one of these two methods:

To learn more about creating a schema and data sampling, see Map Relational Schemas to MongoDB.

There are three options for launching and running mongosqld. You can:

  • Run mongosqld as a hosted service with MongoDB Atlas

  • Start mongosqld from the command line

  • Install mongosqld as a system service

You can host the MongoDB Connector for Business Intelligence in MongoDB Atlas. To learn how to enable and connect to an Atlas-hosted BI Connector, see Connect via BI Connector for Atlas.

You can use command line options to specify collections and databases to sample, user credentials, and other configuration options. For a complete list of command line options, see Command Line Options.

To start mongosqld from the command line, run the mongosqld executable in the BI Connector program directory with any necessary command line options.


mongosqld defaults to port 3307. You can set the port number manually by providing the --addr option with the host address and port.

You can use a configuration file to hold all your mongosqld configuration options. Start mongosqld with the --config option to specify a configuration file.

BI Connector requires a configuration file with the mongosqld.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:

Once BI Connector is up and running, you are ready to begin using it with your preferred BI tool. See Connect BI Tools for a selected list of connection tutorials.

← Install BI Connector on Debian-based Linux