jakarta.nosql.document

Interface DocumentQuery.DocumentFrom

All Superinterfaces:

DocumentQuery.DocumentQueryBuild

Enclosing interface:

DocumentQuery

public static interface DocumentQuery.DocumentFrom
extends DocumentQuery.DocumentQueryBuild

The DocumentFrom Query

Method Summary

Modifier and Type	Method and Description
DocumentQuery.DocumentLimit	limit(long limit) Defines the maximum number of results to retrieve.
DocumentQuery.DocumentOrder	orderBy(String name) Add the order how the result will returned
DocumentQuery.DocumentSkip	skip(long skip) Defines the position of the first result to retrieve.
DocumentQuery.DocumentNameCondition	where(String name) Starts a new condition defining the column name

Methods inherited from interface jakarta.nosql.document.DocumentQuery.DocumentQueryBuild

build, getResult, getSingleResult

Method Detail

where

DocumentQuery.DocumentNameCondition where(String name)

Starts a new condition defining the column name

Parameters:

name - the column name

Returns:

a new DocumentQuery.DocumentNameCondition

Throws:

NullPointerException - when name is null

skip

DocumentQuery.DocumentSkip skip(long skip)

Defines the position of the first result to retrieve.

Parameters:

skip - the first result to retrive

Returns:

a query with first result defined

limit

DocumentQuery.DocumentLimit limit(long limit)

Defines the maximum number of results to retrieve.

Parameters:

limit - the limit

Returns:

a query with the limit defined

orderBy

DocumentQuery.DocumentOrder orderBy(String name)

Add the order how the result will returned

Parameters:

name - the order

Returns:

a query with the sort defined

Throws:

NullPointerException - when name is null