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

加藤龍彦
加藤龍彦
デジタルマーケティング
API Server とOData PHP SDK を使用して、エンティティをオブジェクトとしてモデリングすることでPHP でSingleStore エンティティを手軽に使用。



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

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなSingleStore OData サービスを作成していきましょう。

SingleStore への接続

PHP からSingleStore のデータを操作するには、まずSingleStore への接続を作成・設定します。

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「SingleStore」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、SingleStore への接続設定を行っていきましょう！ 接続設定

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

    • 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 サーバーに認証するためのユーザー名。
  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

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

  • 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 サーバーに認証するためのユーザー名。

API Server のユーザー設定

次に、API Server 経由でSingleStore にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

  1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
  2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
  3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

SingleStore 用のAPI エンドポイントの作成

ユーザーを作成したら、SingleStore のデータ用のAPI エンドポイントを作成していきます。

  1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
  2. アクセスしたい接続を選択し、次へをクリックします。
  3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でSingleStore への接続を設定してユーザーを作成し、API Server でSingleStore データのAPI を追加しました。これで、OData 形式のSingleStore データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

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

  • 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 サーバーに認証するためのユーザー名。

さらに、OData SDK for PHP との互換性のためにAPI Server を構成します。「Settings」をクリックし、OData セクションで「デフォルトバージョン」を2.0 に設定します。

API Server に接続するユーザーの認証トークンを取得

作成するOData サービスを決定したら、「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\SingleStore\
  • Unix or Mac OS X：~/cdata/SingleStore/

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

以下のステップに従ってOData PHP 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\SingleStoreEntities.php

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

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

    許可されたユーザーは、API Server の「Users」セクションで設定できます。

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

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

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

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server お問い合わせ

この記事の内容

関連記事