Docs Menu
Docs Home
/
BI Connector
/
Install or Update BI Connector

Install BI Connector on Windows

On this page

  • Prerequisites
  • MongoDB User Permissions
  • Install the BI Connector

Note

The MongoDB Connector for BI and associated utilities are compatible with all currently supported MongoDB server versions.

To set up MongoDB Connector for BI with a business intelligence tool such as Tableau, follow the steps on this page.

Prerequisites

MongoDB User Permissions

If your MongoDB instance uses authentication, your BI Connector instance must also use authentication. The user that connects to MongoDB via the mongosqld program must have permission to read from all the namespaces you wish to sample data from.

For more details about MongoDB user permissions in BI Connector, see User Permissions for Cached Sampling.

Install the BI Connector

1

Download the MongoDB Connector for BI.

Download the BI Connector from the MongoDB Download Center.

2

Verify the integrity of the downloaded package.

The MongoDB release team digitally signs all software packages to certify that a particular MongoDB package is a valid and unaltered MongoDB release. Complete the following steps to verify the MongoDB binary against its SHA256 key:

  1. Download the .sha256 file for Windows x64 from BI Connector Downloads page.

  2. Compare the signature file to the MongoDB installer hash using the following Powershell script:

    $sigHash = (Get-Content $Env:HomePath\Downloads\mongodb-bi-win32-x86_64-{version}.msi.sha256 | Out-String).SubString(0,64).ToUpper(); `
    $fileHash = (Get-FileHash $Env:HomePath\Downloads\mongodb-bi-win32-x86_64-{version}.msi).Hash.Trim(); `
    echo $sigHash; echo $fileHash; `
    $sigHash -eq $fileHash

    The command outputs three lines:

    • A SHA256 hash that you downloaded directly from MongoDB.

    • A SHA256 hash computed from the MongoDB binary you downloaded from MongoDB.

    • A True or False result depending if the hashes match.

    If the hashes match, the MongoDB binary is verified.

3

Install the MongoDB Connector for BI.

  1. Run the downloaded .msi file.

  2. Follow the wizard instructions to install the files. The binaries install into a bin directory inside the installation directory.

    If a prior version exists, you might need to configure your system services to launch the new installation. You can delete the old binaries.

New in version 2.9.

To help you get started, a sample mongosqld configuration file named example-mongosqld-config.yml is included with the installation package. To learn how to start BI Connector with a configuration file, refer to the mongosqld documentation section on the Configuration File.

Launch the BI Connector

You are now ready to launch the BI Connector. The following guide contains detailed information on BI Connector configuration, schema generation, and launch options: