com.faunadb.client.query

Class Pagination

java.lang.Object

com.faunadb.client.query.Expr

com.faunadb.client.query.Pagination

public final class Pagination
extends Expr

A pagination expression.

Example: We can paginate all instances of a class, with its evets, in pages with 4 elements only.

 client.query(
    Paginate(Match(Ref("indexes/all_spells"))
      .withEvents(true)
      .withSize(4)
 );
 

See Also:

Language.Paginate(Expr), FaunaDB Read Functions

Method Summary

Modifier and Type	Method and Description
Pagination	after(Expr cursor) Sets the cursor of the pagination to move forward.
Pagination	before(Expr cursor) Sets the cursor of the pagination to move backwards.
Pagination	events(boolean events) Define if the pagination should include events of not
Pagination	events(Expr events) Define if the pagination should include events of not
Pagination	size(Expr size) Sets the size of the pagination
Pagination	size(Integer size) Sets the size of the pagination
Pagination	sources(boolean sources) Define if the pagination should include sources of not
Pagination	sources(Expr sources) Define if the pagination should include sources of not
protected ImmutableMap<String,Expr>	toJson()
Pagination	ts(Expr ts) Sets the timestamp for the pagination
Pagination	ts(Long ts) Sets the timestamp for the pagination

Methods inherited from class com.faunadb.client.query.Expr

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

toJson

protected ImmutableMap<String,Expr> toJson()

Specified by:

toJson in class Expr

before

public Pagination before(Expr cursor)

Sets the cursor of the pagination to move backwards.

Parameters:

cursor - the cursor

Returns:

a new pagination with the cursor set

after

public Pagination after(Expr cursor)

Sets the cursor of the pagination to move forward.

Parameters:

cursor - the cursor

Returns:

a new pagination with the cursor set

ts

public Pagination ts(Expr ts)

Sets the timestamp for the pagination

Parameters:

ts - the desired timestamp

Returns:

a new pagination with the timestamp set

ts

public Pagination ts(Long ts)

Sets the timestamp for the pagination

Parameters:

ts - the desired timestamp

Returns:

a new pagination with the timestamp set

size

public Pagination size(Expr size)

Sets the size of the pagination

Parameters:

size - the desired size

Returns:

a new pagination with the size set

size

public Pagination size(Integer size)

Sets the size of the pagination

Parameters:

size - the desired size

Returns:

a new pagination with the size set

sources

public Pagination sources(Expr sources)

Define if the pagination should include sources of not

Returns:

a new pagination with sources option set

sources

public Pagination sources(boolean sources)

Define if the pagination should include sources of not

Returns:

a new pagination with sources option set

events

public Pagination events(Expr events)

Define if the pagination should include events of not

Returns:

a new pagination with events option set

events

public Pagination events(boolean events)

Define if the pagination should include events of not

Returns:

a new pagination with events option set