Couchbase Power BI Connector

      The Couchbase Power BI Connector provides the integration between tabular views of the Couchbase Analytics Service — or your Capella columnar instance — and Microsoft’s Power BI interactive data visualization platform.

      The Couchbase Power BI Connector provides integration between Microsoft’s Power BI interactive data visualization platform and either:

      • Couchbase Analytics Service (CBAS)

        For self-managed CBAS, the Power BI connector requires Couchbase Server 7.2.4 or newer.
      • Tabular views of your Capella columnar collections or query results.

        Capella columnar is currently in private preview.

      Verify Power BI Version

      Before you proceed, verify that you have a supported version of Microsoft Power BI Desktop installed. The Couchbase Power BI Connector requires Power BI Desktop version March 2017 or later.

      If necessary, download Power BI Desktop from the Microsoft downloads page.

      Power BI is only available for the Microsoft Windows platform — for other platforms, consider our Tableau connector.

      Install the Couchbase Power BI Connector

      1. Download couchbase-powerbi-connector-1.0.mez from — see the release notes page for more details.

      2. Follow Microsoft’s guide on configuring a custom connector.

      Verify the Connector is Loaded Successfully:

      1. Open Power BI.

      2. Go to Get Data → More → Couchbase Connector

      The Couchbase Power BI Connector is now correctly configured to work with the Power BI platform.

      Next, you configure a connection to Couchbase Analytics or an instance of the Capella columnar database.

      ODBC and OpenSSL

      The connection between a Couchbase Analytics instance or a Capella columnar database (currently in private preview) and Power BI requires a Couchbase ODBC driver. OpenSSL is a required dependency for the driver.

      Install OpenSSL

      1. Download Win64OpenSSL_Light-1_1_1v.msi from the Shining Light Productions site.

      2. Install OpenSSL from the downloaded file.

      Install the Couchbase ODBC Driver

      1. Download the couchbase-odbc-1.0-win64.msi file from — see the release notes page for more details.

      2. Double-click the file to open the Couchbase ODBC Setup Wizard.

      3. Install the ODBC drivers from the downloaded file. This installation provides both ANSI and Unicode drivers.

      Configure an ODBC Data Source

      You configure a data source name (DSN) for each CBAS scope or Capella columnar database you want to use in Power BI.


      To configure an ODBC DSN, you supply:

      • The connection string for your Capella columnar instance or self-managed CBAS nodes.

      • (For columnar) An API key and secret to use as the DSN username and password. To obtain these values, follow the steps in the columnar private preview docs. After you copy the connection string from the Connection Information dialog, click Generate API Key to access a new key and its secret.

      Configure a User DSN in Power BI

      To configure the Couchbase ODBC driver as a User DSN, follow the instructions to Add an ODBC data source in the Microsoft documentation.

      You can install either Couchbase ODBC Driver (ANSI) or Couchbase Unicode Driver (UNICODE). If the data contains multibyte characters, select Unicode.

      Be careful to use the ODBC Data Source Administrator (64 bit) — there is an ODBC Data Source Administrator (32 bit) available, but this will not work with the connector.

      When the Create data source for Couchbase dialog opens, select Capella Columnar or (for CBAS) Couchbase Analytics and enter values as follows:

      • Couchbase Analytics Service (CBAS)

      • Capella columnar (Preview)

      • Name: Enter an identifying name for the data source.

      • Description: Enter an optional description.

      • Host: Enter the IP address of Data (KV) node in Couchbase cluster.

      • Port: 11207

      • Scope: Name of the scope from which the data is being extracted. If a two part scope — such as travel-sample.inventory — then the two parts must be separated by a / — travel-sample/inventory.

      • SSLMode: require

      • User: You can use the Administrator user set up during installation for testing purposes, but a user restricted to only CBAS permissions — Cluster Admin Role — should be used for deployment.

      • Password: Enter the cluster password.

      • CertificateFile Path: path\\to\\certificateFile.pem

      Note, for non-TLS (not recommended for production) the port number is 8091, the SSLMode field left empty, and a CertificateFile Path is not entered.

      • Name: Enter an identifying name for the data source.

      • Description: Enter an optional description.

      • URL: Enter the connection string in couchbases://<subdomain>.<instance_id>.<instance_region_name> format.

      • Database: Enter the name of a Capella columnar database.

      • User: Enter the generated API key.

      • Password: Enter the secret for the API key.

      Use the Couchbase Power BI Connector

      Business information tools rely on data that is organized into relational databases. To use the Power BI connector, you must create tabular analytics views of your JSON documents. For self-managed CBAS, see the workbench docs or tabular views.

      After you prepare tabular views and define DSNs in Power BI, you use the Couchbase Power BI Connector to load data into Power BI.

      Use the Connector to Add Data to Power BI

      To add data from Capella columnar or CBAS to Power BI, follow the instructions to Connect to data sources in Power BI desktop in the Microsoft documentation.

      Couchbase Connector appears on the Get Data list of data sources. When prompted for Username and Password, supply your Capella columnar or CBAS credentials.

      After you connect, a list of the tabular views in the database specified by the DSN appears. Load a view to use Power BI options.

      An example image of the travel-sample airport_view follows.

      A data visualization in Power BI