DbVisualizer でBigCommerce のデータに連携しクエリを作成

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

CData JDBC Driver for BigCommerce は、JDBC 標準に準拠し、BI ツールからIDE まで幅広いアプリケーションでBigCommerce のデータへの接続を提供します。この記事では、DbVisualizer からBigCommerce のデータに接続する方法、およびtable エディタを使ってBigCommerce を編集、および保存する方法を説明します。

CData JDBC ドライバとは？

CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。

1. BigCommerce をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
2. DBeaver を含む多様なアプリケーション、ツールにBigCommerce のデータを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData JDBC ドライバでは、1.データソースとしてBigCommerce の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

BigCommerce のデータの新しいドライバー定義を作成

下記の手順に従い、Driver Manager を使ってDbVisualizer ツールからBigCommerce のデータに接続します。

1. DbVisualizer で「Tools」->「Driver Manager」をクリックします。
2. 「」ボタンをクリックして新しくドライバーを作成します。
3. テンプレートは「Custom」を選択します。
4. Driver Settings タブで：
   • Name をわかりやすい名前に設定します（例：CData BigCommerce Driver）。
   • URL Format をjdbc:bigcommerce: に設定します。
   • Driver artifacts and jar files (jars are loaded in order from top) セクションで：
     1. 「」ボタンをクリックして、「Add Files」に進みます。
     2. インストールディレクトリ（C:\Program Files\CData\CData JDBC Driver for BigCommerce XXXX\）の「lib」フォルダに移動します。
     3. JAR ファイル（cdata.jdbc.BigCommerce.jar）を選択して「Open」をクリックします。
5. Driver Class は自動的に入力されます。もし入力されない場合は、クラス（cdata.jdbc.bigcommerce.BigCommerceDriver）を選択してください。

JDBC データソースへの接続を定義

「Driver Manager」を終了し、下記の手順に従ってJDBC URL に接続プロパティを入力します。

1. 「Databases」タブで「」ボタンをクリックし、先ほど作成したドライバーを選択します。

2. 「Connection」セクションで以下のオプションを設定します。

   • Database Type：ウィザードオプションを選択した場合は、データベースの種類は自動検出されます。「No Wizard」オプションを選択した場合は、「Database Type」メニューから「Generic」または「Auto Detect」オプションを選択します。
   • Driver Type：先ほど作成したドライバーを選択します。

   • Database URL：完全なJDBC URL を入力します。JDBC URL 構文は、jdbc:bigcommerce: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。

     BigCommerce 認証は標準のOAuth フローに基づいています。

     Store ID の取得

     BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。

     1. BigCommerce アカウントにログインします。
     2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
     3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
     4. 画面にAPI Path という名前のテキストボックスが表示されます。
     5. テキストボックス内に、次の構造のURL が表示されます：https://api.bigcommerce.com/stores/{Store Id}/v3。
     6. 上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
     7. Store Id を取得したら、「キャンセル」 をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。

     パーソナルアクセストークンの取得

     加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。

     1. BigCommerce アカウントにログインします。
     2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
     3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
     4. アカウント名を入力します。
     5. 作成するAPI Account の「OAuth Scopes」を選択します。CData 製品 は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
     6. 「保存」をクリックします。

     BigCommerce への認証

     次に、以下を設定してデータに接続できます。
     • StoreId：API Path テキストボックスから取得したStore ID に設定。
     • OAuthAccessToken：生成したトークンに設定。
     • InitiateOAuth：OFF に設定。

     組み込みの接続文字列デザイナー

     JDBC URL の作成の補助として、BigCommerce JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

     java -jar cdata.jdbc.bigcommerce.jar

     接続プロパティを入力し、接続文字列をクリップボードにコピーします。

     JDBC URL を構成する際に、Max Rows 接続プロパティを設定することもできます。この設定は返される行数を制限するため、レポートやビジュアライゼーションを作成する際のパフォーマンスが向上します。

     一般的な接続文字列は次のとおりです。

     jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'InitiateOAuth=GETANDREFRESH
   • NOTE：BigCommerce は認証にUser やPassword を必要としないため、Database Userid とDatabase Password には任意の値を使用できます。
3. 「Connection」タブで「Connect」をクリックします。

BigCommerce JDBC Driver が表示するテーブルをブラウズするには、テーブルを右クリックして「Open In New Tab」をクリックします。

SQL クエリの実行には、SQL Commander ツールを使用します。「SQL Commander」->「New SQL Commander」をクリックします。利用可能なメニューから「Database Connection」、「Database」、「Schema」を選択します。

サポートされるSQL についての詳細は、ヘルプドキュメントの「サポートされるSQL」をご覧ください。テーブルに関する情報は「データモデル」をご覧ください。

おわりに