製品をチェック

無償トライアル:

無償トライアルへ

製品の情報と無償トライアルへ:

Backlog ODBC Driver

Backlog ODBC Driver は、ODBC 接続をサポートするさまざまなアプリケーションからBacklog のリアルタイムデータ連携を実現するパワフルなツールです。

RDB にアクセスするときと同感覚でBacklog にアクセスし、標準ODBC Driver インターフェースを通じて読み出し、書き込み、更新が可能に。

Linux 上でBacklog にデータ連携するシンプルなGo アプリケーションを作成


CData ODBC Driver for Backlog とunixODBC を使って、Backlog に連携するGo アプリケーションを作成。


古川えりか
コンテンツスペシャリスト

backlog ロゴ画像

ODBC Driver

odbc ロゴ画像
Go ロゴ画像

こんにちは!コンテンツスペシャリストの古川です。Go はオープンソースのプログラミング言語で、高速かつ信頼性の高いソフトウェアを低コストで作成することができます。Go とODBC Driver for Backlog およびunixODBC を組み合わせて使うことで、Backlog データにリアルタイム連携するアプリケーションを作成できます。 本記事では、ODBC Driver for Backlog のインストール、unixODBC Driver Manager への設定、そしてBacklog に連携するGo アプリケーションの作成までを説明します。

Linux マシンで CData ODBC Drivers を使用する

CData ODBC Drivers はUbuntu、Debian、RHEL、CentOS、およびFedora など多くのRed Hat ベースおよびDebian ベースのシステムでサポートされています。 ほかにもいくつかのライブラリやパッケージのインストールが必要ですが、すでにデフォルトでインストールされている場合もあります。詳細はオンラインおよびインストールされるヘルプドキュメントの「はじめに」のセクションを参照してください。

Driver Manager のインストール

ドライバーのインストール前にシステムにDriver Manager が入っているかを確認してください。本記事では無償のオープンソースDriver Manager であるunixODBC を使います

Ubuntu のようなDebian ベースのシステムでは、APT パッケージマネージャからunixODBC をインストールできます:

$ apt-get install unixODBC unixODBC-dev

Red Hat Linux ベースのシステムでは、yum もしくはdnf からunixODBC をインストールできます:

$ yum install unixODBC unixODBC-devel

unixODBC Driver Manager はDriver の情報をodbcinst.ini ファイルから読み、odbc.ini からデータソースの情報を読みます。 次のコマンドをターミナルに入力して、設定ファイルの配置場所を決めることができます:

$ odbcinst -j

コマンドのアウトプットでODBC データソースのコンフィギュレーションファイルと登録されたODBC Drver のロケーションを表示します。 ユーザーデータソースはodbc.ini ホームフォルダが位置するユーザーアカウントのみからアクセス可能です。システムデータソースはすべてのユーザーからアクセスできます。 このコマンドのアウトプット例は以下です:

DRIVERS............: /etc/odbcinst.ini SYSTEM DATA SOURCES: /etc/odbc.ini FILE DATA SOURCES..: /etc/ODBCDataSources USER DATA SOURCES..: /home/myuser/.odbc.ini SQLULEN Size.......: 8 SQLLEN Size........: 8 SQLSETPOSIROW Size.: 8

ドライバーのインストール

標準パッケージ形式でドライバーをダウンロードできます:Debian .deb package format もしくは、.rpm file format です。 ファイルをダウンロードしたら、ターミナルからドライバーをインストールします。

ドライバーインストーラーはドライバーをunixODBC に登録し、ODBC 接続をサポートするツールやアプリケーションから利用できるシステムDSN を作成します。T

Ubuntu のようなDebian ベースのシステムでは、sudo とともに次のコマンドを実行します: $ dpkg -i /path/to/package.deb

.rpms をサポートするシステムでは、sudo とともに次のコマンドを実行します: $ rpm -i /path/to/package.rpm

ドライバーのインストール後、unixODBC Driver Manager を使って、登録されたドライバーを表示し、データソースを定義することができます:

$ odbcinst -q -d CData ODBC Driver for Backlog ...

定義されたData Source の表示

$ odbcinst -q -s CData Backlog Source ...

unixODBC でCData ODBC Driver for Backlog を使用するには、ドライバーがUTF-8 を使用するように設定する必要があります。それには、通常はインストールフォルダのlib フォルダ(/opt/cdata/cdata-odbc-driver-for-backlog)に入っているドライバーのINI ファイル(cdata.odbc.backlog.ini)を次のように編集する必要があります:

cdata.odbc.backlog.ini

... [Driver] DriverManagerEncoding = UTF-16

DSN の変更

ドライバーがインストールされると、システムDSN が事前定義されます。システムDSN はシステムデータソースファイル(/etc/odbc.ini)を編集して必要な接続プロパティを定義します。 ユーザー単位のDSN を作成することも可能で、その際には$HOME/.odbc.ini へのアクセスと変更は必要ではありません。

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

API キー認証

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

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

OAuth 認証

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

/etc/odbc.ini or $HOME/.odbc.ini

[CData Backlog Source] Driver = CData ODBC Driver for Backlog Description = My Description ApiKey = YOUR_API_KEY Url = https://yourURL.backlog.com

これらのコンフィギュレーションファイルの使い方についての詳細は、インストールされるヘルプドキュメントを参照してください。

Backlog データに連携するGo アプリケーションサンプルの作成

Driver Manager のインストール、DSN 設定を終えたら、Backlog data に連携するGo アプリケーションを作成します。 まずはODBC データベース向けのGo ドライバーをインストールします。いくつかのオプションがありますが、本記事ではhttps://github.com/alexbrainman/odbc のODBC ドライバーを使います。

Linux へのODBC のインストール

Go のODBC ドライバーをインストールするには、GOPATH 環境変数を定義する必要があります:

export GOPATH=$HOME/golang/go

GOPATH が定義されたら、ODBC ドライバー向けのGo ドライバーをインストールすることが可能です:

$ go get github.com/alexbrainman/odbc

これでGo アプリケーションを作って実行する準備ができました。

Go アプリケーションサンプル

このサンプルアプリケーションはBacklog data に対してシンプルなSQL SELECT クエリを発行し、結果を表示します。$GOPATH/src/cdata-odbc-backlog ディレクトリを作成し、次のソースコードをコピーして新しいGo ファイルを作成します。

cdata-odbc-backlog.go

package main import ( _ "github.com/alexbrainman/odbc" "database/sql" "log" "fmt" ) func main() { db, err := sql.Open("odbc", "DSN=CData Backlog Source") if err != nil { log.Fatal(err) } var ( id string projectid string ) rows, err := db.Query("SELECT Id, ProjectID FROM Issues WHERE Id = ?", "1") if err != nil { log.Fatal(err) } defer rows.Close() for rows.Next() { err := rows.Scan(&id, &projectid) if err != nil { log.Fatal(err) } fmt.Println(id, projectid) } err = rows.Err() if err != nil { log.Fatal(err) } defer db.Close() }

ターミナルで、Go アプリケーションディレクトリにナビゲートし、アプリケーションをビルドします:

$ go build

アプリケーションのビルド後、アプリケーションを実行し、Backlog のデータを表示することができます:

$ ./cdata-odbc-backlog

これでBacklog と連携するシンプルなGo アプリケーションができました。ここに、より複雑なread/write 機能を使い慣れたSQL 文で足してみてください。