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

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

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

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

Connect Cloud を構成

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

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

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

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

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 からAlloyDB に接続

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

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

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

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

   • Server：AlloyDB データベースをホスティングしているサーバーのホスト名またはIP アドレス。
   • Port（オプション）：AlloyDB データベースをホスティングしているサーバーのポート。このプロパティはデフォルトで5432に設定されます。
   • User：AlloyDB サーバーに認証する際に使われるユーザー。
   • Password：AlloyDB サーバーに認証する際に使われるパスワード。
   • Database（オプション）：AlloyDB サーバーに接続する場合のデータベース。設定されていない場合は、ユーザーのデフォルトデータベースが使用されます。

   AlloyDB への認証

   標準認証

   標準認証（事前に提供されたユーザーとパスワードの組み合わせを使用）は、デフォルトの認証形式です。

   標準認証で接続する場合は、これ以上のアクションは必要ありません。

   pg_hba.conf 認証スキーム

   CData 製品がサポートしている他の認証方法では、AlloyDB サーバー上のpg_hba.conf ファイルで有効化する必要があります。

   AlloyDB サーバーでの認証の設定については、こちらを参照してください。

   MD5

   pg_hba.conf ファイルのauth-method をmd5 に設定すると、MD5 パスワード検証を使用して認証できます。

   SASL

   CData 製品は、SASL（特にSCRAM-SHA-256）でパスワードを検証することで認証できます。

   この認証方法を使用するには、pg_hba.conf ファイルのauth-method をscram-sha-256 に設定します。

   Kerberos

   Kerberos 認証は、CData 製品が接続を試行している際にAlloyDB サーバーで開始されます。この認証方法を有効化するには、AlloyDB サーバーでKerberos を設定します。AlloyDB サーバーでのKerberos 認証の設定を完了したら、CData 製品からKerberos 認証を行う方法については、ヘルプドキュメントの「Kerberos の使用」セクションを参照してください。

4. Create & Test をクリックします。
5. 「Add AlloyDB Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

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

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

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

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

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\AlloyDBEntities.php

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

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

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

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

   require_once 'AlloyDBEntities.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"; }