pip_services3_data.IQuerablePageReader module

pip_services3_data.IQuerablePageReader

Interface for querable 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.IQuerablePageReader.IQuerablePageReader

Bases: abc.ABC

Interface for data processing components that can query a page of data items.

get_page_by_query(correlation_id: Optional[str], query: Optional[str], 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 a query string.

Parameters

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

  • query – (optional) a query string

  • paging – (optional) paging parameters

  • sort – (optional) sort parameters

Returns

list of items