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 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. Protected

Diagnostics

  1. 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.

  2. abstract def sql: String

    The SQL string.

  3. def analysis: free.connection.ConnectionIO[Analysis]

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

  4. def inspect[R](a: A)(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. Given arguments a, calls f with the SQL representation of the query and a statement with all arguments set. Returns the result of the ConnectionIO program constructed.

  5. def outputAnalysis: free.connection.ConnectionIO[Analysis]

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

Results

  1. def accumulate[F[_]](a: A)(implicit arg0: Alternative[F]): free.connection.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.

  2. def nel(a: A): free.connection.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.

  3. def option(a: A): free.connection.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.

  4. def stream(a: A): Stream[free.connection.ConnectionIO, B]

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

  5. def streamWithChunkSize(a: A, chunkSize: Int): Stream[free.connection.ConnectionIO, B]

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

  6. def to[F[_]](a: A)(implicit f: Factory[B, F[B]]): free.connection.ConnectionIO[F[B]]

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

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

  7. def toMap[K, V](a: A)(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).

  8. def unique(a: A): free.connection.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.

Transformations

  1. def contramap[C](f: (C) => A): Query[C, B]

  2. def map[C](f: (B) => C): Query[A, C]

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

    Apply an argument, yielding a residual Query0.

    Apply an argument, yielding a residual Query0.

    Annotations
    @SuppressWarnings()

Ungrouped

  1. def toFragment(a: A): fragment.Fragment

    Convert this Query to a Fragment.