Dataset API
Note
This document has been machine translated.
This section describes the DataSet API.
Dataset
In xData Edge, a dataset is a single piece of tabular data. It is the equivalent of a spreadsheet sheet or csv file, a table in a relational database management system, or a data frame in the Python programming language pandas.
A dataset has a name that uniquely identifies the dataset within xData Edge and a column definition that determines the structure of the data stored in the dataset. An example of a dataset is shown below. This example represents a dataset with the name my_dataset and three columns: id, name, and email.
Example: my_dataset
| id | name | |
|---|---|---|
1 |
Yoji Ishizuka |
WzxKRGR6J@sample.com |
2 |
Yasuyuki Kondo |
KefD6KU@test.net |
3 |
Maho Tamai |
Individual data stored in a data set is called a record. In the example above, three records are stored in my_dataset.
Citation
In xData Edge, a Citation is a reference that points to the state of a dataset at a point in time.
By issuing a Citation to the current state of the dataset, you can retrieve the record as of the time the Citation was issued, even if the record is subsequently added, updated, or deleted. xData Edge achieves this functionality by keeping a record of the registration and deletion dates and times for all records stored in the data set.
Dataset API List
xData Edge users can use the dataset API to perform the following operations
| API Methods | Description |
|---|---|
| dataset.create | Create a new dataset. Create a new dataset. |
| dataset.delete | Delete a dataset. |
| dataset.get_columns | Get a dataset column definition. |
| dataset.citation.create | Issue a Citation for the current state of a dataset. |
| dataset.citation.delete | Delete a citation. |
| dataset.record.put | Register or update a record in a dataset. |
| dataset.record.delete | Delete a record from a dataset. |
| dataset.record.get | Get a record in a dataset by specifying a citation. |