How to connect to Browserless Data from IntelliJ

The CData JDBC Driver for Browserless enables you to access Browserless as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Browserless data in IntelliJ.

Create a JBDC Data Source for Browserless

Follow the steps below to add the driver JAR and define connection properties required to connect to Browserless data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.api.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.api.APIDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:api: and includes connection properties separated with semicolons.

     Browserless uses HTTP API token authentication. Your Browserless API token is sent as the token query parameter on every request. You can generate or view your token in the Browserless dashboard at https://account.browserless.io/.

     Using ApiKey Authentication

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

     • AuthScheme: Set this to APIKey.
     • APIKey: Set this to your Browserless API token.

     Example connection string:

     Profile=C:\profiles\Browserless.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_token";
     

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Browserless 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 the following:

     jdbc:api:Profile=C:\profiles\Browserless.apip;AuthScheme=APIKey;ProfileSettings="ApiKey=your_api_token";

Edit and Save Browserless Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.