Use the CData JDBC Driver for Spotify in MicroStrategy Desktop

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Spotify data in MicroStrategy Desktop using the CData JDBC Driver for Spotify.

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy with the CData JDBC Driver for Spotify, you gain database-like access to live Spotify data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through adding Spotify as a data source in MicroStrategy Desktop and creating a simple visualization of Spotify data.

The CData JDBC Driver offers unmatched performance for interacting with live Spotify data in MicroStrategy due to optimized data processing built into the driver. When you issue complex SQL queries from MicroStrategy to Spotify, the driver pushes supported SQL operations, like filters and aggregations, directly to Spotify and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can use native MicroStrategy data types to visualize and analyze Spotify data.

Connect to and Visualize Spotify Data using MicroStrategy Desktop

In addition to connecting to Spotify in MicroStrategy enterprise products, you can connect to Spotify in MicroStrategy Desktop. Follow the steps below to add Spotify data as a dataset using JDBC and create visualizations and reports of Spotify data.

  1. Open MicroStrategy Desktop and create a new dossier.
  2. In the datasets panel, click New Data, select Databases, and choose Select a Table as the Import Option.
  3. Add a new data source and choose the DSN-less data sources option.
  4. Choose Generic in the Database menu and Generic DBMS in the Version menu.
  5. Click the link to show the connection string and opt to edit the connection string. In the Driver menu, select MicroStrategy Cassandra ODBC Driver. (MicroStrategy requires a certified driver to interface through JDBC; the actual driver will not be used.)
  6. Set the connection string as follows and click OK:
    • Add the JDBC keyword to the connection string.
    • Set MSTR_JDBC_JAR_FOLDER to the path of the JAR file for the JDBC driver. (C:\Program Files\CData JDBC Driver for Spotify\lib\ on Windows.)
    • Set DRIVER to cdata.jdbc.api.APIDriver, the driver class.
    • Set URL to the JDBC URL for the Spotify driver, setting the necessary connection properties.

      Using OAuth Authentication

      Spotify uses OAuth 2.0 for authentication. You will need to create an application in the Spotify Developer Dashboard to obtain your client credentials.

      Setting Up Your Spotify Application

      1. Visit the Spotify Developer Dashboard.
      2. Log in with your Spotify account and click Create app.
      3. Provide an app name, description, and set a Redirect URI (e.g.,
        http://localhost:33333
        for desktop applications).
      4. Copy your Client ID and Client Secret from the app settings.

      Connection Properties

      After setting the following connection properties, you are ready to connect:

      • AuthScheme: Set this to OAuth.
      • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
      • OAuthClientId: Set this to your Spotify application's Client ID.
      • OAuthClientSecret: Set this to your Spotify application's Client Secret.
      • Scope: Set this to the required OAuth scopes (space-separated). The default includes all read scopes needed for the tables in this profile.
      • CallbackURL: Set this to the Redirect URI configured in your Spotify application (e.g., http://localhost:33333).

      Example Connection String

      Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;
      

      Available OAuth Scopes

      • user-read-private: Read access to user's subscription details and explicit content settings.
      • user-read-email: Read access to user's email address.
      • user-library-read: Read access to a user's saved tracks, albums, episodes, shows, and audiobooks.
      • playlist-read-private: Read access to user's private playlists.
      • playlist-read-collaborative: Read access to collaborative playlists the user follows.
      • user-follow-read: Read access to the list of artists the current user follows.
      • user-read-playback-state: Read access to a user's player state (device, current track, progress).
      • user-read-currently-playing: Read access to a user's currently playing content.
      • user-read-playback-history: Read access to a user's recently played tracks.
      • user-top-read: Read access to a user's top artists and tracks.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Spotify JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.api.jar
      

      Fill in the connection properties and copy the connection string to the clipboard.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

    A typical connection string follows:

    JDBC;MSTR_JDBC_JAR_FOLDER=PATH\TO\JAR\;DRIVER=cdata.jdbc.api.APIDriver;URL={jdbc:api:Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;};
    
  7. Right-click on the new data source, and choose Edit catalog options.
  8. Edit the SQL Statement to SELECT * FROM SYS_SCHEMAS to read the metadata from the JDBC Driver.
  9. Select the new data source to view the available tables. You may need to manually click the search icon in the Available Tables section to see the tables.
  10. Drag tables into the pane to import them. Note: Since we create a live connection, we can import whole tables and utilize the filtering and aggregation features native to the MicroStrategy products.
  11. Click Finish and choose the option to connect Live. Live connections are possible and effective, thanks to the high-performance data processing native to CData JDBC Drivers.
  12. Choose a visualization, choose fields to display, and apply any filters to create a new visualization of Spotify data. Data types are discovered automatically through dynamic metadata discovery. Where possible, the complex queries generated by the filters and aggregations will be pushed down to Spotify, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed client-side by the CData SQL engine embedded in the driver.
  13. Once you are finished configuring the dossier, click File -> Save.

Using the CData JDBC Driver for Spotify in MicroStrategy Desktop, you can easily create robust visualizations and reports on Spotify data. Read our other articles for connecting to Spotify data in MicroStrategy Developer and connecting to Spotify data in MicroStrategy Web for more examples.

Ready to get started?

Connect to live data from Spotify with the API Driver

Connect to Spotify