Launch BI Connector¶
On this page
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.
Prerequisites¶
- Install BI Connector
- Install the
authentication plugin (optional, for use with
auth enabled
BI Connector)
Launching mongosqld
¶
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
Run BI Connector via MongoDB Atlas¶
A cloud-hosted MongoDB Connector for BI is now available in MongoDB Atlas. For more information on connecting to an Atlas-hosted BI Connector, see Connect via Atlas BI Connector.
mongosqld
with Command Line Options¶
- Windows
- macOS
- Ubuntu/Debian
- RHEL/CentOS/SLES/AMZ
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.
By default, 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 .drdl
schema
file and run mongosqld
with the --schema
option.
For more information about .drdl
files and the
mongodrdl
program, see the reference page.
The following example uses the --sampleNamespaces
option to specify the books
collection in the
test
database.
The following example uses the --sampleNamespaces
option to specify the books
collection in the
test
database.
The following example uses the --sampleNamespaces
option to specify the books
collection in the
test
database.
The following example uses the --sampleNamespaces
option to specify the books
collection in the
test
database.
mongosqld
with a Configuration File¶
- Windows
- macOS
- Ubuntu/Debian
- RHEL/CentOS/SLES/AMZ
You can use a configuration file to hold all your
mongosqld
configuration options. Start mongosqld
with the
--config
option to specify a
configuration file.
mongosqld
as a System Service¶
- Windows
- macOS
- Ubuntu/Debian
- RHEL/CentOS/SLES/AMZ
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:
Note
All the file paths in your configuration file must be absolute and wrapped in single quotes. For example:
To install and run mongosqld
as a system service, run the
following commands:
Windows returns mongosql service installed
if your installation
succeeded.
To install and run mongosqld
as a system service, run the
following commands:
Debian 7.x (Wheezy)
To enable the service so it starts automatically at boot time, run the following:
Debian 8.1 (Jessie) and Ubuntu 14.04 (Trusty)
To enable the service so it starts automatically at boot time, run the following:
RHEL 6.x / CentOS 6.x and SUSE 11
To enable the service so it starts automatically at boot time, run the following:
RHEL 7.x / CentOS 7.x and SUSE 12
To enable the service so it starts automatically at boot time, run the following:
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.