read

Documentation

Index

• type IFilteredPageReader
• type IFilteredReader
• type IGetter
• type ILoader
• type IQuerablePageReader
• type IQuerableReader

Types

type IFilteredPageReader

type IFilteredPageReader[T any] interface {

	// GetPageByFilter gets a page of data items using filter
	//	Parameters:
	//		- ctx context.Context execution context to trace execution through call chain.
	//		- filter  data.FilterParams filter parameters
	//		- paging data.PagingParams paging parameters
	//		- sort data.SortParams sort parameters
	//	Returns: data.DataPage[T], error list of items or error.
	GetPageByFilter(ctx context.Context,
		filter cquery.FilterParams, paging cquery.PagingParams, sort cquery.SortParams) (page cquery.DataPage[T], err error)
}

IFilteredPageReader is interface for data processing components that can retrieve a page of data items by a filter.

Typed params:
	- T any type

type IFilteredReader

type IFilteredReader[T any] interface {

	// GetListByFilter gets a list of data items using filter
	//	Parameters:
	//		- ctx context.Context execution context to trace execution through call chain.
	//		- filter data.FilterParams filter parameters
	//		- sort  data.SortParams sort parameters
	//	Returns: []T, error receives list of items or error.
	GetListByFilter(ctx context.Context,
		filter cquery.FilterParams, sort cquery.SortParams) (items []T, err error)
}

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

Typed params:
	- T any type

type IGetter

type IGetter[T cdata.IIdentifiable[T], K any] interface {

	// GetOneById a data items by its unique id.
	//	Parameters:
	//		- ctx context.Context execution context to trace execution through call chain.
	//		- id an id of item to be retrieved.
	//	Returns: T, error item or error
	GetOneById(ctx context.Context, id K) (item T, err error)
}

IGetter Interface for data processing components that can get data items.

Typed params:
	- T cdata.IIdentifiable[T] any type
	- K any type of id (key)

type ILoader

type ILoader[T any] interface {

	// Load data items.
	//	Parameters:
	//		- ctx context.Context execution context to trace execution through call chain.
	//	Returns: []T, error a list of data items or error.
	Load(ctx context.Context) (items []T, err error)
}

ILoader interface for data processing components that load data items.

Typed params:
	- T any type of getting element

type IQuerablePageReader

type IQuerablePageReader[T any] interface {

	// GetPageByQuery gets a page of data items using a query string.
	//	Parameters:
	//		- ctx context.Context execution context to trace execution through call chain.
	//		- query string a query string
	//		- paging data.PagingParams paging parameters
	//		- sort  data.SortParams sort parameters
	//	Returns: data.DataPage[T], error receives list of items or error.
	GetPageByQuery(ctx context.Context,
		query string, paging cquery.PagingParams, sort cquery.SortParams) (page cquery.DataPage[T], err error)
}

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

Typed params:
	- T any type

type IQuerableReader

type IQuerableReader[T any] interface {

	// GetListByQuery gets a list of data items using a query string.
	//	Parameters:
	//		- ctx context.Context execution context to trace execution through call chain.
	//		- query string a query string
	//		- sort data.SortParams sort parameters
	// Returns []T, error list of items or error.
	GetListByQuery(ctx context.Context,
		query string, sort cquery.SortParams) (items []T, err error)
}

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

Typed params:
	- T any type