Connect to Sentry Data in Aqua Data Studio

The CData JDBC Driver for Sentry integrates Sentry data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Sentry data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Sentry data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Sentry.
   • Driver Location: Click the Browse button and select the cdata.jdbc.api.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.api.APIDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:api: and is followed by a semicolon-separated list of connection properties.

     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.

     A typical JDBC URL is below:

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

   

Query Sentry Data

You can now query the tables exposed.