pip_services3_data package

Module contents

pip_services3_data.__init__

Contains interfaces for various design patterns that work with data.

copyright

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

license

MIT, see LICENSE for more details.

class pip_services3_data.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

class pip_services3_data.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

class pip_services3_data.IGetter

Bases: pip_services3_commons.data.IIdentifiable.IIdentifiable

Interface for data processing components that can get data items.

get_one_by_id(correlation_id: Optional[str], id: Any) → T

Gets a data items by its unique id.

Parameters

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

  • id – an id of item to be retrieved.

Returns

an item by its id.

id: Any
class pip_services3_data.ILoader

Bases: abc.ABC

Interface for data processing components that load data items.

load(correlation_id: Optional[str]) → List[T]

Loads data items.

Parameters

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

Returns

a list of data items

class pip_services3_data.IPartialUpdater

Bases: abc.ABC

Interface for data processing components to update data items partially.

update_partially(correlation_id: Optional[str], id: Any, data: pip_services3_commons.data.AnyValueMap.AnyValueMap) → T

Updates only few selected fields in a data item.

Parameters

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

  • id – an id of data item to be updated.

  • data – a map with fields to be updated.

Returns

updated item

class pip_services3_data.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

class pip_services3_data.IQuerableReader

Bases: abc.ABC

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

get_list_by_query(correlation_id: Optional[str], query: Optional[str], sort: Optional[pip_services3_commons.data.SortParams.SortParams] = None) → List[T]

Gets a list of data items using a query string.

Parameters

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

  • query – (optional) a query string

  • sort – (optional) sort parameters

Returns

list of items

class pip_services3_data.ISaver

Bases: object

Interface for data processing components that save data items.

save(correlation_id: Optional[str], items: List[T])

Saves given data items.

Parameters

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

  • items – a list of items to save.

class pip_services3_data.ISetter

Bases: object

Interface for data processing components that can set (create or update) data items.

set(correlation_id: Optional[str], item: T) → T

Sets a data item. If the data item exists it updates it, otherwise it create a new data item.

Parameters

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

  • item – a item to be set.

Returns

updated item

class pip_services3_data.IWriter

Bases: object

Interface for data processing components that can create, update and delete data items.

create(correlation_id: Optional[str], item: T) → T

Creates a data item.

Parameters

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

  • item – an item to be created.

Returns

created item

delete_by_id(correlation_id: Optional[str], id: Any) → T

Deleted a data item by it’s unique id.

Parameters

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

  • id – an id of the item to be deleted

Returns

deleted item.

update(correlation_id: Optional[str], item: T) → T

Updates a data item.

Parameters

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

  • item – an item to be updated.

Returns

updated item