Module io.smallrye.mutiny.vertx.jdbc.client
Package io.vertx.mutiny.ext.sql

Class SQLRowStream

  • All Implemented Interfaces:
    io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>, io.vertx.mutiny.core.streams.StreamBase
    public class SQLRowStream
extends Object
implements io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>
    A ReadStream of Rows from the underlying RDBMS. This class follows the ReadStream semantics and will automatically close the underlying resources if all returned rows are returned. For cases where the results are ignored before the full processing of the returned rows is complete the close method **MUST** be called in order to release underlying resources. The interface is minimal in order to support all SQL clients not just JDBC.

    NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

    • Field Detail

      • __TYPE_ARG

        public static final io.smallrye.mutiny.vertx.TypeArg<SQLRowStream> __TYPE_ARG

    • Constructor Detail

      • SQLRowStream

        public SQLRowStream​(io.vertx.ext.sql.SQLRowStream delegate)

      • SQLRowStream

        public SQLRowStream​(Object delegate)

    • Method Detail

      • getDelegate

        public io.vertx.ext.sql.SQLRowStream getDelegate()
        Specified by:
        getDelegate in interface io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>
        Specified by:
        getDelegate in interface io.vertx.mutiny.core.streams.StreamBase

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • fetch

        public io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray> fetch​(long arg0)
        Specified by:
        fetch in interface io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>

      • pipe

        public io.vertx.mutiny.core.streams.Pipe<io.vertx.core.json.JsonArray> pipe()
        Specified by:
        pipe in interface io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>

      • pipeTo

        @CheckReturnValue
public io.smallrye.mutiny.Uni<Void> pipeTo​(io.vertx.mutiny.core.streams.WriteStream<io.vertx.core.json.JsonArray> dst)
        Specified by:
        pipeTo in interface io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>

      • pipeToAndAwait

        public Void pipeToAndAwait​(io.vertx.mutiny.core.streams.WriteStream<io.vertx.core.json.JsonArray> dst)
        Specified by:
        pipeToAndAwait in interface io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>

      • pipeToAndForget

        public void pipeToAndForget​(io.vertx.mutiny.core.streams.WriteStream<io.vertx.core.json.JsonArray> dst)
        Specified by:
        pipeToAndForget in interface io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>

      • exceptionHandler

        public SQLRowStream exceptionHandler​(Consumer<Throwable> handler)
        Specified by:
        exceptionHandler in interface io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>
        Specified by:
        exceptionHandler in interface io.vertx.mutiny.core.streams.StreamBase

      • handler

        public SQLRowStream handler​(Consumer<io.vertx.core.json.JsonArray> handler)
        Specified by:
        handler in interface io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>

      • pause

        public SQLRowStream pause()
        Specified by:
        pause in interface io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>

      • resume

        public SQLRowStream resume()
        Specified by:
        resume in interface io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>

      • endHandler

        public SQLRowStream endHandler​(Runnable endHandler)
        Specified by:
        endHandler in interface io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>

      • column

        public int column​(String name)
        Parameters:
        name - the column name
        Returns:
        the json array index

      • columns

        public List<String> columns()
        Returns:
        the list of columns names returned by the query

      • resultSetClosedHandler

        public SQLRowStream resultSetClosedHandler​(Runnable handler)
        Parameters:
        handler - called when the current result set is closed
        Returns:

      • moreResults

        public void moreResults()

      • close

        @CheckReturnValue
public io.smallrye.mutiny.Uni<Void> close()
        Closes the stream/underlying cursor(s). The actual close happens asynchronously.

        Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.

      • closeAndAwait

        public Void closeAndAwait()
        Blocking variant of close().

        This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

        Returns:
        the Void instance produced by the operation.

      • closeAndForget

        public void closeAndForget()
        Variant of close() that ignores the result of the operation.

        This method subscribes on the result of close(), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from close() but you don't need to compose it with other operations.

      • toMulti

        @CheckReturnValue
public io.smallrye.mutiny.Multi<io.vertx.core.json.JsonArray> toMulti()
        Specified by:
        toMulti in interface io.vertx.mutiny.core.streams.ReadStream<io.vertx.core.json.JsonArray>

      • toBlockingIterable

        public Iterable<io.vertx.core.json.JsonArray> toBlockingIterable()

      • toBlockingStream

        public Stream<io.vertx.core.json.JsonArray> toBlockingStream()

      • newInstance

        public static SQLRowStream newInstance​(io.vertx.ext.sql.SQLRowStream arg)