Class DatasetListQuery

Query that lists the rows of a published dataset (a DDSQL query) without aggregation.

Hierarchy

  • DatasetListQuery

Constructors

constructor

Properties

additionalProperties? dataSource datasetId datasetProvider filter? limit? sort?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

dataSource

dataSource: DatasetListQueryDataSourceType

Identifies this as a published-dataset list query.

datasetId

datasetId: string

ID of the published dataset to query.

datasetProvider

datasetProvider: PublishedDatasetProvider

Product page that published the dataset queried by a DatasetListQuery. ddsql_query is the only provider currently supported for host map widgets.

Optional filter

filter?: string

Filter applied to the dataset's rows, using events-style search syntax.

Optional limit

limit?: number

Maximum number of rows to return from the dataset query.

Optional sort

sort?: DatasetListQuerySort

Sort configuration for a DatasetListQuery.

Settings

Member Visibility

Theme

Generated using TypeDoc