Module jakarta.nosql.core

Package jakarta.nosql

Interface QueryMapper.MapperFrom

All Superinterfaces:

QueryMapper.MapperQueryBuild

Enclosing interface:

QueryMapper

public static interface QueryMapper.MapperFrom
extends QueryMapper.MapperQueryBuild

Represents the first step in the query fluent API.

Method Summary

Modifier and Type	Method	Description
QueryMapper.MapperLimit	limit(long limit)	Defines the maximum number of results to retrieve.
QueryMapper.MapperOrder	orderBy(String name)	Add the order how the result will return based on a given column name.
QueryMapper.MapperSkip	skip(long skip)	Defines the position of the first result to retrieve.
QueryMapper.MapperNameCondition	where(String name)	Starts a new condition by specifying a column name.

Methods inherited from interface jakarta.nosql.QueryMapper.MapperQueryBuild

result, singleResult, stream

Method Details

where

QueryMapper.MapperNameCondition where(String name)

Starts a new condition by specifying a column name.

Parameters:

name - the column name

Returns:

a new QueryMapper.MapperNameCondition

Throws:

NullPointerException - when name is null

skip

QueryMapper.MapperSkip skip(long skip)

Defines the position of the first result to retrieve.

Parameters:

skip - the first result to retrieve

Returns:

a query with the first result defined

Throws:

IllegalArgumentException - when skip is negative

limit

QueryMapper.MapperLimit limit(long limit)

Defines the maximum number of results to retrieve.

Parameters:

limit - the limit

Returns:

a query with the limit defined

Throws:

IllegalArgumentException - when limit is negative

orderBy

QueryMapper.MapperOrder orderBy(String name)

Add the order how the result will return based on a given column name.

Parameters:

name - the column name to be ordered

Returns:

a query with the sort defined

Throws:

NullPointerException - when name is null