Launch BI Connector¶
mongosqld is the BI Connector program which connects
your MongoDB instance to your BI tool.
requires a data schema which maps to your MongoDB collections and
databases. You have several options for creating a schema and
mongosqld. This guide will help you choose
the best option for your needs.
mongosqld generates a data schema and holds it in memory. Alternatively, if
you prefer to create a schema file and edit it manually, use the
mongodrdl program to create a
file and use the
mongosqld. For more information on schema
generation and data sampling, see Map Relational Schemas to MongoDB.
- Install BI Connector
There are three options for launching and running
mongosqld. You can:
mongosqldas a hosted service with MongoDB Atlas
mongosqldfrom the command line
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 connect to an Atlas-hosted BI Connector, see Connect via BI Connector for Atlas.
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.
mongosqld from the command line, run the
mongosqld executable in the BI Connector program directory with any
necessary command line options.
The following example uses the
--sampleNamespaces option to specify the
books collection in the
"C:\Program Files\MongoDB\Connector for BI\2.4\bin\mongosqld.exe" --sampleNamespaces test.books
mongosqld with a Configuration File¶
"C:\Program Files\MongoDB\Connector for BI\2.4\bin\mongosqld.exe" --config <pathToConfigFile>\mongosqld.conf
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:
systemLog: path: 'C:\logs\mongosqld.log' net: bindIp: '127.0.0.1' port: 3307
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
"C:\Program Files\MongoDB\Connector for BI\2.4\bin\mongosqld.exe" install --config "<pathToConfigFile>\mongosqld.conf" net start mongosql
mongosql service installed if your installation
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.