IQuerablePageReader<T>

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

getPageByQuery

Gets a page of data items using a query string.

getPageByQuery(correlationId: string, query: string, paging: PagingParams, sort: SortParams): Promise<DataPage<T>>

  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • query: string - (optional) query string
  • paging: PagingParams - (optional) paging parameters
  • sort: SortParams - (optional) sorting parameters
  • returns: Promise<DataPage<T>> - list of items