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

    Collection of modules for typeclasses and other helpful bits.

    Collection of modules for typeclasses and other helpful bits.

    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 Query[A, B] extends AnyRef

A query parameterized by some input type A yielding values of type B. We define here the core operations that are needed. Additional operations are provided on Query0 which is the residual query after applying an A. This is the type constructed by the sql interpolator.

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

Type Members

  1. abstract type I
    Attributes
    protected
  2. abstract type O
    Attributes
    protected

Abstract Value Members

  1. abstract val ai: (A) ⇒ I
    Attributes
    protected
  2. implicit abstract val ic: doobie.Composite[I]
    Attributes
    protected
  3. abstract val logHandler: doobie.LogHandler
    Attributes
    protected
  4. abstract val ob: (O) ⇒ B
    Attributes
    protected
  5. implicit abstract val oc: doobie.Composite[O]
    Attributes
    protected
  6. 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.

  7. abstract def sql: String

    The SQL string.

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. def accumulate[F[_]](a: A)(implicit arg0: Alternative[F]): doobie.ConnectionIO[F[B]]

    Apply the argument a to construct a program in ConnectionIO yielding an F[B] accumulated via MonadPlus append.

    Apply the argument a to construct a program in ConnectionIO yielding an F[B] accumulated via MonadPlus append. This method is more general but less efficient than to.

  5. def analysis: doobie.ConnectionIO[Analysis]

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

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def contramap[C](f: (C) ⇒ A): Query[C, B]

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def list(a: A): doobie.ConnectionIO[List[B]]

    Convenience method; equivalent to to[List]

  16. def map[C](f: (B) ⇒ C): Query[A, C]

  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def nel(a: A): doobie.ConnectionIO[NonEmptyList[B]]

    Apply the argument a to construct a program in ConnectionIO yielding an NonEmptyList[B] and raising an exception if the resultset does not have at least one row.

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

  19. final def notify(): Unit
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  21. def option(a: A): doobie.ConnectionIO[Option[B]]

    Apply the argument a to construct a program in ConnectionIO yielding an optional B and raising an exception if the resultset has more than one row.

    Apply the argument a to construct a program in ConnectionIO yielding an optional B and raising an exception if the resultset has more than one row. See also unique.

  22. def outputAnalysis: doobie.ConnectionIO[Analysis]

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

  23. def process(a: A): Stream[doobie.ConnectionIO, B]

    Apply the argument a to construct a Stream with DefaultChunkSize, with effect type ConnectionIO yielding elements of type B.

  24. def processWithChunkSize(a: A, chunkSize: Int): Stream[doobie.ConnectionIO, B]

    Apply the argument a to construct a Stream with the given chunking factor, with effect type ConnectionIO yielding elements of type B.

  25. def stream(a: A): Stream[doobie.ConnectionIO, B]

    FS2 Friendly Alias for process.

  26. def streamWithChunkSize(a: A, chunkSize: Int): Stream[doobie.ConnectionIO, B]

    FS2 Friendly Alias for processWithChunkSize.

  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def to[F[_]](a: A)(implicit cbf: CanBuildFrom[Nothing, B, F[B]]): doobie.ConnectionIO[F[B]]

    Apply the argument a to construct a program in ConnectionIO yielding an F[B] accumulated via the provided CanBuildFrom.

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

  29. def toFragment(a: A): doobie.Fragment

    Turn this Query into a Fragment, given an argument.

  30. def toQuery0(a: A): Query0[B]

    Apply an argument, yielding a residual Query0.

    Apply an argument, yielding a residual Query0.

    Annotations
    @SuppressWarnings()
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def unique(a: A): doobie.ConnectionIO[B]

    Apply the argument a to construct a program in ConnectionIO yielding a unique B and raising an exception if the resultset does not have exactly one row.

    Apply the argument a to construct a program in ConnectionIO yielding a unique B and raising an exception if the resultset does not have exactly one row. See also option.

  33. def vector(a: A): doobie.ConnectionIO[Vector[B]]

    Convenience method; equivalent to to[Vector]

  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Diagnostics

Results

Transformations

Ungrouped