製品をチェック

製品の情報と30日間無償トライアル

CSV 連携ソリューション 相談したい

OData SDK for PHP を使用したCSV データのクエリ

API Server とOData PHP SDK を使用して、エンティティをオブジェクトとしてモデリングすることでPHP でCSV エンティティを手軽に使用。

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

最終更新日:2022-06-30

こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。

CData API Server は、ADO.NET Provider for CSV(またはその他の250+ ADO.NET Providers のデータ)と組み合わせることでWeb サービスとしてCSV データを公開します。下記の手順に従って、CSV データをオブジェクトとして使用します。

API Server のセットアップ

以下のステップに従って、セキュアなCSV OData サービスの作成を開始します。

デプロイ

API Server は、独自のサーバーで実行されます。Windows の場合、スタンドアロンサーバーまたはIIS を使用して配置できます。Java サーブレットコンテナの場合は、API Server WAR ファイルをドロップします。詳細と操作方法については、ヘルプドキュメントを参照してください。

API Server はMicrosoft AzureAmazon EC2Heroku にも簡単にデプロイすることができます。

CSV に接続する

API Server とADO.NET Provider for CSV をデプロイしたら、API Server 管理コンソールで「Settings」->「Connections」をクリックし、新しい接続を追加して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 への接続」を参照してください。

次に、「Settings」->「Resources」とクリックしてAPI Server にアクセスを許可するCSV エンティティを選択することができます。

さらに、OData SDK for PHP との互換性のためにAPI Server を構成します。「Server」->「Settings」とクリックし、OData セクションで「Default Version」を2.0 に設定します。

API Server ユーザーを認証する

作成するOData サービスを決定したら、「Settings」->「Users」とクリックしてユーザーを認証します。API Server は、認証トークンベースの認証を使用して、主要な認証スキームをサポートします。SSL を使用すれば、接続の認証だけでなく、暗号化も可能です。IP アドレスを使用してアクセスを制限することも可能です。デフォルトでは、ローカルマシンからの接続のみが許可されます。

わかりやすくするために、URL に認証トークンを設定してAPI Server への認証を行います。これはデフォルトでは有効になっていないため、API Server の構成ファイルであるsettings.cfg に以下の行を追加する必要があります。

[Application] AllowAuthTokenInUrl = true

settings.cfg ファイルはデータディレクトリに配置されています。.NET 版では、www の下のapp_data フォルダがデータディレクトリになっています。Java 版でのデータディレクトリの位置は、OS によって変わります。

  • Windows:C:\ProgramData\CData\CSV\
  • Unix or Mac OS X:~/cdata/CSV/

CSV エンティティをPHP オブジェクトとして使用する

以下のステップに従ってODataPHP SDK を使用し、API Server によって公開されるWeb サービスに接続するプロキシクラスを作成します。

  1. 以下のようなコマンドにURL を渡します。

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

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

    API Server とOData SDK for PHP は、フォーム認証とWindows 認証をサポートします。API Server は、認証トークンを使用してOData エンドポイントへのアクセスを許可されたユーザーを認証します。HTTP Basic 認証で認証トークを指定するか、OData URL に追加することができます。

    許可されたユーザーは、API Server 管理コンソールの「Settings」->「Users」セクションで設定できます。

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

    require_once 'CSVEntities.php'; try{ $svc = new CData(); $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) { //catch errors from the API Server echo $e->getError(), "\n"; }

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。