io.picodata.driver.mappers

Interface TarantoolTupleResultMapperFactory

All Known Implementing Classes:

TarantoolTupleResultMapperFactoryImpl

public interface TarantoolTupleResultMapperFactory

Provides factory that creates result mappers for parsing TarantoolResult<TarantoolTuple> from various structures

Method Summary

Modifier and Type	Method and Description
TarantoolResultMapper<TarantoolTuple>	withArrayValueToTarantoolTupleResultConverter(MessagePackMapper messagePackMapper) Mapper parses result from a list of tuples.
TarantoolResultMapper<TarantoolTuple>	withArrayValueToTarantoolTupleResultConverter(MessagePackMapper messagePackMapper, TarantoolSpaceMetadata spaceMetadata) Mapper parses result from a list of tuples.
CallResultMapper<TarantoolResult<TarantoolTuple>,MultiValueCallResult<TarantoolTuple,TarantoolResult<TarantoolTuple>>>	withMultiValueArrayToTarantoolTupleResultMapper(MessagePackMapper messagePackMapper, TarantoolSpaceMetadata spaceMetadata) Mapper for the stored Lua function call result, interpreted in a way that each returned item is a tuple.
TarantoolResultMapper<TarantoolTuple>	withRowsMetadataToTarantoolTupleResultConverter(MessagePackMapper messagePackMapper) Mapper parses result from a map with list of tuples and metadata.
TarantoolResultMapper<TarantoolTuple>	withRowsMetadataToTarantoolTupleResultConverter(MessagePackMapper messagePackMapper, TarantoolSpaceMetadata spaceMetadata) Mapper parses result from a map with list of tuples and metadata.
CallResultMapper<TarantoolResult<TarantoolTuple>,SingleValueCallResult<TarantoolResult<TarantoolTuple>>>	withSingleValueArrayToTarantoolTupleResultMapper(MessagePackMapper messagePackMapper, TarantoolSpaceMetadata spaceMetadata) Mapper for single the stored Lua function call result in the form return result, err with a list of tuples as a result.
CallResultMapper<TarantoolResult<TarantoolTuple>,SingleValueCallResult<TarantoolResult<TarantoolTuple>>>	withSingleValueRowsMetadataToTarantoolTupleResultMapper(MessagePackMapper messagePackMapper, TarantoolSpaceMetadata spaceMetadata) Mapper for single the stored Lua function call result in the form return result, err with a list of tuples as a result.

Method Detail

withArrayValueToTarantoolTupleResultConverter

TarantoolResultMapper<TarantoolTuple> withArrayValueToTarantoolTupleResultConverter(MessagePackMapper messagePackMapper)

Mapper parses result from a list of tuples. Use this mapper for handling containers with TarantoolTuple inside. The IProto method results by default contain lists of tuples. This mapper can be used at the inner level by other mapper factories that are handling higher-level containers.

input: array of tuples with MessagePack values inside ([t1, t2, ...])
mapper result: TarantoolResult<TarantoolTuple>

Returned TarantoolResult doesn't store metadata, and you can't get field by field name

Parameters:

messagePackMapper - MessagePack-to-entity converter for tuples

Returns:

mapper that parses list of arrays to TarantoolResult<TarantoolTuple>

withArrayValueToTarantoolTupleResultConverter

TarantoolResultMapper<TarantoolTuple> withArrayValueToTarantoolTupleResultConverter(MessagePackMapper messagePackMapper,
                                                                                    TarantoolSpaceMetadata spaceMetadata)

Mapper parses result from a list of tuples. Use this mapper for handling containers with TarantoolTuple inside. The IProto method results by default contain lists of tuples. This mapper can be used at the inner level by other mapper factories that are handling higher-level containers.

input: array of tuples with MessagePack values inside ([t1, t2, ...])
mapper result: TarantoolResult<TarantoolTuple>

For example, it can be used to parse result from IPROTO_SELECT

Parameters:

messagePackMapper - MessagePack-to-entity converter for tuples

spaceMetadata - space metadata to parse values by their names

Returns:

mapper that parses list of arrays to TarantoolResult<TarantoolTuple>

withRowsMetadataToTarantoolTupleResultConverter

TarantoolResultMapper<TarantoolTuple> withRowsMetadataToTarantoolTupleResultConverter(MessagePackMapper messagePackMapper)

Mapper parses result from a map with list of tuples and metadata. Use this mapper for handling containers with TarantoolTuple inside. The crud method results by default contain map with list of tuples and metadata. This mapper can be used at the inner level by other mapper factories that are handling higher-level containers.

input: map with metadata and array of tuples with MessagePack values inside ([t1, t2, ...])
mapper result: TarantoolResult<TarantoolTuple>

Returned TarantoolResult doesn't store metadata, and you can't get field by field name

Parameters:

messagePackMapper - MessagePack-to-entity converter for tuples

Returns:

mapper that parses map to TarantoolResult<TarantoolTuple>

withRowsMetadataToTarantoolTupleResultConverter

TarantoolResultMapper<TarantoolTuple> withRowsMetadataToTarantoolTupleResultConverter(MessagePackMapper messagePackMapper,
                                                                                      TarantoolSpaceMetadata spaceMetadata)

Mapper parses result from a map with list of tuples and metadata. Use this mapper for handling containers with TarantoolTuple inside. The crud method results by default contain map with list of tuples and metadata. This mapper can be used at the inner level by other mapper factories that are handling higher-level containers.

input: map with metadata and array of tuples with MessagePack values inside ([t1, t2, ...])
mapper result: TarantoolResult<TarantoolTuple>

Parameters:

messagePackMapper - MessagePack-to-entity converter for tuples

spaceMetadata - space metadata to parse values by their names

Returns:

mapper that parses map to TarantoolResult<TarantoolTuple>

withSingleValueArrayToTarantoolTupleResultMapper

CallResultMapper<TarantoolResult<TarantoolTuple>,SingleValueCallResult<TarantoolResult<TarantoolTuple>>> withSingleValueArrayToTarantoolTupleResultMapper(MessagePackMapper messagePackMapper,
                                                                                                                                                          TarantoolSpaceMetadata spaceMetadata)

Mapper for single the stored Lua function call result in the form return result, err with a list of tuples as a result. For example, this form of the result is used for some return from lua function like box.space.select

input: [x, y, ...], MessagePack array from a Lua function multi-return response
where x is a data structure with an array of tuples inside ([t1, t2, ...]) and y can be interpreted as an error structure if it is not empty and there are no more arguments after y`
mapper result: converted value of x to TarantoolResult<TarantoolTuple>

Mapper result and the inner contents depend on the parameters or the passed converters.

Parameters:

messagePackMapper - MessagePack-to-entity converter for tuples

spaceMetadata - space metadata to parse values by their names

Returns:

default mapper for single value call result with a list of tuples

withSingleValueRowsMetadataToTarantoolTupleResultMapper

CallResultMapper<TarantoolResult<TarantoolTuple>,SingleValueCallResult<TarantoolResult<TarantoolTuple>>> withSingleValueRowsMetadataToTarantoolTupleResultMapper(MessagePackMapper messagePackMapper,
                                                                                                                                                                 TarantoolSpaceMetadata spaceMetadata)

Mapper for single the stored Lua function call result in the form return result, err with a list of tuples as a result. For example, this form of the result is used for some return from lua function like crud.select

input: [x, y, ...], MessagePack array from a Lua function multi-return response
where x map with metadata and array of tuples with MessagePack values inside ([t1, t2, ...])
mapper result: converted value of x to TarantoolResult<TarantoolTuple>

Parameters:

messagePackMapper - MessagePack-to-entity converter for tuples

spaceMetadata - space metadata to parse values by their names

Returns:

mapper for single value call result with a list of tuples

withMultiValueArrayToTarantoolTupleResultMapper

CallResultMapper<TarantoolResult<TarantoolTuple>,MultiValueCallResult<TarantoolTuple,TarantoolResult<TarantoolTuple>>> withMultiValueArrayToTarantoolTupleResultMapper(MessagePackMapper messagePackMapper,
                                                                                                                                                                       TarantoolSpaceMetadata spaceMetadata)

Mapper for the stored Lua function call result, interpreted in a way that each returned item is a tuple. Use this factory for handling proxy function call results which return tuples as a multi-return result.

input: [x, y, z, ...], MessagePack array from a Lua function multi-return response
where x, y, z are some MessagePack values, each one representing a Tarantool tuple
mapper result: TarantoolResult<TarantoolTuple> converted from [x, y, z, ...]

Mapper result and its inner contents depend on the parameters or the passed converters.

Parameters:

messagePackMapper - MessagePack-to-entity converter for tuples

spaceMetadata - space metadata to parse values by their names

Returns:

mapper for multi value call result as a list of tuples