DataBind Controls to Spotify Data in Delphi

The CData ODBC driver for Spotify supports the ODBC standard to enable integration of live Spotify data with visual form designers and other rapid development tools in Delphi. The ODBC driver simplifies data access strategies for applications that share a single codebase like Delphi by providing a single API for database development. This article shows how to how to connect to Spotify data and query data from a simple visual component library (VCL) application, as well as from Delphi code.

Create a Connection to Spotify Data

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.

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.

You can then follow the steps below to use the Data Explorer to create a FireDAC connection to Spotify data.

1. In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
2. Right-click the ODBC Data Source node in the Data Explorer.
3. Click Add New Connection.
4. Enter a name for the connection.
5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Spotify.

Create VCL Applications with Connectivity to Spotify Data

Follow the procedure below to start executing queries to Spotify data from a simple VCL application that displays the results of a query in a grid.

1. Drop a TFDConnection component onto the form and set the following properties:

   • ConnectionDefName: Select the FireDAC connection to Spotify data.
   • Connected: Select True from the menu and, in the dialog that appears, enter your credentials.

2. Drop a TFDQuery component onto the form and set the properties below:

   • Connection: Set this property to the TFDConnection component, if this component is not already specified.

   • SQL: Click the button in the SQL property and enter a query. For example:

     SELECT ,  FROM Albums WHERE Id = '4aawyAB9vmqN3uQ7FjRGTy'
     

   • Active: Set this property to true.

3. Drop a TDataSource component onto the form and set the following property:

   • DataSet: In the menu for this property, select the name of the TFDQuery component.

4. Drop a TDBGrid control onto the form and set the following property:

   • DataSource: Select the name of the TDataSource.
5. Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.

Execute Commands to Spotify with FireDAC Components

You can use the TFDConnection and TFQuery components to execute queries to Spotify data. This section provides Spotify data-specific examples of executing queries with the TFQuery component.

Connect to Spotify Data

To connect to the data source, set the Connected property of the TFDConnection component to true. You can set the same properties from code:

FDConnection1.ConnectionDefName := 'myspotify';
FDConnection1.Connected := true;

Create Parameterized Queries

Parameterized resources can improve performance: Preparing statements is costly in system resources and time. The connection must be active and open while a statement is prepared. By default, FireDAC prepares the query to avoid recompiling the same query over and over. To disable statement preparation, set ResourceOptions.DirectExecute to True; for example, when you need to execute a query only once.

Execute a Query

To execute a query that returns a result set, such as a select query, use the Open method. The Open method executes the query, returns the result set, and opens it. The Open method will return an error if the query does not produce a result set.

FDQuery1.Open('select * from Albums where Id = :Id',['4aawyAB9vmqN3uQ7FjRGTy']);

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

• DataBind Controls to Spotify Data in C++Builder
• Viewing Spotify Data in RAD Studio Data Explorer
• Build a Simple VCL Application for Spotify Data