Packages

  • package root
    Definition Classes
    root
  • package doobie

    Top-level import, providing aliases for the most commonly used types and modules from doobie-free and doobie-core.

    Top-level import, providing aliases for the most commonly used types and modules from doobie-free and doobie-core. A typical starting set of imports would be something like this.

    import cats.implicits.*
import doobie._, doobie.implicits.*
    Definition Classes
    root
    See also

    The doobie microsite for much more information.

  • package hi

    High-level database API.

    High-level database API. The constructors here are defined in terms of those in doobie.free.connection but differ in the following ways:

    • Enumerated values represented by Int values in JDBC are mapped to one of the proper types defined in doobie.enumerated.
    • Nullable values are represented in terms of Option.
    • Java collection types are translated to immutable Scala equivalents.
    • Actions that compute lifetime-managed resources do not return the resource directly, but rather take a continuation in the resource's monad.
    • Actions that compute values of impure types (CLOB, InputStream, etc.) do not appear in this API. They are available in the low-level API but must be used with considerable caution.
    • Lifting actions, low-level type mapping actions, and resource management actions do not appear in this API.
    Definition Classes
    doobie
  • connection
  • preparedstatement
  • resultset
  • statement
o

doobie.hi

resultset

object resultset

Module of high-level constructors for ResultSetIO actions.

Source
resultset.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. resultset
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def absolute(row: Int): free.resultset.ResultSetIO[Boolean]

  5. def accumulate[G[_], A](implicit arg0: Alternative[G], arg1: util.Read[A]): free.resultset.ResultSetIO[G[A]]

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

  6. val afterLast: free.resultset.ResultSetIO[Unit]

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val beforeFirst: free.resultset.ResultSetIO[Unit]

  9. def build[F[_], A](implicit F: Factory[A, F[A]], A: util.Read[A]): free.resultset.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.

    Annotations
    @SuppressWarnings()
  10. def buildMap[F[_], A, B](f: (A) => B)(implicit F: Factory[B, F[B]], A: util.Read[A]): free.resultset.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.

    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.

    Annotations
    @SuppressWarnings()
  11. def buildPair[F[_, _], A, B](implicit F: Factory[(A, B), F[A, B]], A: util.Read[(A, B)]): free.resultset.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.

    Annotations
    @SuppressWarnings()
  12. val cancelRowUpdates: free.resultset.ResultSetIO[Unit]

  13. val clearWarnings: free.resultset.ResultSetIO[Unit]

  14. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  15. def delay[A](a: => A): free.resultset.ResultSetIO[A]

    Non-strict unit for capturing effects.

  16. val deleteRow: free.resultset.ResultSetIO[Unit]

  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. val first: free.resultset.ResultSetIO[Boolean]

  20. def get[A](implicit A: util.Read[A]): free.resultset.ResultSetIO[A]

    Read a value of type A.

  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. val getFetchDirection: free.resultset.ResultSetIO[FetchDirection]

  23. val getFetchSize: free.resultset.ResultSetIO[Int]

  24. val getHoldability: free.resultset.ResultSetIO[Holdability]

  25. val getMetaData: free.resultset.ResultSetIO[ResultSetMetaData]

  26. def getNext[A](implicit arg0: util.Read[A]): free.resultset.ResultSetIO[Option[A]]

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

  27. def getNextChunk[A](chunkSize: Int)(implicit arg0: util.Read[A]): free.resultset.ResultSetIO[Seq[A]]

    Similar to getNext but reads chunkSize rows at a time (the final chunk in a resultset may be smaller).

    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.

  28. def getNextChunkV[A](chunkSize: Int)(implicit A: util.Read[A]): free.resultset.ResultSetIO[Vector[A]]

    Similar to getNext but reads chunkSize rows at a time (the final chunk in a resultset may be smaller).

    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.

    Annotations
    @SuppressWarnings()
  29. def getOption[A](implicit arg0: util.Read[A]): free.resultset.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.

    Exceptions thrown

    doobie.util.invariant.UnexpectedContinuation if there is more than one row remaining

  30. val getRow: free.resultset.ResultSetIO[Int]

  31. def getUnique[A](implicit arg0: util.Read[A]): free.resultset.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.

    Exceptions thrown

    doobie.util.invariant.UnexpectedCursorPosition if there is not exactly one row remaining

  32. val getWarnings: free.resultset.ResultSetIO[Option[SQLWarning]]

  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. val insertRow: free.resultset.ResultSetIO[Unit]

  35. val isAfterLast: free.resultset.ResultSetIO[Boolean]

  36. val isBeforeFirst: free.resultset.ResultSetIO[Boolean]

  37. val isFirst: free.resultset.ResultSetIO[Boolean]

  38. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  39. val isLast: free.resultset.ResultSetIO[Boolean]

  40. val last: free.resultset.ResultSetIO[Boolean]

  41. def list[A](implicit arg0: util.Read[A]): free.resultset.ResultSetIO[List[A]]

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

  42. val moveToCurrentRow: free.resultset.ResultSetIO[Unit]

  43. val moveToInsertRow: free.resultset.ResultSetIO[Unit]

  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. def nel[A](implicit arg0: util.Read[A]): free.resultset.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.

    Exceptions thrown

    doobie.util.invariant.UnexpectedEnd if there is not at least one row remaining

  46. val next: free.resultset.ResultSetIO[Boolean]

  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  49. val previous: free.resultset.ResultSetIO[Boolean]

  50. val refreshRow: free.resultset.ResultSetIO[Unit]

  51. def relative(n: Int): free.resultset.ResultSetIO[Boolean]

  52. val rowDeleted: free.resultset.ResultSetIO[Boolean]

  53. val rowInserted: free.resultset.ResultSetIO[Boolean]

  54. val rowUpdated: free.resultset.ResultSetIO[Boolean]

  55. def setFetchDirection(fd: FetchDirection): free.resultset.ResultSetIO[Unit]

  56. def setFetchSize(n: Int): free.resultset.ResultSetIO[Unit]

  57. def stream[A](chunkSize: Int)(implicit arg0: util.Read[A]): Stream[free.resultset.ResultSetIO, A]

    Stream that reads from the ResultSet and returns a stream of As.

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

  58. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  59. def toString(): String
    Definition Classes
    AnyRef → Any
  60. def update[A](a: A)(implicit A: util.Write[A]): free.resultset.ResultSetIO[Unit]

    Updates a value of type A.

  61. def vector[A](implicit arg0: util.Read[A]): free.resultset.ResultSetIO[Vector[A]]

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

  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Constructors (Lifting)

Cursor Control

Properties

Results

Updating

Warnings

Ungrouped