Skip to main content

DatasetsClient

adaline.datasets manages datasets as a whole — create a dataset, look up metadata and columns, rename, or delete. Row-level and column-level operations live on the nested .rows and .columns sub-clients.

Access

The class is also exported directly for dependency injection or testing:

Sub-clients

DatasetsClient exposes two nested namespaces: Types used below come from @adaline/api:

list()

List datasets in a project (paginated).

Parameters

Returns

Promise<ListDatasetsResponse> with shape { data: DatasetSummary[]; pagination: { limit, returned, hasMore, nextCursor } }.

Example


create()

Create a new dataset. You can seed initial columns in the same call.

Parameters

CreateDatasetRequest shape (abbreviated):

Returns

Promise<Dataset> — the created dataset with every column assigned a server-generated id.

Example


get()

Fetch a single dataset (metadata + full column list, not rows).

Parameters

Returns

Promise<Dataset> — see the Get dataset API schema.

Example


update()

Update dataset-level metadata (title, icon).

Parameters

Returns

Promise<DatasetSummary> — the updated dataset metadata (note: returns the summary shape, not the full Dataset with columns).

Example


delete()

Permanently delete a dataset and all of its columns and rows. Irreversible.

Example


See Also