Interface ExecuteCsvQueryParams

Parameters for CSV data query execution.

Properties

beforeQuery?: (jaql) => any

Sync or async callback that allows to modify the JAQL payload before it is sent to the server.

Parameter	Type
`jaql`	`any`

any

config?: ExecuteCSVQueryConfig

count?: number

Number of rows to return in the query result

If not specified, the default value is 20000

dataSource?: DataSource

Data source the query is run against - e.g. Sample ECommerce

If not specified, the query will use the defaultDataSource specified in the parent Sisense Context.

dimensions?: Attribute[]

Dimensions of the query

filters?: FilterRelations | Filter[]

Filters that will slice query results

highlights?: Filter[]

Highlight filters that will highlight results that pass filter criteria.

NOTE that highlight filters in the "Include all" state are silently omitted from the query. To clear a highlight, remove it from the array.

measures?: Measure[]

Measures of the query

offset?: number

Offset of the first row to return

If not specified, the default value is 0

ungroup?: boolean

Boolean flag whether to include ungroup: true in non-aggregated JAQL queries.

This improves computation and performance of querying tables when no aggregation is needed

If not specified, the default value is false