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

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

API Server とOData PHP SDK を使用して、エンティティをオブジェクトとしてモデリングすることでPHP でRedshift エンティティを手軽に使用。

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

API Server の設定

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

Redshift への接続

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

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

それでは、早速Amazon Redshift に接続していきましょう。データに接続するには、以下の接続パラメータを指定します。
- Server：Amazon Redshift データベースをホスティングしているサーバーのホスト名またはIP アドレス
- Database：Amazon Redshift クラスター用に作成したデータベース
- Port（オプション）：Amazon Redshift データベースをホスティングしているサーバーのポート。デフォルトは5439です
これらの値は、以下のステップでAWS マネージメントコンソールから取得できます。
1. Amazon Redshift コンソールを開きます（http://console.aws.amazon.com/redshift）
2. Clusters ページで、クラスター名をクリックしてください
3. Configuration タブの"Cluster Database Properties" セクションからプロパティを取得します。接続プロパティの値は、ODBC URL で設定された値と同じになります
Amazon Redshiftへの認証
CData 製品では幅広い認証オプションに対応しています。標準認証情報からIAM クレデンシャル、ADFS、Ping Federate、Microsoft Entra ID（Azure AD）、Azure AD PKCE まで利用可能です。
標準認証
ログイン資格情報を使用してAmazon Redshift に接続するには、以下のプロパティを設定してみましょう。
- AuthScheme：Basic
- User：認証するユーザーのログイン情報
- Password：認証するユーザーのパスワード
その他の認証方法については、ヘルプドキュメントをご確認ください。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Amazon Redshift への接続

それでは、早速Amazon Redshift に接続していきましょう。データに接続するには、以下の接続パラメータを指定します。

Server：Amazon Redshift データベースをホスティングしているサーバーのホスト名またはIP アドレス
Database：Amazon Redshift クラスター用に作成したデータベース
Port（オプション）：Amazon Redshift データベースをホスティングしているサーバーのポート。デフォルトは5439です

これらの値は、以下のステップでAWS マネージメントコンソールから取得できます。

Amazon Redshift コンソールを開きます（http://console.aws.amazon.com/redshift）
Clusters ページで、クラスター名をクリックしてください
Configuration タブの"Cluster Database Properties" セクションからプロパティを取得します。接続プロパティの値は、ODBC URL で設定された値と同じになります

Amazon Redshiftへの認証

CData 製品では幅広い認証オプションに対応しています。標準認証情報からIAM クレデンシャル、ADFS、Ping Federate、Microsoft Entra ID（Azure AD）、Azure AD PKCE まで利用可能です。

標準認証

ログイン資格情報を使用してAmazon Redshift に接続するには、以下のプロパティを設定してみましょう。

AuthScheme：Basic
User：認証するユーザーのログイン情報
Password：認証するユーザーのパスワード

その他の認証方法については、ヘルプドキュメントをご確認ください。

API Server のユーザー設定

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

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

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

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

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

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

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

Amazon Redshift への接続

それでは、早速Amazon Redshift に接続していきましょう。データに接続するには、以下の接続パラメータを指定します。

Server：Amazon Redshift データベースをホスティングしているサーバーのホスト名またはIP アドレス
Database：Amazon Redshift クラスター用に作成したデータベース
Port（オプション）：Amazon Redshift データベースをホスティングしているサーバーのポート。デフォルトは5439です

これらの値は、以下のステップでAWS マネージメントコンソールから取得できます。

Amazon Redshift コンソールを開きます（http://console.aws.amazon.com/redshift）
Clusters ページで、クラスター名をクリックしてください
Configuration タブの"Cluster Database Properties" セクションからプロパティを取得します。接続プロパティの値は、ODBC URL で設定された値と同じになります

Amazon Redshiftへの認証

標準認証

ログイン資格情報を使用してAmazon Redshift に接続するには、以下のプロパティを設定してみましょう。

AuthScheme：Basic
User：認証するユーザーのログイン情報
Password：認証するユーザーのパスワード

その他の認証方法については、ヘルプドキュメントをご確認ください。

さらに、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\Redshift\
Unix or Mac OS X：~/cdata/Redshift/

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

以下のステップに従ってOData PHP SDK を使用し、API Server によって公開されるWeb サービスに接続するプロキシクラスを作成します。

以下のようなコマンドにURL を渡します。
```
php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\RedshiftEntities.php
```
上記のコマンドは、OData エンドポイントからのレスポンスで返されたメタデータからクラスを定義し、指定したフォルダにクラス定義を出力します。

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

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

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

require_once 'RedshiftEntities.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 お問い合わせ

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

API Server の設定

Redshift への接続

Amazon Redshift への接続

Amazon Redshiftへの認証

標準認証

Amazon Redshift への接続

Amazon Redshiftへの認証

標準認証

API Server のユーザー設定

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

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

Amazon Redshift への接続

Amazon Redshiftへの認証

標準認証

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

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

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

この記事の内容

関連記事