API Reference > imodeljs-common > Entities > ModelQueryParams

ModelQueryParams Interface

Parameters for performing a query on Model classes.

Extends

Properties

Name Type Description
wantPrivate undefined | false | true    
wantTemplate undefined | false | true    

Inherited properties

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

Defined in

Last Updated: 13 June, 2024