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
resultset.type

Members list

Grouped members

Cursor Control

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Attributes

Source
resultset.scala

Results

def accumulate[G[_] : Alternative, A : Read]: 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: FactoryCompat[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: FactoryCompat[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: FactoryCompat[(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](n: Int)(implicit A: Read[A]): ResultSetIO[A]

Read a value of type A starting at column n.

Read a value of type A starting at column n.

Attributes

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

Read a value of type A starting at column 1.

Read a value of type A starting at column 1.

Attributes

Source
resultset.scala
def getNext[A : Read]: 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 : Read](chunkSize: Int): 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

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
UnexpectedContinuation

if there is more than one row remaining

Source
resultset.scala
def getUnique[A : Read]: 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
UnexpectedCursorPosition

if there is not exactly one row remaining

Source
resultset.scala
def list[A : Read]: 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

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
UnexpectedEnd

if there is not at least one row remaining

Source
resultset.scala
def stream[A : Read](chunkSize: Int): 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 : Read]: 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

Attributes

Source
resultset.scala

Attributes

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

Updates a value of type A starting at column n.

Updates a value of type A starting at column n.

Attributes

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

Updates a value of type A starting at column 1.

Updates a value of type A starting at column 1.

Attributes

Source
resultset.scala

Properties

Attributes

Source
resultset.scala
val getMetaData: ResultSetIO[ResultSetMetaData]

Attributes

Source
resultset.scala

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

Attributes

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

Attributes

Source
resultset.scala