Docs Home → MongoDB Connector for BI
Launch BI Connector
Overview
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:
Use the
mongodrdlprogram to create a custom.drdlschema file and then startmongosqldwith the--schemaoption to point to this file.If you previously uploaded a custom schema with the
uploadcommand, you must use thename-schemacommand to store the schema internally under the provided custom name. Then you can startmongosqldwith--schemaSource,--schemaMode, and--schemaNameoptions.
To learn more about creating a schema and data sampling, see Map Relational Schemas to MongoDB.
Prerequisites
Install BI Connector
Launching mongosqld
There are three options for launching and running
mongosqld. You can:
Run
mongosqldas a hosted service with MongoDB AtlasStart
mongosqldfrom the command lineInstall
mongosqldas a system service
Run BI Connector as a Hosted Service with MongoDB Atlas
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.
Start mongosqld From the Command Line
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 with a Configuration File
You can use a configuration file to hold all your
mongosqld configuration options. Start mongosqld with the
--config option to specify a
configuration file.
Install mongosqld as a System Service
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:
Next Steps
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.