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

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

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

Connect AI を構成

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

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

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

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

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

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

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

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

Connect AI からLakebase に接続

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

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

   Databricks Lakebase に接続するには、以下のプロパティを設定します。

   • DatabricksInstance: Databricks インスタンスまたはサーバーホスト名を指定します。形式は instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com です。
   • Server: Lakebase データベースをホストするサーバーのホスト名または IP アドレスを指定します。
   • Port（オプション）: Lakebase データベースをホストするサーバーのポート番号を指定します。デフォルトは 5432 です。
   • Database（オプション）: Lakebase サーバーへの認証後に接続するデータベースを指定します。デフォルトでは認証ユーザーのデフォルトデータベースに接続します。

   OAuth クライアント認証

   OAuth クライアント資格情報を使用して認証するには、サービスプリンシパルで OAuth クライアントを構成します。手順の概要は以下のとおりです。

   1. 新しいサービスプリンシパルを作成・構成する
   2. サービスプリンシパルに権限を割り当てる
   3. サービスプリンシパル用の OAuth シークレットを作成する

   詳細については、ヘルプドキュメントの「Setting Up OAuthClient Authentication」セクションをご参照ください。

   OAuth PKCE 認証

   PKCE（Proof Key for Code Exchange）を使用した OAuth code タイプで認証するには、以下のプロパティを設定します。

   • AuthScheme: OAuthPKCE を指定します。
   • User: 認証ユーザーのユーザー ID を指定します。

   詳細については、ヘルプドキュメントをご参照ください。

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

Connect AI にLakebase OData エンドポイントを追加する

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

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

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

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

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

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

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

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

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

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

   require_once 'LakebaseEntities.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 AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }