core
API
Generated with
core/doobie.hi/resultset

resultset

doobie.hi.resultset$
object resultset

Module of high-level constructors for ResultSetIO actions.

Attributes

Source:
resultset.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Cursor Control

def absolute(row: Int): ResultSetIO[Boolean]

Attributes

Source:
resultset.scala
val afterLast: ResultSetIO[Unit]

Attributes

Source:
resultset.scala
val beforeFirst: ResultSetIO[Unit]

Attributes

Source:
resultset.scala
val first: ResultSetIO[Boolean]

Attributes

Source:
resultset.scala
val getRow: ResultSetIO[Int]

Attributes

Source:
resultset.scala
val isAfterLast: ResultSetIO[Boolean]

Attributes

Source:
resultset.scala
val isBeforeFirst: ResultSetIO[Boolean]

Attributes

Source:
resultset.scala
val isFirst: ResultSetIO[Boolean]

Attributes

Source:
resultset.scala
val isLast: ResultSetIO[Boolean]

Attributes

Source:
resultset.scala
val last: ResultSetIO[Boolean]

Attributes

Source:
resultset.scala
val moveToCurrentRow: ResultSetIO[Unit]

Attributes

Source:
resultset.scala
val moveToInsertRow: ResultSetIO[Unit]

Attributes

Source:
resultset.scala
val next: ResultSetIO[Boolean]

Attributes

Source:
resultset.scala
val previous: ResultSetIO[Boolean]

Attributes

Source:
resultset.scala
val refreshRow: ResultSetIO[Unit]

Attributes

Source:
resultset.scala
def relative(n: Int): ResultSetIO[Boolean]

Attributes

Source:
resultset.scala
val rowDeleted: ResultSetIO[Boolean]

Attributes

Source:
resultset.scala
val rowInserted: ResultSetIO[Boolean]

Attributes

Source:
resultset.scala
val rowUpdated: ResultSetIO[Boolean]

Attributes

Source:
resultset.scala

Results

def accumulate[G[_], A](using evidence$3: Alternative[G], evidence$4: Read[A]): ResultSetIO[G[A]]

Like getNext but loops until the end of the resultset, gathering results in a MonadPlus.

Like getNext but loops until the end of the resultset, gathering results in a MonadPlus.

Attributes

Source:
resultset.scala
def build[F[_], A](implicit F: Factory[A, F[A]], A: Read[A]): ResultSetIO[F[A]]

Consumes the remainder of the resultset, reading each row as a value of type A and accumulating them in a standard library collection via CanBuildFrom.

Consumes the remainder of the resultset, reading each row as a value of type A and accumulating them in a standard library collection via CanBuildFrom.

Attributes

Source:
resultset.scala
def buildMap[F[_], A, B](f: A => B)(implicit F: Factory[B, F[B]], A: Read[A]): ResultSetIO[F[B]]

Consumes the remainder of the resultset, reading each row as a value of type A, mapping to B, and accumulating them in a standard library collection via CanBuildFrom. This unusual constructor is a workaround for the CanBuildFrom not having a sensible contravariant functor instance.

Consumes the remainder of the resultset, reading each row as a value of type A, mapping to B, and accumulating them in a standard library collection via CanBuildFrom. This unusual constructor is a workaround for the CanBuildFrom not having a sensible contravariant functor instance.

Attributes

Source:
resultset.scala
def buildPair[F[_, _], A, B](implicit F: Factory[(A, B), F[A, B]], A: Read[(A, B)]): ResultSetIO[F[A, B]]

Consumes the remainder of the resultset, reading each row as a value of type (A, B) and accumulating them in a standard library collection via CanBuildFrom.

Consumes the remainder of the resultset, reading each row as a value of type (A, B) and accumulating them in a standard library collection via CanBuildFrom.

Attributes

Source:
resultset.scala
def get[A](implicit A: Read[A]): ResultSetIO[A]

Read a value of type A.

Read a value of type A.

Attributes

Source:
resultset.scala
def getNext[A](using evidence$5: Read[A]): ResultSetIO[Option[A]]

Similar to next >> get but lifted into Option; returns None when no more rows are available.

Similar to next >> get but lifted into Option; returns None when no more rows are available.

Attributes

Source:
resultset.scala
def getNextChunk[A](chunkSize: Int)(using evidence$6: Read[A]): ResultSetIO[Seq[A]]

Similar to getNext but reads chunkSize rows at a time (the final chunk in a resultset may be smaller). A non-positive chunkSize yields an empty Seq and consumes no rows. This method delegates to getNextChunkV and widens to Seq for easier interoperability with streaming libraries that like Seq better.

Similar to getNext but reads chunkSize rows at a time (the final chunk in a resultset may be smaller). A non-positive chunkSize yields an empty Seq and consumes no rows. This method delegates to getNextChunkV and widens to Seq for easier interoperability with streaming libraries that like Seq better.

Attributes

Source:
resultset.scala
def getNextChunkV[A](chunkSize: Int)(implicit A: Read[A]): ResultSetIO[Vector[A]]

Similar to getNext but reads chunkSize rows at a time (the final chunk in a resultset may be smaller). A non-positive chunkSize yields an empty Vector and consumes no rows.

Similar to getNext but reads chunkSize rows at a time (the final chunk in a resultset may be smaller). A non-positive chunkSize yields an empty Vector and consumes no rows.

Attributes

Source:
resultset.scala
def getOption[A](using evidence$8: Read[A]): ResultSetIO[Option[A]]

Equivalent to getNext, but verifies that there is at most one row remaining.

Equivalent to getNext, but verifies that there is at most one row remaining.

Attributes

Throws:
doobie.util.invariant.UnexpectedContinuation

if there is more than one row remaining

Source:
resultset.scala
def getUnique[A](using evidence$7: Read[A]): ResultSetIO[A]

Equivalent to getNext, but verifies that there is exactly one row remaining.

Equivalent to getNext, but verifies that there is exactly one row remaining.

Attributes

Throws:
doobie.util.invariant.UnexpectedCursorPosition

if there is not exactly one row remaining

Source:
resultset.scala
def list[A](using evidence$2: Read[A]): ResultSetIO[List[A]]

Consumes the remainder of the resultset, reading each row as a value of type A and accumulating them in a List.

Consumes the remainder of the resultset, reading each row as a value of type A and accumulating them in a List.

Attributes

Source:
resultset.scala
def nel[A](using evidence$9: Read[A]): ResultSetIO[NonEmptyList[A]]

Consumes the remainder of the resultset, but verifies that there is at least one row remaining.

Consumes the remainder of the resultset, but verifies that there is at least one row remaining.

Attributes

Throws:
doobie.util.invariant.UnexpectedEnd

if there is not at least one row remaining

Source:
resultset.scala
def stream[A](chunkSize: Int)(using evidence$10: Read[A]): Stream[ResultSetIO, A]

Stream that reads from the ResultSet and returns a stream of As. This is the preferred mechanism for dealing with query results.

Stream that reads from the ResultSet and returns a stream of As. This is the preferred mechanism for dealing with query results.

Attributes

Source:
resultset.scala
def vector[A](using evidence$1: Read[A]): ResultSetIO[Vector[A]]

Consumes the remainder of the resultset, reading each row as a value of type A and accumulating them in a Vector.

Consumes the remainder of the resultset, reading each row as a value of type A and accumulating them in a Vector.

Attributes

Source:
resultset.scala

Updating

val cancelRowUpdates: ResultSetIO[Unit]

Attributes

Source:
resultset.scala
val deleteRow: ResultSetIO[Unit]

Attributes

Source:
resultset.scala
val insertRow: ResultSetIO[Unit]

Attributes

Source:
resultset.scala
def update[A](a: A)(implicit A: Write[A]): ResultSetIO[Unit]

Updates a value of type A.

Updates a value of type A.

Attributes

Source:
resultset.scala

Properties

val getFetchDirection: ResultSetIO[FetchDirection]

Attributes

Source:
resultset.scala
val getFetchSize: ResultSetIO[Int]

Attributes

Source:
resultset.scala
val getHoldability: ResultSetIO[Holdability]

Attributes

Source:
resultset.scala
val getMetaData: ResultSetIO[ResultSetMetaData]

Attributes

Source:
resultset.scala
def setFetchDirection(fd: FetchDirection): ResultSetIO[Unit]

Attributes

Source:
resultset.scala
def setFetchSize(n: Int): ResultSetIO[Unit]

Attributes

Source:
resultset.scala

Constructors (Lifting)

def delay[A](a: => A): ResultSetIO[A]

Non-strict unit for capturing effects.

Non-strict unit for capturing effects.

Attributes

Source:
resultset.scala

Warnings

val clearWarnings: ResultSetIO[Unit]

Attributes

Source:
resultset.scala
val getWarnings: ResultSetIO[Option[SQLWarning]]

Attributes

Source:
resultset.scala
Generated with