Manage Placid Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Placid seamlessly integrates Placid data into database management tools like DBArtisan by enabling you to access Placid data as a database. This article shows how to create a JDBC source for Placid in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Placid Data into DBArtisan Projects

Follow the steps below to register Placid data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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';
   

   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.

   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Placid data. Placid entities are displayed in the Datasource Explorer.

You can now work with Placid data as you work with any other database. See the driver help documentation for more information on the queries supported by the Placid API.