ColdFusion で JDBC 経由でリアルタイム Shopify のデータをインポートしてアプリケーションを構築

Dibyendu Datta
Lead Technology Evangelist

CData JDBC Driver を使用して、ColdFusion で Shopify のデータをインポートして活用する方法を説明します。

Adobe ColdFusion は、Web およびモバイルアプリケーションの開発プラットフォームです。独自のスクリプト言語である ColdFusion Markup Language（CFML）を使用して、データ駆動型のWeb サイトを構築したり、REST などのリモートサービスを生成したりできます。

ColdFusion と CData JDBC Driver for Shopifyを組み合わせると、ColdFusion の Web およびモバイルアプリケーションを Shopify の運用データに接続できます。これにより、アプリケーションをより堅牢で完成度の高いものにできます。この記事では、 JDBC Driver を使用して、ColdFusion マークアップファイル内で Shopify データを含むテーブルを作成する方法を説明します。

CData JDBC Driver は、最適化されたデータ処理機能を組み込んでおり、Shopify のデータとのリアルタイム連携において圧倒的なパフォーマンスを提供します。複雑な SQL クエリを Shopify に発行すると、ドライバーはフィルタや集計などのサポートされている SQL 操作を Shopify に直接プッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンがクライアント側で処理します。組み込みの動的メタデータクエリ機能により、ネイティブのデータ型を使用して Shopify のデータを操作・分析できます。

Shopify への接続を設定

ColdFusion と Shopify 間の接続を確立するには、JDBC 接続文字列が必要です。

それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。

アクセストークンによる接続

アクセストークン経由の接続には、以下の2つのステップが必要です。

Shopify の管理画面でアクセストークンを作成
アクセストークンを使用して認証

アクセストークンの作成

まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。

管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
Develop apps をクリックしてCreate an app を選択します
Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
Save をクリックします
Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです：
- unauthenticated_read_content
Save をクリックします
API Credentials を選択します
"Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
Admin API Access token のアクセストークンをコピーします。注意：トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください

アクセストークンによる認証

続いて、アクセストークンで認証するには、以下のプロパティを設定してください。

AuthScheme：AccessToken に設定
AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定

OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。

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

JDBC URL の構築をサポートするために、Shopify JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。

java -jar cdata.jdbc.shopify.jar

組み込みの接続文字列デザイナーを使用して JDBC URL を生成（shopify の例）

データソースの追加とテーブルの作成

接続を設定したら、次の手順に従って CData JDBC Driver を ColdFusion の lib ディレクトリに追加し、新しいデータソースを追加し、接続をテストし、 ColdFusion マークアップファイルを作成して、最終的に Shopify のデータとリアルタイムに接続し、ColdFusion Markup Language（CFML）で記述されたテーブルに表示します。

Shopify 用の JDBC Driver と lic ファイルを「C:\Program Files\CData[product_name]\lib」から「C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib」にコピーします。
```
            cdata.jdbc.shopify.jar
            cdata.jdbc.shopify.lic
        
```
注意：.lic ファイルを jar と一緒にコピーしないと、有効なライセンスがインストールされていないことを示すライセンスエラーが表示されます。これはトライアル版と製品版の両方に当てはまります。
ColdFusion 管理画面から、Data & Services を選択します。
ここで「Add New Data Source」をクリックします。データソース名は、ColdFusion の変数命名規則に従っていれば任意の名前を指定できます。 JDBC Driver の場合は「other」を選択し、「Add」ボタンをクリックします。
次に、ドライバーのプロパティを入力します。
- JDBC URL は次の形式で指定します： jdbc:shopify:|connectionString|
- 一般的な接続文字列は次のようになります：
  
  jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;
- Driver Class：cdata.jdbc.shopify.ShopifyDriver
- Driver Name は任意で、ColdFusion 管理コンソールでデータソースを識別するためだけに使用されます。
作成した CDataShopifyJDBC データソースの左側にあるチェックマークをクリックして、接続をテストします。データソースが「OK」ステータスを報告すれば、使用可能な状態です。

次に、新しい ColdFusion マークアップファイル（.cfm）を作成し、ColdFusion の wwwroot ディレクトリ（「C:\ColdFusion2021\cfusion\wwwroot」）に配置します。

以下のコードでデータソースにクエリを実行します：

            
        <cfquery name="ShopifyQuery" dataSource="CDataShopifyJDBC">
          SELECT * FROM Customers
        </cfquery>

CFTable を使用すると、HTML でテーブルを素早く出力できます：

            
          <cftable
          query = "ShopifyQuery"
          border = "1"
          colHeaders
          colSpacing = "2"
          headerLines = "2"
          HTMLTable
          maxRows = "500"
          startRow = "1">

          <cfcol header="<b>FirstName</b>" align="Left" width=2 text="FirstName"/>

          <cfcol header="<b>Id</b>" align="Left" width=15 text="Id"/>

          ...

        </cftable>

HTML 部分を含む完全なコードは以下のとおりです：

            
        <html>
        <head><title>CData Software | Shopify Customers Table Demo </title></head>
        <body>
        <cfoutput>#ucase("Shopify Customers Table Demo")#</cfoutput>
        <cfquery name="ShopifyQuery" dataSource="CDataShopifyJDBC">

          SELECT * FROM Customers

        </cfquery>
        <cftable
          query = "ShopifyQuery"
          border = "1"
          colHeaders
          colSpacing = "2"
          headerLines = "2"
          HTMLTable
          maxRows = "500"
          startRow = "1">
          <cfcol header="<b>FirstName</b>" align="Left" width=2 text="FirstName"/>

          <cfcol header="<b>Id</b>" align="Left" width=15 text="Id"/>

          ...

        </cftable>
        </body>

        </html>