Dataset API
Note
This document has been machine translated.
This section explains the Dataset API.
Dataset
In xData Edge, a collection of tabular data is referred to as a dataset. It corresponds to sheets in spreadsheet software, CSV files, tables in relational database management systems, and dataframes in the pandas library of the Python programming language.
A dataset has a name for uniquely identifying the dataset within xData Edge, and column definitions that determine the structure of the data stored in the dataset.
An example of a dataset is shown below.
This example represents a dataset named my_dataset with three columns: id, name, and email.
Example: my_dataset
| id | name | |
|---|---|---|
1 |
石塚 洋次 |
WzxKRGR6J@sample.com |
2 |
近藤 恭之 |
KefD6KU@test.net |
3 |
玉井 真帆 |
Individual pieces of data stored in a dataset are called records.
In the example above, three records are stored in my_dataset.
Citation
In xData Edge, a reference that points to the state of a dataset at a specific point in time is called a citation.
By issuing a citation for the current state of a dataset, you can retrieve the records at the time the citation was issued, even if records are added, updated, or deleted afterward. xData Edge achieves this feature by recording the registration date and deletion date for all records stored in a dataset.
Dataset API List
Users of xData Edge can use the dataset API to perform the following operations.
| API Method | Description |
|---|---|
| dataset.create | Creates a new dataset. |
| dataset.delete | Deletes a dataset. |
| dataset.get_columns | Retrieves the column definitions of a dataset. |
| dataset.citation.create | Issues a citation for the current state of a dataset. |
| dataset.citation.delete | Deletes a citation. |
| dataset.record.put | Registers or updates a record in a dataset. |
| dataset.record.delete | Deletes a record from a dataset. |
| dataset.record.get | Retrieves records from a dataset by specifying a citation. |