Use the CData API Server in Microsoft Power BI

The CData API Server enables you to use REST, OData, JSON, or Open APIs to connect to and query Databricks data. The OData standard enables real-time access to the live data, and support for OData is integrated into Power BI. This article details how to import an OData feed of Databricks data into Microsoft Power BI.

Getting Started

---

Set Up the API Server

If you have not already done so, download the CData API Server. Once you have installed the API Server, follow the steps below to begin producing secure Databricks OData services:

Connect to Databricks

To work with Databricks data from Microsoft Power BI, we start by creating and configuring a Databricks connection. Follow the steps below to configure the API Server to connect to Databricks data:

1. First, navigate to the Connections page.
2. Click Add Connection and then search for and select the Databricks connection. 👁 Selecting a data source (SQLite is shown)
   
3. Enter the necessary authentication properties to connect to Databricks. 👁 Connecting to a datasource (SQLite is shown)
   
4. After configuring the connection, click Save & Test to confirm a successful connection.

Configure API Server Users

Next, create a user to access your Databricks data through the API Server. You can add and configure users on the Users page. Follow the steps below to configure and create a user:

1. On the Users page, click Add User to open the Add User dialog.
2. Next, set the Role, Username, and Privileges properties and then click Add User. 👁 Configure a new user
   
3. An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page: 👁 API Server user settings
   

Creating API Endpoints for Databricks

Having created a user, you are ready to create API endpoints for the Databricks tables:

1. First, navigate to the API page and then click Add Table . 👁 Add tables
   
2. Select the connection you wish to access and click Next. 👁 Select the connection (SQLite is shown)
   
3. With the connection selected, create endpoints by selecting each table and then clicking Confirm. 👁 Adding tables from the connection (SQLite is shown)
   

Gather the OData Url

Having configured a connection to Databricks data, created a user, and added resources to the API Server, you now have an easily accessible REST API based on the OData protocol for those resources. From the API page in API Server, you can view and copy the API Endpoints for the API:

👁 API Endpoints

Connect to Databricks Data from Power BI Desktop

1. Open Power BI Desktop and click Get Data -> OData feed. 👁 Starting the OData connection
   
2. In the OData feed connection, set the URL property to the OData Endpoint URL previously copied and click OK (e.g. "http://localhost:8080/api.rsc"): 👁 The URL of the OData endpoint for API Server
   
3. In the next step of the wizard, define the authentication credentials. Select Basic and then enter the credentials for a user authorized to make requests. Specify the User name and enter the user's authtoken in the Password field: 👁 Authenticating with API Server
   
4. Select the tables that you would like to import into Power BI and click Load 👁 Selecting tables (SQLite is shown)
   

Create Data Visualizations

After pulling the data into Power BI, you can create data visualizations in the Report view. Follow the steps below to create a pie chart:

1. Select the pie chart icon in the Visualizations pane.
2. Select a dimension in the Fields pane: for example, Genre Name.
3. Select a measure in the Fields pane: for example, GenreId.

👁 A pie chart showing the Count of Tracks by Genre (SQLite is shown)

You can change sort options by clicking the ellipsis (...) button for the chart. Options to select the sort column and change the sort order are displayed.

You can use both highlighting and filtering to focus on data. Filtering removes unfocused data from visualizations; highlighting dims unfocused data. You can highlight fields by clicking them: 👁 A highlighted genre in a pie chart (SQLite is shown)

You can apply filters at the page level, at the report level, or to a single visualization by dragging fields onto the Filters pane. To filter on the field's value, select one of the values that are displayed in the Filters pane.

👁 Filtered pie chart (SQLite is shown)

Click Refresh to synchronize your report with any changes to the data.

Free Trial & More Information

If you are interested in connecting to your Databricks data (or data from any of our other supported data sources) from Microsoft Power BI, download API Server to begin creating flexible and customizable REST, OData, JSON and Open APIs from any database or data store! As always, our world-class support team is ready to answer any questions you may have.