extract_items
カテゴリ定義に基づいて、トランザクションテーブルを記号変換します。
実行方式は JSON-RPC v2.0 を利用します。
リクエスト例
extract_items は分析 API の一種であり、プロべナンス API の process メソッドに api_method="extract_items" を指定することで実行できます。
以下は、プロべナンスのセッションを開始して、extract_items を実行し、セッションを終了する例です。
import xdata_prov.client import Api
api = Api()
api.begin_session()
api.process(api_method="extract_items", api_params={
"output_ddc": "ddc:jartic_xrain_items",
"input_ddc": "ddc:jartic_xrain_transaction",
"category_ddc": "ddc:jartic_xrain_category"
})
api.commit()
api.end_session()
パラメータ
process メソッドを api_method="extract_items" として呼び出す場合、api_params は以下のキーを含む dict を受け取ります。
既定値が空欄のものは必須のパラメータとなります。
| キー | 説明 | 既定値 |
|---|---|---|
| output_ddc | 登録先 ddc | |
| output_mode | 出力モード (overwrite または error) |
error |
| input_ddc | 入力データ ddc | |
| category_ddc | カテゴリ定義 ddc |
入力データ
トランザクションテーブル
input_ddc で指定される入力 ddc は、「トランザクションテーブル」です。
このテーブルは、以下のスキーマを持つ必要があります。
| カラム名 | データ型 | 説明 |
|---|---|---|
| id | integer | トランザクションを一意に識別する ID |
| start_datetime | timestamp with time zone | 開始日時 |
| end_datetime | timestamp with time zone | 終了日時 |
| location | geometry | 空間範囲 |
| meshcode | character varying | メッシュコード |
| * | 任意のテーマ属性 |
カテゴリ定義テーブル
category_ddc で指定される入力 ddc は、「カテゴリ定義テーブル」です。
このテーブルは、以下のスキーマを持つ必要があります。
| カラム名 | データ型 | 説明 |
|---|---|---|
| item | text | カラム名 |
| min | double precision | 最小値 (指定した値を含む) |
| max | double precision | 最大値 (指定した値を含まない) |
| category | text | カテゴリ文字列 |
出力データ
記号変換済みトランザクションテーブル
output_ddc で指定される出力先 ddc に、「記号変換済みトランザクションテーブル」が出力されます。
このテーブルは、以下のスキーマを持ちます。
| カラム名 | データ型 | 説明 |
|---|---|---|
| id | integer | トランザクションを一意に識別する ID |
| start_datetime | timestamp with time zone | 開始日時 |
| end_datetime | timestamp with time zone | 終了日時 |
| location | geometry | 空間範囲 |
| meshcode | character varying | メッシュコード |
| * | トランザクションテーブルのテーマ属性 | |
| items | text[] | この時空間範囲で発生した事象の集合 |
戻り値
extract_items は、出力先 ddc の ddc 情報を戻します。
これは、プロべナンス API の process メソッドの仕様で定められた動作です。