Manage Linear Data in DBArtisan as a JDBC Source

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

Integrate Linear Data into DBArtisan Projects

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

   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.

   

   Below is a typical connection string:

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

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

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