API Reference > imodeljs-common > Entities > EntityQueryParams

EntityQueryParams Interface

Parameters for performing a query on Entity classes.

Properties

Name Type Description
from undefined | string The sql className, in the form "Schema.ClassName", of the class to search.  
limit undefined | number Optional "LIMIT" clause to limit the number of rows returned.  
offset undefined | number Optional "OFFSET" clause.  
only undefined | false | true Set to true to limit results to not include sub-classes of "from" class  
orderBy undefined | string Optional "ORDERBY" clause to sort results.  
where undefined | string Optional "WHERE" clause to filter entities.  

Defined in

Last Updated: 13 June, 2024