Interface for data processing components that can query a page of data items.
Description
The IQuerablePageReader interface is used by data processing components that can query a page of data items.
Instance methods
get_page_by_query
Gets a page of data items using a query string.
get_page_by_query(correlation_id: Optional[str], query: Optional[str], paging: Optional[PagingParams], sort: Optional[SortParams] = None): DataPage
- correlation_id: Optional[str] - (optional) transaction id used to trace execution through the call chain.
- query: Optional[str] - (optional) query string
- paging: Optional[PagingParams] - (optional) paging parameters
- sort: Optional[SortParams] - (optional) sorting parameters
- returns: DataPage - list of items