Build a PostgreSQL Interface for Bright Data Data using the CData JDBC Driver

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use the Remoting features of the Bright Data JDBC Driver to create a PostgreSQL entry-point for data access.

There are a vast number of PostgreSQL clients available on the Internet. From standard Drivers to BI and Analytics tools, PostgreSQL is a popular interface for data access. Using our JDBC Drivers, you can now create PostgreSQL entry-points that you can connect to from any standard client.

To access Bright Data data as a PostgreSQL database, use the CData JDBC Driver for Bright Data and a JDBC foreign data wrapper (FDW). In this article, we compile the FDW, install it, and query Bright Data data from PostgreSQL Server.

Connect to Bright Data Data as a JDBC Data Source

To connect to Bright Data as a JDBC data source, you will need the following:

  • Driver JAR path: The JAR is located in the lib subfolder of the installation directory.
  • Driver class:

    cdata.jdbc.api.APIDriver
    

  • JDBC URL: The URL must start with "jdbc:api:" and can include any of the connection properties in name-value pairs separated with semicolons.

    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"
    

Build the JDBC Foreign Data Wrapper

The Foreign Data Wrapper can be installed as an extension to PostgreSQL, without recompiling PostgreSQL. The jdbc2_fdw extension is used as an example (downloadable here).

  1. Add a symlink from the shared object for your version of the JRE to /usr/lib/libjvm.so. For example:
    ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
    
  2. Start the build:
    make install USE_PGXS=1
    

Query Bright Data Data as a PostgreSQL Database

After you have installed the extension, follow the steps below to start executing queries to Bright Data data:

  1. Log into your database.
  2. Load the extension for the database:
    CREATE EXTENSION jdbc2_fdw;
    
  3. Create a server object for Bright Data:
    CREATE SERVER API 
    FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
    drivername 'cdata.jdbc.api.APIDriver',
    url 'jdbc:api:Profile=C:\profiles\BrightData.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"',
    querytimeout '15',
    jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.api.jar'); 
    
  4. Create a user mapping for the username and password of a user known to the MySQL daemon.
    CREATE USER MAPPING for postgres SERVER API OPTIONS (
    username 'admin', 
    password 'test');
    
  5. Create a foreign table in your local database:
    postgres=# CREATE FOREIGN TABLE accountstatus (
    accountstatus_id text,
    accountstatus_ text,
    accountstatus_ numeric) 
    SERVER API OPTIONS (
    table_name 'accountstatus');
    
You can now execute SELECT commands to Bright Data:
postgres=# SELECT * FROM accountstatus;

Ready to get started?

Connect to live data from Bright Data with the API Driver

Connect to Bright Data