How to connect to Sentry Data from IntelliJ

The CData JDBC Driver for Sentry enables you to access Sentry 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 Sentry data in IntelliJ.

Create a JBDC Data Source for Sentry

Follow the steps below to add the driver JAR and define connection properties required to connect to Sentry 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.

     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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is the following:

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

Edit and Save Sentry 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.