IDatasetsQuery

Home > @gooddata/sdk-backend-spi > IDatasetsQuery

IDatasetsQuery interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Service to query datasets.

Signature:

export interface IDatasetsQuery

Methods

Method

Description

query()

(BETA) Starts the query.

withFilter(filter)

(BETA) Sets filter for the query.

withInclude(include)

(BETA) Sets include for the query.

withMethod(method)

(BETA) Selects which backend endpoint flavor to use when listing datasets. Default method: "GET"

withOrigin(origin)

(BETA) Sets origin for the query.

withPage(page)

(BETA) Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0

withSize(size)

(BETA) Sets number of datasets to return per page. Default size: 50

withSorting(sort)

(BETA) Sets sorting for the query.

← IDataFiltersServiceIDatasetsQueryFilterOptions →