Class: Dataset
Defined in: src/entities/datasets.ts Dataset entity for working with dataset metadata and content.Constructors
Constructor
Parameters
datasetDb
DatasetDBType
Returns
Dataset
Properties
columnNames
createdAt
createdByUser
currentVersionIndex
draft
id
name
numRows
projectCount
updatedAt
Accessors
content
Get Signature
Returns
null | DatasetRow[]
The cached dataset rows or null if not loaded.
Methods
addRows()
Parameters
rows
Record<string,
| null
| string
| number
| Record<string, null | string | number>>[]
The rows to append to the dataset.
Returns
Promise<Dataset>
A promise that resolves to the updated dataset.
getContent()
Returns
Promise<DatasetRow[]>
A promise that resolves to the rows of the dataset.
getVersionHistory()
Returns
Promise<DatasetVersionHistory>
A promise that resolves to the version history for this dataset.
listProjects()
Parameters
limit
number = 100
(Optional) The maximum number of projects to return.
Returns
Promise<DatasetProject[]>
A promise that resolves to the list of projects that use this dataset.
loadVersion()
Parameters
versionIndex
number
The index of the version to load.
Returns
Promise<DatasetContent>
A promise that resolves to the content of the specified version.
toDatasetDB()
Returns
DatasetDBType
The dataset database object.