Connect to Backlog Data in DBeaver





Backlog JDBC Driver

Backlog データ連携のパワフルなJava アプリケーションを素早く作成して配布。

Manage Backlog data with visual tools in DBeaver like the query browser.

The CData JDBC Driver for Backlog implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Backlog data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Backlog Data

Follow the steps below to load the driver JAR in DBeaver.

  1. Open the DBeaver application and, in the Databases menu, select the Driver Manager option. Click New to open the Create New Driver form.
  2. In the Driver Name box, enter a user-friendly name for the driver.
  3. To add the .jar, click Add File.
  4. In the create new driver dialog that appears, select the cdata.jdbc.backlog.jar file, located in the lib subfolder of the installation directory.
  5. Click the Find Class button and select the BacklogDriver class from the results. This will automatically fill the Class Name field at the top of the form. The class name for the driver is cdata.jdbc.backlog.BacklogDriver.
  6. Add jdbc:backlog: in the URL Template field.

Create a Connection to Backlog Data

Follow the steps below to add credentials and other required connection properties.

  1. In the Databases menu, click New Connection.
  2. In the Create new connection wizard that results, select the driver.
  3. On the next page of the wizard, click the driver properties tab.
  4. Enter values for authentication credentials and other properties required to connect to Backlog.

    Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

    API キー認証

    ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには:

    1. Backlog の個人設定ページを開きます。
    2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
    3. ApiKey にAPI キーを指定します。
    4. URL はBacklog のテナントURL から取得できます。

    OAuth 認証

    ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。

    Below is a typical connection string:


Query Backlog Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click Edit Table. The data is available on the Data tab.