• Home
• io.vertx
• vertx-mssql-client
• 4.5.8
• source code

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

x-mssql-client.4.5.8.source-code.cursor.adoc Maven / Gradle / Ivy

== Cursors and streaming

include::cursor_warning.adoc[opts=optional]

By default, prepared query execution fetches all rows, you can use a
{@link io.vertx.sqlclient.Cursor} to control the amount of rows you want to read:

[source,$lang]
----
{@link examples.SqlClientExamples#usingCursors01(io.vertx.sqlclient.SqlConnection)}
----

Cursors shall be closed when they are released prematurely:

[source,$lang]
----
{@link examples.SqlClientExamples#usingCursors02(io.vertx.sqlclient.Cursor)}
----

A stream API is also available for cursors, which can be more convenient, specially with the Rxified version.

[source,$lang]
----
{@link examples.SqlClientExamples#usingCursors03(io.vertx.sqlclient.SqlConnection)}
----

The stream read the rows by batch of `50` and stream them, when the rows have been passed to the handler,
a new batch of `50` is read and so on.

The stream can be resumed or paused, the loaded rows will remain in memory until they are delivered and the cursor
will stop iterating.