Use the CData ODBC Driver for Spotify in MicroStrategy

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy with the CData ODBC 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 creating a database instance for Spotify in MicroStrategy Developer and creating a Warehouse Catalog based on Spotify data.

The CData ODBC 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 visualize and analyze Spotify data using native MicroStrategy data types.

Connect to Spotify as an ODBC Data Source

Information for connecting to Spotify follows, along with different instructions for configuring a DSN in Windows and Linux environments (the ODBC Driver for Spotify must be installed on the machine hosting the connected MicroStrategy Intelligence Server).

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.

When you configure the DSN, 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.

Windows

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Linux

If you are installing the CData ODBC Driver for Spotify in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData API Sys]
Driver = CData ODBC Driver for Spotify
Description = My Description
Profile = C:\profiles\Spotify.apip
AuthScheme = OAuth
InitiateOAuth = GETANDREFRESH
OAuthClientId = your_client_id
OAuthClientSecret = your_client_secret
CallbackURL = http://localhost:33333

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Create a Spotify Database Instance in MicroStrategy Developer

You can connect to Spotify in MicroStrategy Developer by adding a database instance based on the CData ODBC Driver for Spotify.^*

1. Open MicroStrategy Developer and select a Project Source.
2. Navigate to Administration -> Configuration Managers -> Database Instances and right-click to add a new instance.
3. Name the instance, select Generic DBMS as the database connection type, and create a new database connection.
4. In the database connection wizard, name the connection and create a new Database Login name, using filler values for the user and password.
5. Select the DSN that you configured earlier as the ODBC data source (i.e., CData API Sys).
6. Select the newly created database connection.

7. In the Project Source, right-click the project and open the Project configuration.
8. Navigate to Database Instances and select the newly created database instance.
9. Close MicroStrategy Developer and restart the connected MicroStrategy Intelligence Server to complete the database instance creation.

With the database instance configured, you will now be able to connect to Spotify data from the Warehouse Catalog and Data Import.

Connect to Spotify Data from the Warehouse Catalog

Once you have created a database instance based on the ODBC Driver for Spotify, you can connect to data from the Warehouse Catalog.

1. Select your project and click Schema -> Warehouse Catalog.
2. In the Read Settings for the Catalog, click Settings and set the queries to retrieve the schema:
   • To retrieve the list of tables, use the following query:

     SELECT 
       CatalogName NAME_SPACE,
       TableName TAB_NAME 
     FROM 
       SYS_TABLES
             

   • To retrieve the list of columns for selected tables, use the following query:

     SELECT DISTINCT 
       CatalogName NAME_SPACE, 
       TableName TAB_NAME, 
       ColumnName COL_NAME, 
       DataTypeName DATA_TYPE, 
       Length DATA_LEN, 
       NumericPrecision DATA_PREC, 
       NumericScale DATA_SCALE 
     FROM 
       SYS_TABLECOLUMNS 
     WHERE 
       TableName IN (#TABLE_LIST#) 
     ORDER BY
       1,2,3
             

   
3. Select tables to be used in the project.

If you are interested in connecting to Spotify from other MicroStrategy products, you can read about connecting from MicroStrategy Web and connecting from MicroStrategy Desktop.

Note: connecting using a ODBC driver requires a 3- or 4-tier architecture.