Connect to Linear Data in Aqua Data Studio

The CData JDBC Driver for Linear integrates Linear data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Linear 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 Linear 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, Linear.
   • Driver Location: Click the Browse button and select the cdata.jdbc.linear.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.linear.LinearDriver.

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

     You can authenticate to Linear with a personal API key or with OAuth 2.0. The API key is the simplest option for connecting with your own Linear account.

     Authenticating with an API Key

     Set the following connection properties:

     • AuthScheme: Set this to APIKey.
     • APIKey: A Linear personal API key.

     To create a personal API key, log in to Linear, open Settings > Security & access > Personal API keys, select New API key, and create it. Copy the key immediately, because Linear shows it only once.

     Authenticating with OAuth

     OAuth requires a custom OAuth application registered in Linear (Settings > API > OAuth applications), which provides the OAuthClientId and OAuthClientSecret. Two flows are supported:

     • Authorization code: Set AuthScheme to OAuth, InitiateOAuth to GETANDREFRESH, and provide OAuthClientId, OAuthClientSecret, and the CallbackURL defined in your application (e.g., http://localhost:33333). The driver opens Linear in your browser so you can grant access.
     • Client credentials: Set AuthScheme to OAuthClient and provide OAuthClientId and OAuthClientSecret. This authenticates the application itself, with no browser interaction, and suits machine-to-machine integrations.

     By default, the driver requests the read,write scopes. The driver refreshes the access token automatically when it expires.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Linear JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     
     java -jar cdata.jdbc.linear.jar
     

     Fill in the connection properties and copy the connection string to the clipboard.

     A typical JDBC URL is below:

     jdbc:linear:AuthScheme=APIKey;APIKey=myAPIKey;

   

Query Linear Data

You can now query the tables exposed.