pinot-noir.ipinotqueryoptions.md

Home > pinot-noir > IPinotQueryOptions

IPinotQueryOptions interface

Query options.

Signature:

export interface IPinotQueryOptions

Properties

Property	Modifiers	Type	Description
andScanReordering?		boolean	(Optional) Enable scan reordering for AND clauses.
enableNullHandling?		boolean	(Optional) Enables advanced null handling. (introduced in 0.11.0)
explainPlanVerbose?		boolean	(Optional) Return verbose result for EXPLAIN query. (introduced in 0.11.0)
inPredicateLookupAlgorithm?		'DIVIDE_BINARY_SEARCH' | 'SCAN' | 'PLAIN_BINARY_SEARCH'	(Optional) Algorithm to use to look up the dictionary ids for the IN clause values.
inPredicatePreSorted?		boolean	(Optional) Indicates that the values in the IN clause are already sorted.
maxExecutionThreads?		number	(Optional) Maximum threads to use to execute the query.
maxQueryResponseSizeBytes?		number	(Optional) Maximum serialized response size across all servers for a query.
maxRowsInJoin?		number	(Optional) Maximum rows allowed in join hash-table creation phase.
maxServerResponseSizeBytes?		number	(Optional) Maximum length of the serialized response per server for a query.
minSegmentGroupTrimSize?		number	(Optional) Minimum groups to keep when trimming groups at the segment level for group-by queries.
minServerGroupTrimSize?		number	(Optional) Minimum groups to keep when trimming groups at the server level for group-by queries.
numReplicaGroupsToQuery?		number	(Optional) Number of replica groups to query when replica-group based routing is enabled. (introduced in 0.11.0)
queueTolerance?		TQueueTolerancePredefined | number	(Optional) Queue tolerance in percent of maxQueueSize. If maxQueueSize * queueTolerance <= queue size the request is discarded.
skipIndexes?		string	(Optional) Which indexes to skip usage of, per-column. Format: col1=indexType1,indexType2&col2=indexType1.
skipUpsert?		boolean	(Optional) For upsert-enabled table, skip the effect of upsert and query all records.
timeoutMs?		number	(Optional) Timeout of the query in milliseconds.
useMultistageEngine?		boolean	(Optional) Use multi-stage engine to execute the query. (introduced in 0.11.0)
useStarTree?		boolean	(Optional) Use star-tree index if available. (introduced in 0.11.0)