Query Placid Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData API Driver for JDBC, DataGrip can work with live Placid data. This article shows how to establish a connection to Placid data in DataGrip.

Create a New Driver Definition for Placid

The steps below describe how to create a new Data Source in DataGrip for Placid.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData Placid Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.api.jar).
   • Set Class to cdata.jdbc.api.API.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to Placid

1. Once the connection is saved, click the plus (), then "Data Source" then "CData Placid Driver" to create a new Placid Data Source.
2. In the new window, configure the connection to Placid with a JDBC URL.

   Built-in Connection String Designer

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

   Placid uses API Key authentication to control access to the API. API tokens are project-specific and can be obtained from your project settings on placid.app.

   Using API Key Authentication

   To obtain your API key, log in to placid.app, navigate to your project, open the project settings, and generate an API token from the API section. Note that each API token is scoped to a specific project.

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

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Placid project API token.

   Example connection string:

   Profile=C:\profiles\Placid.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_project_api_token';
   

   
3. Set URL to the connection string, e.g.,

   jdbc:api:Profile=C:\profiles\Placid.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_project_api_token';

4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against Placid

To browse through the Placid entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example:

SELECT ,  FROM Collections WHERE  = ''

Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Placid data in DataGrip. Reach out to our Support Team if you have any questions.