How to connect to Linear Data with Squirrel SQL client

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Linear data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for Linear enables you to execute queries to Linear data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Linear data and execute queries.

Add the JDBC Driver for Linear

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Linear.
  4. In the Example URL box, enter jdbc:linear:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.linear.LinearDriver.
The definition for the JDBC data source. (Salesforce is shown.)

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData Linear Source.
    • Driver: Select the CData JDBC Driver for Linear.
    • URL: Enter jdbc:linear:
    The alias definition, containing the connection parameters. (Salesforce is shown.)
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required 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.

    Below is a typical connection string:

    
    jdbc:linear:AuthScheme=APIKey;APIKey=myAPIKey;
    
    Connection properties automatically detected by Squirrel SQL. (Salesforce is shown.)
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Linear Data

After the metadata has loaded, a new tab for the Linear data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

Column metadata for a table. (Salesforce is shown.)

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

Tables can be edited on the Content tab. (Salesforce is shown.)

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:


SELECT id, name FROM Team WHERE key = 'ENG'
A query and the results. (Salesforce is shown.)

Ready to get started?

Download a free trial of the Linear Driver to get started:

 Download Now

Learn more:

Linear Icon Linear JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Linear data including AgentSession, Comment, Customer, Cycle, Initiative, Integration, Issue, ProjectStatus, Release, Team, User, and more!