Connect to Bright Data Data in Aqua Data Studio

The CData JDBC Driver for Bright Data integrates Bright Data data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Bright Data data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Bright Data data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Bright Data.
   • Driver Location: Click the Browse button and select the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.api.APIDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     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 typical JDBC URL is below:

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

   

Query Bright Data Data

You can now query the tables exposed.