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

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

加藤龍彦
デジタルマーケティング

最終更新日:2022-11-25

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

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

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

SFTP の仮想OData API エンドポイントを作成

まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。

  1. CData Connect Server にログインして、「DATA MODEL」をクリックします。 データベースを追加
  2. 利用できるデータソースアイコンから"SFTP" を選択します。
  3. SFTP に接続するために必要なプロパティを入力します。

    FTP は、SFTP プロトコルを使用してSFTP サーバーとの間のファイル転送を行います。接続するにはRemoteHost を指定します。FTP はUser、Password、および公開鍵認証(SSHClientCert)を使用します。 SSHAuthMode を選択し、選択に基づいて接続値を指定します。

    次の接続プロパティを設定し、ファイルシステムのリレーショナルビューをコントロールします。

    • RemotePath: 現在の作業ディレクトリに設定。
    • TableDepth: ビューとしてレポートするサブフォルダの深度を制御するために設定。
    • FileRetrievalDepth: ファイルを再帰的に取得し、Root テーブルにリストするために設定。
    ストアドプロシージャは、ファイル、のダウンロード、アップロード、およびプロトコルコマンドの送信に利用できます。SQL を使用してサーバーと対話する方法の詳細については、ヘルプドキュメントの「データモデル」を参照してください。

    接続を設定
  4. 「Test Connection」をクリックします。
  5. 「USERS」 -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
  6. API タブをクリックして OData API エンドポイントが生成されていることを確認します。

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

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

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

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

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

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

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

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

    require_once 'SFTPEntities.php'; try{ $svc = new CDataAPI(); $mydirectory = new MyDirectory(); $mydirectory->FilePath = '/documents/doc.txt'; $svc->AddToMyDirectory($mydirectory); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->mydirectory()->Execute(); foreach($response->Result as $mydirectory) echo $mydirectory->Filesize."
    "; } catch (Exception $e) { //CData Connect Server からのエラーをキャッチ echo $e->getError(), "\n"; }

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

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