pip_services3_data.IFilteredPageReader module

pip_services3_data.IFilteredPageReader

Interface for filtered paging data readers.

copyright

Conceptual Vision Consulting LLC 2018-2019, see AUTHORS for more details.

license

MIT, see LICENSE for more details.

class pip_services3_data.IFilteredPageReader.IFilteredPageReader

Bases: abc.ABC

Interface for data processing components that can retrieve a page of data items by a filter.

get_page_by_filter(correlation_id: Optional[str], filter: Optional[pip_services3_commons.data.FilterParams.FilterParams], paging: Optional[pip_services3_commons.data.PagingParams.PagingParams], sort: Optional[pip_services3_commons.data.SortParams.SortParams] = None)pip_services3_commons.data.DataPage.DataPage

Gets a page of data items using filter parameters.

Parameters
  • correlation_id – (optional) transaction id to trace execution through call chain.

  • filter – (optional) filter parameters

  • paging – (optional) paging parameters

  • sort – (optional) sort parameters

Returns

list of items