IQuerablePageReader

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

Description

The IQuerablePageReader[T any] interface is used by data processing components that can query a page of data items.

  • T any type

Methods

GetPageByQuery

Gets a page of data items using a query string.

GetPageByQuery(ctx context.Context, correlation_id string, query string, paging *data.PagingParams, sort *data.SortParams) (page DataPage[T], err error)

  • ctx: context.Context - operation context.
  • correlationId: string - (optional) transaction id used to trace execution through the call chain.
  • query: string - (optional) query string
  • paging: *data.PagingParams - (optional) paging parameters
  • sort: *data.SortParams - (optional) sorting parameters
  • returns: (page DataPage[T], err error) - list of items