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

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

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

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

Connect Cloud を構成

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

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

（オプション）新しいConnect Cloud ユーザーの追加

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

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

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

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

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

Connect Cloud からSingleStore に接続

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

1. Connect Cloud にログインし、 Add Connection をクリックします。
2. 「Add Connection」パネルから「SingleStore」を選択します。
3. 必要な認証プロパティを入力し、SingleStore に接続します。

   データに接続するには、次の接続プロパティが必要です。

   • Server：SingleStore データベースをホスティングしているサーバーのホスト名またはIP アドレス。
   • Port：SingleStore データベースをホスティングしているサーバーのポート。

   また、オプションで以下を設定することもできます。

   • SingleStore：SingleStore Server に接続する場合のデフォルトデータベース。設定されていない場合、すべてのデータベースのテーブルが返されます。

   標準認証

   標準認証で認証するには、次を設定します。

   • User：SingleStore サーバーに認証する際に使われるユーザー。
   • Password：SingleStore サーバーに認証する際に使われるパスワード。

   統合セキュリティを使用した接続

   標準のユーザー名とパスワードを提供する代わりに、Windows 認証を介して信頼されたされたユーザーをサーバーに認証できます。

   SSL 認証

   SSL 認証を活用してセキュアなセッションを介してSingleStore データに接続できます。次の接続プロパティを設定し、データに接続します。

   • SSLClientCert：クライアント証明書のための証明書ストア名に設定。クライアントとサーバーの両方のマシンでトラストストアとキーストアが保持される2-way SSL の場合に使用されます。
   • SSLClientCertPassword：クライアント証明書ストアがパスワードで保護されている場合、この値をストアのパスワードに設定します。
   • SSLClientCertSubject：TLS/SSL クライアント証明書のサブジェクト。ストア内の証明書を検索するために使用されます。
   • SSLClientCertType：クライアントストアの証明書タイプ。
   • SSLServerCert：サーバーが受け入れ可能な証明書。

   SSH 認証

   SSH を使用して、セキュアにリモートマシンにログインできます。SingleStore データにSSH 経由でアクセスするには、次の接続プロパティを設定します。

   • SSHClientCert：クライアント証明書のための証明書ストア名に設定。
   • SSHClientCertPassword：クライアント証明書ストアがパスワードで保護されている場合、この値をストアのパスワードに設定します。
   • SSHClientCertSubject：TLS/SSL クライアント証明書のサブジェクト。ストア内の証明書を検索するために使用されます。
   • SSHClientCertType：クライアントストアの証明書タイプ。
   • SSHPassword：SSH サーバーに認証するためのパスワード。
   • SSHPort：SSH 操作に使用するポート。
   • SSHServer：認証しようとしているSSH 認証サーバー。
   • SSHServerFingerPrint：接続先のホストの検証に使用するSSH サーバーのフィンガープリント。
   • SSHUser：SSH サーバーに認証するためのユーザー名。
   
4. Create & Test をクリックします。
5. 「Add SingleStore Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect Cloud にSingleStore OData エンドポイントを追加する

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

1. OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
2. SingleStore 接続（例：SingleStore1）を選択し、Next をクリックします。
3. 使用するテーブルを選択し、「Confirm」をクリックします。

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

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

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

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

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

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

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

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

   require_once 'SingleStoreEntities.php'; try{ $svc = new CDataAPI(); $orders = new Orders(); $orders->ShipCountry = 'USA'; $svc->AddToOrders($orders); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->orders()->Execute(); foreach($response->Result as $orders) echo $orders->ShipName."
"; } catch (Exception $e) { //CData Connect Cloud からのエラーをキャッチ echo $e->getError(), "\n"; }