Deploy a BI Connector¶

On this page

Prerequisites
Procedure

The MongoDB Connector for Business Intelligence allows you to query a MongoDB database using SQL commands to aid in data analysis. It translates SQL queries from data analysis tools to MongoDB aggregation pipelines on MongoDB database.

Note

The BI Connector only allows read-only operations on data served in MongoDB databases. To create, update, or delete data you must use mongosh or any appropriate driver.

Prerequisites¶

MongoDB BI Connector for Cloud Manager is not compatible with x.509 authentication.

BI Connector deployment is only available to users of Cloud Manager Premium. See Cloud Manager Features and Pricing for information about upgrading to Cloud Manager Premium.

To deploy MongoDB clusters, you must provision hosts to serve those clusters. Cloud Manager requires access to these hosts.

Important

If you run MongoDB Enterprise and provision your own Linux hosts, then you must manually install a set of dependencies to each server before installing MongoDB. The MongoDB manual provides the appropriate command to install the dependencies.

To learn more about the specifics for an operating system, see the following:

Procedure¶

1

Navigate to the Processes tab for your deployment.¶

If it is not already displayed, select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.
If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
Click Processes in the sidebar.

2

Choose New BI Connector.¶

Click the Add New dropdown menu.
Click New BI Connector.

3

Configure the BI Connector instance.¶

In the New BI Connector modal, configure the following settings:

Choose Server	Select the host where this new BI Connector is installed.
Deployment Item	Select the deployment item (standalone, replica set, or sharded cluster) to which this new BI connector connects.
Port to Listen On	Type the IANA port number you want to use when connecting to this new BI Connector. The recommended port number is `3306`.
Read Preference	Select how the BI connector routes read operations to the members of a replica set. Available values include: `Primary` `Primary Preferred` `Secondary Only` `Secondary Preferred` `Nearest`
Included Namespace(s) (Optional)	Type the name of a database and/or collection to limit what data the BI Connector can access. Leave this box blank to allow the BI Connector to use all namespaces on the host. Click the + add another namespace link to add another namespace to your list of included namespaces.

4

Set any Additional settings for the BI Connector instance.¶

TLS (Optional)¶

If you need to use TLS to connect with the Deployment Item, configure these settings:

TLs Mode	Select Disabled, Allow TLS, or Require TLS.
TLS PEM Key File Path	Type the path on the MongoDB host where the TLS PEM key file is stored.
TLS PEM Key Password (Optional)	If you encrypted the PEM file, type its password.
Minimum TLS Version	Select the minimum TLS version to connect to the BI Connector. Default value is `TLS1_0`. Accepted values are `TLS1_0`, `TLS1_1`, and `TLS1_2`. To learn more, see `--minimumTLSVersion` in the MongoDB Connector for BI documentation.
MongoDB Minimum TLS Version	Select the minimum TLS version to connect to MongoDB. Default value is `TLS1_0`. Accepted values are `TLS1_0`, `TLS1_1`, and `TLS1_2`. To learn more, see `--mongo-minimumTLSVersion` in the MongoDB Connector for BI documentation.

Logs (Required)¶

Linux Log File Path	(Conditional: BI Connector is installed on a Linux platform) Type the path to the BI Connector log on that host.
Windows Log File Path	(Conditional: BI Connector is installed on a Windows platform) Type the path to the BI Connector log on that host.
Log Verbosity	Select logging level for the BI Connector. Accepted values are `Lowest`, `Medium`, `Highest`. These values correspond to log verbosity levels of `0`, `1`, and `2`, respectively.
Log Rotation	Toggle to `ON` to enable. Default is `OFF`. If toggled to `ON`, the logs are rotated when the Size Threshold or Time Threshold is met. The next four settings require Log Rotation to be set to `ON`.
Size Threshold (MB)	(Conditional: Log Rotation = `ON` ) Type the size the log file must reach in MB before the BI Connector rotates it automatically. The default value is `1000.0` (about 1 GB).
Time Threshold (Hours)	(Conditional: Log Rotation = `ON` ) Type the duration the log file must cover in hours before the BI Connector rotates it automatically. The default value is `24` hours.
Max Uncompressed Files	(Conditional: Log Rotation = `ON` ) Type how many rotated log files may stay uncompressed in the log directory before they are archived and compressed. (The suggested number is `2`.)
Max Percent of Disk	(Conditional: Log Rotation = `ON` ) Type the percentage of disk space on the host the log files may consume before older files are deleted. (The suggested number is `5`.)

Schema (Optional)¶

Max Length for varChar Fields	Type the maximum number of characters that can exist in a VARCHAR field.
Refresh Interval (Seconds)	Type how much time must elapse in seconds before the BI Connector refreshes the schema. To learn more, see `--schemaRefreshIntervalSecs` in the MongoDB Connector for BI documentation.
Sample Size (# of Documents in Collection)	Type how many MongoDB documents are included in each sample the schema examines. To learn more on how the BI Connector performs sampling, see Cached Sampling. and `--sampleSize` in the MongoDB Connector for BI documentation.
Allow Schema Alterations from SQL Client	Toggle if the user can alter the schema using an SQL client.

4

Click Create.¶

5

Click Review & Deploy to review your changes.¶

6

Click Confirm & Deploy to deploy your changes.¶

Otherwise, click Cancel and you can make additional changes.

← Configure Kubernetes for Deploying MongoDB Resource Connect to a MongoDB Process →

Cloud Manager will no longer support Automation for MongoDB 3.4 clusters after February 10, 2022. Please upgrade your MongoDB deployment or migrate to Atlas.