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 util
    Definition Classes
    doobie
  • object query

    Module defining queries parameterized by input and output types.

    Module defining queries parameterized by input and output types.

    Definition Classes
    util
  • Query
  • Query0

trait Query0[B] extends AnyRef

An abstract query closed over its input arguments and yielding values of type B, without a specified disposition. Methods provided on Query0 allow the query to be interpreted as a stream or program in CollectionIO.

Self Type
Query0[B]
Source
query.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Query0
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def accumulate[F[_]](implicit arg0: Alternative[F]): free.connection.ConnectionIO[F[B]]

    Program in ConnectionIO yielding an F[B] accumulated via MonadPlus append.

    Program in ConnectionIO yielding an F[B] accumulated via MonadPlus append. This method is more general but less efficient than to.

  2. abstract def analysis: free.connection.ConnectionIO[Analysis]

    Program to construct an analysis of this query's SQL statement and asserted parameter and column types.

  3. abstract def inspect[R](f: (String, free.preparedstatement.PreparedStatementIO[Unit]) => free.connection.ConnectionIO[R]): free.connection.ConnectionIO[R]

    Program to construct an inspection of the query.

    Program to construct an inspection of the query. Calls f with the SQL representation of the query and a statement with all statement arguments set. Returns the result of the ConnectionIO program constructed.

  4. abstract def map[C](f: (B) => C): Query0[C]

  5. abstract def nel: free.connection.ConnectionIO[NonEmptyList[B]]

    Program in ConnectionIO yielding a NonEmptyList[B] and raising an exception if the resultset does not have at least one row.

    Program in ConnectionIO yielding a NonEmptyList[B] and raising an exception if the resultset does not have at least one row. See also unique.

  6. abstract def option: free.connection.ConnectionIO[Option[B]]

    Program in ConnectionIO yielding an optional B and raising an exception if the resultset has more than one row.

    Program in ConnectionIO yielding an optional B and raising an exception if the resultset has more than one row. See also unique.

  7. abstract def outputAnalysis: free.connection.ConnectionIO[Analysis]

    Program to construct an analysis of this query's SQL statement and result set column types.

  8. abstract def pos: Option[Pos]

    An optional Pos indicating the source location where this Query was constructed.

    An optional Pos indicating the source location where this Query was constructed. This is used only for diagnostic purposes.

  9. abstract def sql: String

    The SQL string.

  10. abstract def streamWithChunkSize(n: Int): Stream[free.connection.ConnectionIO, B]

    Stream with given chunk factor, with effect type ConnectionIO yielding elements of type B.

  11. abstract def to[F[_]](implicit f: Factory[B, F[B]]): free.connection.ConnectionIO[F[B]]

    Program in ConnectionIO yielding an F[B] accumulated via the provided CanBuildFrom.

    Program in ConnectionIO yielding an F[B] accumulated via the provided CanBuildFrom. This is the fastest way to accumulate a collection.

  12. abstract def toFragment: fragment.Fragment

    Convert this Query0 to a Fragment.

  13. abstract def toMap[K, V](implicit ev: =:=[B, (K, V)], f: Factory[(K, V), Map[K, V]]): free.connection.ConnectionIO[Map[K, V]]

    Apply the argument a to construct a program in ConnectionIO yielding an Map[(K, V)] accumulated via the provided CanBuildFrom.

    Apply the argument a to construct a program in ConnectionIO yielding an Map[(K, V)] accumulated via the provided CanBuildFrom. This is the fastest way to accumulate a collection. this function can call only when B is (K, V).

  14. abstract def unique: free.connection.ConnectionIO[B]

    Program in ConnectionIO yielding a unique B and raising an exception if the resultset does not have exactly one row.

    Program in ConnectionIO yielding a unique B and raising an exception if the resultset does not have exactly one row. See also option.

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def stream: Stream[free.connection.ConnectionIO, B]

    Stream with default chunk factor, with effect type ConnectionIO yielding elements of type B.

  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  19. 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

Diagnostics

Results

Transformations

Ungrouped