Create a Data Access Object for Bright Data Data using JDBI

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Bright Data integrates connectivity to live Bright Data data in Java applications. By pairing these technologies, you gain simple, programmatic access to Bright Data data. This article explains how to build a basic Data Access Object (DAO) and the accompanying code to read Bright Data data.

Create a DAO for the Bright Data AccountStatus Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyAccountStatusDAO {
  //request specific data from Bright Data (String type is used for simplicity)
  @SqlQuery("SELECT  FROM AccountStatus WHERE  = :")
  String findBy(@Bind("") String );

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Open a Connection to Bright Data

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Bright Data.

Using API Key Authentication

To use the Bright Data API, you need an API key from the Bright Data Control Panel. Navigate to Account Settings > API to generate or retrieve your API key.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Bright Data API key from the Control Panel.

Example connection string:

Profile=C:\profiles\BrightData.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Bright Data 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.

A connection string for Bright Data will typically look like the following:

jdbc:api:Profile=C:\profiles\BrightData.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\BrightData.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"");
MyAccountStatusDAO dao = dbi.open(MyAccountStatusDAO.class);

//do stuff with the DAO

dao.close();

Read Bright Data Data

With the connection open to Bright Data, simply call the previously defined method to retrieve data from the AccountStatus entity in Bright Data.

//disply the result of our 'find' method
String  = dao.findBy("");
System.out.println();

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Bright Data by integrating with the CData JDBC Driver for Bright Data. Download a free trial and work with live Bright Data data in custom Java applications today.