Connect to Spotify Data in DBeaver
NOTE: The Legacy ODBC driver was removed in DBeaver Community Edition 23.1. As an alternative, you can use a CData JDBC Driver (learn how here: How to Connect DBeaver to Spotify via JDBC). If you need to use ODBC Drivers, refer to the DBeaver Documentation.
The CData API Driver for ODBC enables access to live data from Spotify under the ODBC standard, allowing you work with Spotify data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage Spotify data with visual tools in DBeaver like the query browser.
The CData ODBC drivers offer unmatched performance for interacting with live Spotify data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver 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 manage and analyze Spotify data.
Connect to Spotify
If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.
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
- Visit the Spotify Developer Dashboard.
- Log in with your Spotify account and click Create app.
- Provide an app name, description, and set a Redirect URI (e.g.,
http://localhost:33333
for desktop applications). - 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.
Finally, set the "Map To WVarchar connection property to False in the DSN Configuration window for the driver. This configuration will allow string types to be mapped to SQL_VARCHAR and prevent SQL_WVARCHAR types from being displayed as NULL.
Connecting to the Spotify ODBC Data Source in DBeaver
- Open the DBeaver application and in the Database menu, select the New Database Connection option.
- In the 'Connect to a database' window, select ODBC and click Next.
- In the Database/Schema field, enter the DSN name (CData Spotify Source by default). It will be automatically added to the JDBC URL as well.
- Click the Test Connection button. You should receive a 'Connected' message after DBeaver has detected the DSN, along with details about the driver if the connection is successful.
Query Spotify Data
You can now query information from the tables exposed by the data source connection. You can expand the database structure in order to view all the tables. You can retrieve the table's data by right-clicking on a table name and selecting View data. The data will then be available in the Data tab.
Free Trial & More Information
At this point, you have connected to live Spotify data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live Spotify data DBeaver today.