Manage Sentry Data in DBArtisan as a JDBC Source

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

Integrate Sentry Data into DBArtisan Projects

Follow the steps below to register Sentry 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.

   Using API Key Authentication

   Sentry uses token-based authentication. To obtain an Auth Token:

   1. Log in to your Sentry account at https://sentry.io
   2. Navigate to Settings > Auth Tokens
   3. Click "Create New Token"
   4. Select the required scopes and click "Create Token"
   5. Copy the generated token (it will only be shown once)

   After obtaining your Auth Token, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   Set the following in the ProfileSettings connection property:
   • APIKey: Set this to your Sentry Auth Token.
   • OrganizationId: Set this to your Sentry organization slug or ID.

   Example Connection String

   Profile=C:\profiles\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";
   

   Connecting to Sentry

   Once the authentication is configured, you can connect to Sentry and query data from any of the available tables such as Organizations, Projects, Issues, and Events.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Sentry 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\Sentry.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_auth_token;OrganizationId=your_org_slug";

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

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