Connect to Workable Data in DBeaver

The CData API Driver for ODBC enables access to live data from Workable under the ODBC standard, allowing you work with Workable data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage Workable data with visual tools in DBeaver like the query browser.

The CData ODBC drivers offer unmatched performance for interacting with live Workable data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver to Workable, the driver pushes supported SQL operations, like filters and aggregations, directly to Workable and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can manage and analyze Workable data.

Connect to Workable

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

Using API Key Authentication

Workable uses API key authentication to control access to the API. To obtain an API Key:

1. Log in to your Workable account.
2. Navigate to Settings > Integrations > API Access Tokens.
3. Click "Generate API Token".
4. Copy the generated token.

After obtaining your API Key, set the following connection properties:

• AuthScheme: Set this to APIKey.

• APIKey: Set this to your Workable API Key.
• Subdomain: Set this to your Workable account subdomain. For example, if your Workable URL is acmeinc.workable.com, then the Subdomain is 'acmeinc'.

Example Connection String

Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';

Finally, set the "Map To WVarchar connection property to False in the DSN Configuration window for the driver. This configuration will allow string types to be mapped to SQL_VARCHAR and prevent SQL_WVARCHAR types from being displayed as NULL.

Connecting to the Workable ODBC Data Source in DBeaver

1. Open the DBeaver application and in the Database menu, select the New Database Connection option.
2. In the 'Connect to a database' window, select ODBC and click Next.
3. In the Database/Schema field, enter the DSN name (CData Workable Source by default). It will be automatically added to the JDBC URL as well.
4. Click the Test Connection button. You should receive a 'Connected' message after DBeaver has detected the DSN, along with details about the driver if the connection is successful.

Query Workable Data

You can now query information from the tables exposed by the data source connection. You can expand the database structure in order to view all the tables. You can retrieve the table's data by right-clicking on a table name and selecting View data. The data will then be available in the Data tab.

Free Trial & More Information

At this point, you have connected to live Workable data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live Workable data DBeaver today.