OData SDK for PHP を使ってCSV のデータを取得

加藤龍彦
加藤龍彦
デジタルマーケティング
CData Connect AI を使えば、OData を使ってCSV のデータにアクセスできます。CData Connect AI とOData PHP SDK を利用することで、CSV のエンティティをPHP で取得して、オブジェクトとしてモデル化できます。

CData Connect AI はCSV のデータをWeb サービスとして公開します。 この記事の手順を実行することで、CSV のデータをPHP オブジェクトとして扱うことができるようになります。

CData Connect AI はCSV のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からCSV のデータへのリアルタイム連携を実現します。

Connect AI を構成

ODataPHP SDK でCSV のデータを操作するには、Connect AI からCSV に接続し、コネクションにユーザーアクセスを提供してCSV のデータのOData エンドポイントを作成する必要があります。

CSV に接続したら、目的のテーブルのOData エンドポイントを作成します。

(オプション)新しいConnect AI ユーザーの追加

必要であれば、Connect AI 経由でCSV に接続するユーザーを作成します。

  1. 「Users」ページに移動し、 Invite Users をクリックします。
  2. 新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。 新しいユーザーを招待
  3. 「Users」ページからユーザーを確認および編集できます。 Connect AI ユーザー

パーソナルアクセストークンの追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン(PAT)を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

  1. Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
  2. 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
  3. PAT の名前を入力して Create をクリックします。 Creating a new PAT
  4. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect AI からCSV に接続

CData Connect AI では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。

  1. Connect AI にログインし、 Add Connection をクリックします。 コネクションの追加
  2. 「Add Connection」パネルから「CSV」を選択します。 データソースの選択
  3. 必要な認証プロパティを入力し、CSV に接続します。

    CSV 接続プロパティの取得・設定方法

    DataSource プロパティにローカルフォルダ名を設定します。

    .csv、.tab、.txt ではない拡張子のファイルを扱う場合には、IncludeFiles 使用する拡張子をカンマ区切りで設定します。Microsoft Jet OLE DB 4.0 driver 準拠の場合にはExtended Properties を設定することができます。別の方法として、Schema.ini ファイルにファイル形式を記述することも可能です。

    CSV ファイルの削除や更新を行う場合には、UseRowNumbers をTRUE に設定します。RowNumber はテーブルKey として扱われます。

    Amazon S3 内のCSV への接続

    URI をバケットおよびフォルダに設定します。さらに、次のプロパティを設定して認証します。

    • AWSAccessKey:AWS アクセスキー(username)に設定。
    • AWSSecretKey:AWS シークレットキーに設定。

    Box 内のCSV への接続

    URI をCSV ファイルを含むフォルダへのパスに設定します。Box へ認証するには、OAuth 認証標準を使います。 認証方法については、Box への接続 を参照してください。

    Dropbox 内のCSV への接続

    URI をCSV ファイルを含むフォルダへのパスに設定します。Dropbox へ認証するには、OAuth 認証標準を使います。 認証方法については、Dropbox への接続 を参照してください。ユーザーアカウントまたはサービスアカウントで認証できます。ユーザーアカウントフローでは、以下の接続文字列で示すように、ユーザー資格情報の接続プロパティを設定する必要はありません。

    SharePoint Online SOAP 内のCSV への接続

    URI をCSV ファイルを含むドキュメントライブラリに設定します。認証するには、User、Password、およびStorageBaseURL を設定します。

    SharePoint Online REST 内のCSV への接続

    URI をCSV ファイルを含むドキュメントライブラリに設定します。StorageBaseURL は任意です。指定しない場合、ドライバーはルートドライブで動作します。 認証するには、OAuth 認証標準を使用します。

    FTP 内のCSV への接続

    URI をルートフォルダとして使用されるフォルダへのパスが付いたサーバーのアドレスに設定します。認証するには、User およびPassword を設定します。

    Google Drive 内のCSV への接続

    デスクトップアプリケーションからのGoogle への認証には、InitiateOAuth をGETANDREFRESH に設定して、接続してください。詳細はドキュメントの「Google Drive への接続」を参照してください。

    接続の設定(Salesforce の表示)
  4. Create & Test をクリックします。
  5. 「Add CSV Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。 権限を更新

Connect AI にCSV OData エンドポイントを追加する

CSV に接続したら、目的のテーブルのOData エンドポイントを作成します。

  1. OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
  2. CSV 接続(例:CSV1)を選択し、Next をクリックします。
  3. 使用するテーブルを選択し、「Confirm」をクリックします。 テーブルを選択(Salesforce の例)

コネクションとOData エンドポイントを設定したら、ODataPHP SDK からCSV のデータに接続できます。

  1. まずは、ODataPHP SDK を使用してCData Connect AI が公開したWeb サービスに接続するプロキシクラスを作成します。

    URI 部分を書き換えて、次のようなコマンドを実行してください。

    php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-personal-access-token/ /out=C:\PHPLib\ODataphp\CSVEntities.php
    	    

    このコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。

    CData Connect AI およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect AI はOData エンドポイントへのアクセスが認可されたユーザーの認証に、パーソナルアクセストークンを使用します。パーソナルアクセストークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。

    認証済みのユーザーは、CData Connect AI の管理コンソールのUsers セクションで設定できます。

  2. これで、PHP のオブジェクト指向インターフェースを使ってCSV のデータにアクセスできます。以下のコードはCustomer テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。

    require_once 'CSVEntities.php';
    try{
      $svc = new CDataAPI();
      $customer = new Customer();
      $customer->FirstName = 'Bob';
      $svc->AddToCustomer($customer);
      $svc->SetSaveChangesOptions(SaveChangesOptions::None);
      $svc->SaveChanges();
      $response = $svc->customer()->Execute();
      foreach($response->Result as $customer)
        echo $customer->City."";
    } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
      echo $e->getError(), "\n";
    }
    

はじめる準備はできましたか?

CData Connect AI の詳細、または無料トライアルにお申し込みください:

無料トライアル