QueryOptions Interface

ECSql query config

Extends

Properties

Name Type Description
abbreviateBlobs boolean | undefined default to false.  
convertClassIdsToClassNames boolean | undefined Convert ECClassId, SourceECClassId, TargetECClassId and RelClassId to respective name.  
boolean | undefined This is used internally.  
limit QueryLimit | undefined Limit range of rows returned by query  
rowFormat QueryRowFormat | undefined Determine row format.  
suppressLogErrors boolean | undefined default to false.  

Inherited properties

Name Type Inherited from Description
priority number | undefined BaseReaderOptions Determine priority of this query default to 0, used as hint and can be overriden by backend.
quota QueryQuota | undefined BaseReaderOptions Restrict time or memory for query but use as hint and may be changed base on backend settings
restartToken string | undefined BaseReaderOptions If specified cancel last query (if any) with same restart token and queue the new query
usePrimaryConn boolean | undefined BaseReaderOptions For editing apps this can be set to true and all query will run on primary connection

Defined in

Last Updated: 28 October, 2024