pip_services3_data.IFilteredReader module

pip_services3_data.IFilteredReader

Interface for filtered 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.IFilteredReader.IFilteredReader

Bases: abc.ABC

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

get_list_by_filter(correlation_id: Optional[str], filter: Optional[pip_services3_commons.data.FilterParams.FilterParams], sort: Optional[pip_services3_commons.data.SortParams.SortParams] = None) → List[T]

Gets a list of data items using filter parameters.

Parameters

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

  • filter – (optional) filter parameters

  • sort – (optional) sort parameters

  • paging – (optional) paging parameters

Returns

list of items