データセット API
データセット API について説明します。
データセット
xData Edge では、ひとまとまりの表形式データをデータセットと呼びます。 表計算ソフトウェアのシートや csv ファイル、リレーショナルデータベース管理システムのテーブル、Python プログラミング言語の pandas におけるデータフレームなどに相当するものです。
データセットは、xData Edge 内でデータセットを一意に識別するための名前と、データセットに格納されるデータの構造を決めるカラム定義を持ちます。 データセットの例を以下に示します。 この例は、my_dataset という名前を持ち、id, name, email という三つのカラムを持つデータセットを表しています。
例: my_dataset
| id | name | |
|---|---|---|
1 |
石塚 洋次 |
WzxKRGR6J@sample.com |
2 |
近藤 恭之 |
KefD6KU@test.net |
3 |
玉井 真帆 |
データセットに格納される個々のデータのことをレコードと呼びます。 上の例では、my_dataset に三つのレコードが格納されています。
サイテーション
xData Edge では、データセットのある時点の状態を指し示す参照のことをサイテーションと呼びます。
データセットの現在の状態にサイテーションを発行することで、その後にレコードが追加、更新、削除されても、サイテーションを発行した時点のレコードを取得できます。 xData Edge では、データセットに格納されるすべてのレコードに対して登録日時、削除日時を記録しておくことで、この機能を実現しています。
データセット API 一覧
xData Edge の利用者はデータセット API を利用して、以下の操作を実行できます。
| API メソッド | 説明 |
|---|---|
| dataset.create | データセットを新規に作成します。 |
| dataset.delete | データセットを削除します。 |
| dataset.get_columns | データセットのカラム定義を取得します。 |
| dataset.citation.create | データセットの現在の状態にサイテーションを発行します。 |
| dataset.citation.delete | サイテーションを削除します。 |
| dataset.record.put | データセットにレコードを登録または更新します。 |
| dataset.record.delete | データセットからレコードを削除します。 |
| dataset.record.get | サイテーションを指定して、データセットのレコードを取得します。 |