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

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

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

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

Snowflake データ連携について

CData は、Snowflake のライブデータへのアクセスと統合を簡素化します。お客様は CData の接続機能を以下の目的で活用しています：

Snowflake データを迅速かつ効率的に読み書きできます。
指定された Warehouse、Database、Schema のメタデータを動的に取得できます。
OAuth、OKTA、Azure AD、Azure マネージドサービス ID、PingFederate、秘密鍵など、さまざまな方法で認証できます。

多くの CData ユーザーは、CData ソリューションを使用して、お気に入りのツールやアプリケーションから Snowflake にアクセスし、さまざまなシステムからデータを Snowflake にレプリケートして、包括的なウェアハウジングと分析を行っています。

CData ソリューションとの Snowflake 統合についての詳細は、ブログをご覧ください：https://jp.cdata.com/blog/snowflake-integrations

はじめに

API Server の設定

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

Snowflake への接続

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

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Snowflake」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、Snowflake への接続設定を行っていきましょう！
それでは、Snowflake データベースに接続していきましょう。認証に加えて、以下の接続プロパティを設定します。
- Url：お使いのSnowflake URL を指定します。例：https://orgname-myaccount.snowflakecomputing.com
  - Legacy URL を使用する場合：https://myaccount.region.snowflakecomputing.com
  - ご自身のURL は以下のステップで確認できます。
    1. Snowflake UI の左下にあるユーザー名をクリックします
    2. Account ID にカーソルを合わせます
    3. Copy Account URL アイコンをクリックして、アカウントURL をコピーします
- Database（オプション）：CData 製品によって公開されるテーブルとビューを、特定のSnowflake データベースのものに制限したい場合に設定します
- Schema（オプション）：CData 製品によって公開されるテーブルとビューを、特定のSnowflake データベーススキーマのものに制限したい場合に設定します
Snowflakeへの認証

CData 製品では、Snowflake ユーザー認証、フェデレーション認証、およびSSL クライアント認証をサポートしています。認証するには、User とPassword を設定し、AuthScheme プロパティで認証方法を選択してください。

キーペア認証

ユーザーアカウントに定義されたプライベートキーを使用してセキュアなトークンを作成し、キーペア認証で接続することも可能です。この方法で接続するには、AuthScheme をPRIVATEKEY に設定し、以下の値を設定してください。
- User：認証に使用するユーザーアカウント
- PrivateKey：プライベートキーを含む.pem ファイルへのパスなど、ユーザーに使用されるプライベートキー
- PrivateKeyType：プライベートキーを含むキーストアの種類（PEMKEY_FILE、PFXFILE など）
- PrivateKeyPassword：指定されたプライベートキーのパスワード
その他の認証方法については、ヘルプドキュメントの「Snowflakeへの認証」セクションをご確認ください。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

それでは、Snowflake データベースに接続していきましょう。認証に加えて、以下の接続プロパティを設定します。

Url：お使いのSnowflake URL を指定します。例：https://orgname-myaccount.snowflakecomputing.com
- Legacy URL を使用する場合：https://myaccount.region.snowflakecomputing.com
- ご自身のURL は以下のステップで確認できます。
  1. Snowflake UI の左下にあるユーザー名をクリックします
  2. Account ID にカーソルを合わせます
  3. Copy Account URL アイコンをクリックして、アカウントURL をコピーします
Database（オプション）：CData 製品によって公開されるテーブルとビューを、特定のSnowflake データベースのものに制限したい場合に設定します
Schema（オプション）：CData 製品によって公開されるテーブルとビューを、特定のSnowflake データベーススキーマのものに制限したい場合に設定します

Snowflakeへの認証

CData 製品では、Snowflake ユーザー認証、フェデレーション認証、およびSSL クライアント認証をサポートしています。認証するには、User とPassword を設定し、AuthScheme プロパティで認証方法を選択してください。

キーペア認証

ユーザーアカウントに定義されたプライベートキーを使用してセキュアなトークンを作成し、キーペア認証で接続することも可能です。この方法で接続するには、AuthScheme をPRIVATEKEY に設定し、以下の値を設定してください。

User：認証に使用するユーザーアカウント
PrivateKey：プライベートキーを含む.pem ファイルへのパスなど、ユーザーに使用されるプライベートキー
PrivateKeyType：プライベートキーを含むキーストアの種類（PEMKEY_FILE、PFXFILE など）
PrivateKeyPassword：指定されたプライベートキーのパスワード

その他の認証方法については、ヘルプドキュメントの「Snowflakeへの認証」セクションをご確認ください。

API Server のユーザー設定

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

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

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

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

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

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

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

それでは、Snowflake データベースに接続していきましょう。認証に加えて、以下の接続プロパティを設定します。

Url：お使いのSnowflake URL を指定します。例：https://orgname-myaccount.snowflakecomputing.com
- Legacy URL を使用する場合：https://myaccount.region.snowflakecomputing.com
- ご自身のURL は以下のステップで確認できます。
  1. Snowflake UI の左下にあるユーザー名をクリックします
  2. Account ID にカーソルを合わせます
  3. Copy Account URL アイコンをクリックして、アカウントURL をコピーします
Database（オプション）：CData 製品によって公開されるテーブルとビューを、特定のSnowflake データベースのものに制限したい場合に設定します
Schema（オプション）：CData 製品によって公開されるテーブルとビューを、特定のSnowflake データベーススキーマのものに制限したい場合に設定します

Snowflakeへの認証

キーペア認証

User：認証に使用するユーザーアカウント
PrivateKey：プライベートキーを含む.pem ファイルへのパスなど、ユーザーに使用されるプライベートキー
PrivateKeyType：プライベートキーを含むキーストアの種類（PEMKEY_FILE、PFXFILE など）
PrivateKeyPassword：指定されたプライベートキーのパスワード

その他の認証方法については、ヘルプドキュメントの「Snowflakeへの認証」セクションをご確認ください。

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

Snowflake エンティティを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\SnowflakeEntities.php
```
上記のコマンドは、OData エンドポイントからのレスポンスで返されたメタデータからクラスを定義し、指定したフォルダにクラス定義を出力します。

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

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

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

require_once 'SnowflakeEntities.php';
try{
  $svc = new CData();
  $products = new Products();
  $products->Id = '1';
  $svc->AddToProducts($products);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->products()->Execute();
  foreach($response->Result as $products)
    echo $products->Id."";
} catch (Exception $e) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

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

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

CData API Server お問い合わせ

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

Snowflake データ連携について

はじめに

API Server の設定

Snowflake への接続

Snowflakeへの認証

キーペア認証

Snowflakeへの認証

キーペア認証

API Server のユーザー設定

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

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

Snowflakeへの認証

キーペア認証

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

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

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

この記事の内容

関連記事