Load Linear Data to a Database Using Embulk
Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for Linear, Embulk easily loads data from Linear to any supported destination. In this article, we explain how to use the CData JDBC Driver for Linear in Embulk to load Linear data to a MySQL dtabase.
With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Linear data. When you issue complex SQL queries to Linear, the driver pushes supported SQL operations, like filters and aggregations, directly to Linear and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).
Configure a JDBC Connection to Linear Data
Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Linear\lib).
Embulk supports JDBC connectivity, so you can easily connect to Linear and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with Linear.
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 JDBC connection string for Linear:
jdbc:linear:AuthScheme=APIKey;APIKey=myAPIKey;
Load Linear Data in Embulk
After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.
Install Embulk Input & Output Plugins
- Install the JDBC Input Plugin in Embulk.
https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc - In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysqlembulk gem install embulk-output-mysql
embulk gem install embulk-input-jdbc
With the input and output plugins installed, we are ready to load Linear data into MySQL using Embulk.
Create a Job to Load Linear Data
Start by creating a config file in Embulk, using a name like linear-mysql.yml.
- For the input plugin options, use the CData JDBC Driver for Linear, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.linear.LinearDriver), and the JDBC URL from above
- For the output plugin options, use the values and credentials for the MySQL database
Sample Config File (linear-mysql.yml)
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for Linear 20xx\lib\cdata.jdbc.linear.jar
driver_class: cdata.jdbc.linear.LinearDriver
url: jdbc:linear:AuthScheme=APIKey;APIKey=myAPIKey;
table: "Team"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Team"
mode: insert
After creating the file, run the Embulk job.
embulk run linear-mysql.yml
After running the the Embulk job, find the Salesforce data in the MySQL table.
Load Filtered Linear Data
In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for Linear 20xx\lib\cdata.jdbc.linear.jar
driver_class: cdata.jdbc.linear.LinearDriver
url: jdbc:linear:AuthScheme=APIKey;APIKey=myAPIKey;
query: "SELECT id, name FROM Team WHERE [RecordId] = 1"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Team"
mode: insert
More Information & Free Trial
By using CData JDBC Driver for Linear as a connector, Embulk can integrate Linear data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.