Class DatasetMeta

Hierarchy

DataApiResource<DatasetInfo>
- DatasetMeta

Index

Methods

createIndex get index remove update

Methods

createIndex

createIndex(data: Pick<DatasetIndexInfo, "name" | "fields" | "unique" | "required">): Promise<DatasetIndexMeta>
Create new index for dataset
Parameters
- data: Pick<DatasetIndexInfo, "name" | "fields" | "unique" | "required">
Returns Promise<DatasetIndexMeta>

get

get(): Promise<DatasetInfo>
Load API resource

Returns Promise<DatasetInfo>

Inherited from DataApiResource.get

index

index(indexName: string): DatasetIndexMeta
Parameters
- indexName: string
Returns DatasetIndexMeta

remove

remove(): Promise<RemoveFromCollectionResponseBody>
Remove API resource

Returns Promise<RemoveFromCollectionResponseBody>

Inherited from DataApiResource.remove

update

update(data: Partial<DatasetInfo>): Promise<DatasetInfo>
Update dataset info
Parameters
- data: Partial<DatasetInfo>
Returns Promise<DatasetInfo>