# Interface ExecuteQueryParams

Parameters for useExecuteQuery hook.

# Properties

# count

count?: number

Number of rows to return in the query result

If not specified, the default value is 20000

# dataSource

dataSource?: string

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

dimensions?: Attribute[]

Dimensions of the query

# enabled

enabled?: boolean

Boolean flag to control if query is executed

If not specified, the default value is true

# filters

filters?: Filter[]

Filters that will slice query results

# highlights

highlights?: Filter[]

Highlight filters that will highlight results that pass filter criteria

# measures

measures?: Measure[]

Measures of the query

# offset

offset?: number

Offset of the first row to return

If not specified, the default value is 0

# onBeforeQuery

onBeforeQuery?: (jaql) => any

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

Note: wrap this function in useCallback hook to avoid triggering query execution on each render.

const onBeforeQuery = useCallback((jaql) => {
  // modify jaql here
  return jaql;
}, []);

# Parameters

Parameter Type
jaql any

# Returns