IWorkspaceDatasetsService
Service for querying workspace datasets
export interface IWorkspaceDatasetsService
Methods
Method | Description |
|---|---|
Receive all workspace datasets metadata | |
(BETA) Get dataset by reference. | |
Receive all workspace csv datasets | |
Get all dataSets for given refs | |
(BETA) Datasets query factory. | |
(BETA) Updates metadata object for the dataset. |
Method details
IWorkspaceDatasetsService.getAllDatasetsMeta()method
Receive all workspace datasets metadata
getAllDatasetsMeta(): Promise<IMetadataObject[]>;
Returns
Promise<IMetadataObject[]>
promise of workspace datasets metadata
IWorkspaceDatasetsService.getDataset()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Get dataset by reference.
getDataset(ref: ObjRef): Promise<IDataSetMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | ref of the dataset |
Returns
Promise<IDataSetMetadataObject>
promise of dataset metadata object
IWorkspaceDatasetsService.getDataSets()method
Get all dataSets for given refs
getDataSets(refs: ObjRef[]): Promise<IDataSetMetadataObject[]>;
Parameters
Parameter | Type | Description |
|---|---|---|
refs | ObjRef[] |
Returns
Promise<IDataSetMetadataObject[]>
promise array of workspace dataSets metadata objects
IWorkspaceDatasetsService.getDatasetsQuery()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Datasets query factory.
getDatasetsQuery(): IDatasetsQuery;
Returns
datasets query
IWorkspaceDatasetsService.updateDatasetMeta()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Updates metadata object for the dataset.
updateDatasetMeta(dataSet: Partial<IMetadataObjectBase> & IMetadataObjectIdentity): Promise<IDataSetMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
dataSet | Partial<IMetadataObjectBase> & IMetadataObjectIdentity | dataset metadata object to update |
Returns
Promise<IDataSetMetadataObject>
promise of updated dataset metadata object