Package io.vertx.reactivex.sqlclient
Class Cursor
- java.lang.Object
-
- io.vertx.reactivex.sqlclient.Cursor
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate
public class Cursor extends Object implements io.vertx.lang.rx.RxDelegate
A cursor that reads progressively rows from the database, it is useful for reading very large result sets.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<Cursor>__TYPE_ARG
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Future<Void>close()Release the cursor.booleanequals(Object o)CursorgetDelegate()inthashCode()booleanhasMore()Returnstruewhen the cursor has results in progress and theread(int)should be called to retrieve them.booleanisClosed()static CursornewInstance(Cursor arg)Future<RowSet<Row>>read(int count)Read rows from the cursor, the result is provided asynchronously to thehandler.CompletablerxClose()Release the cursor.Single<RowSet<Row>>rxRead(int count)Read rows from the cursor, the result is provided asynchronously to thehandler.StringtoString()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<Cursor> __TYPE_ARG
-
-
Method Detail
-
getDelegate
public Cursor getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
read
public Future<RowSet<Row>> read(int count)
Read rows from the cursor, the result is provided asynchronously to thehandler.- Parameters:
count- the amount of rows to read- Returns:
- a future notified with the result
-
rxRead
public Single<RowSet<Row>> rxRead(int count)
Read rows from the cursor, the result is provided asynchronously to thehandler.- Parameters:
count- the amount of rows to read- Returns:
- a future notified with the result
-
hasMore
public boolean hasMore()
Returnstruewhen the cursor has results in progress and theread(int)should be called to retrieve them.- Returns:
- whether the cursor has more results,
-
close
public Future<Void> close()
Release the cursor. It should be called for prepared queries executed with a fetch size.- Returns:
-
rxClose
public Completable rxClose()
Release the cursor. It should be called for prepared queries executed with a fetch size.- Returns:
-
isClosed
public boolean isClosed()
- Returns:
- whether the cursor is closed
-
-