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 enumerated

    Enumerated types for JDBC constants.

    Enumerated types for JDBC constants. enumerated values are provided by companion modules.

    Definition Classes
    doobie
  • 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
  • package syntax
    Definition Classes
    doobie
  • package util
    Definition Classes
    doobie
  • package meta
  • package testing

    Common utilities for query testing

  • <:!<
  • Colors
  • ExecutionContexts
  • Get
  • GetInstances
  • Put
  • PutInstances
  • Read
  • Read1
  • ReadAutoPlatform
  • ReadPlatform
  • Write
  • Write1
  • WriteAutoPlatform
  • WritePlatform
  • analysis
  • catchsql
  • foldable
  • fragment
  • fragments
  • invariant
  • io
  • lens
  • pretty
  • query
  • stream
  • transactor
  • update
  • yolo

package util

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Package Members

  1. package meta
  2. package testing

    Common utilities for query testing

Type Members

  1. trait <:!<[A, B] extends Serializable
    Annotations
    @implicitNotFound()
  2. trait Colors extends AnyRef
  3. sealed abstract class Get[A] extends AnyRef
  4. trait GetInstances extends AnyRef
  5. sealed abstract class Put[A] extends AnyRef
  6. trait PutInstances extends AnyRef
  7. trait Read[A] extends AnyRef
    Annotations
    @implicitNotFound()
  8. sealed trait Read1 extends ReadPlatform
  9. trait ReadAutoPlatform extends ReadPlatform
  10. trait ReadPlatform extends AnyRef
  11. trait Write[A] extends AnyRef
  12. sealed trait Write1 extends WritePlatform
  13. trait WriteAutoPlatform extends WritePlatform
  14. trait WritePlatform extends AnyRef

Value Members

  1. object <:!< extends Serializable
  2. object Colors
  3. object ExecutionContexts
  4. object Get extends GetInstances
  5. object Put extends PutInstances
  6. object Read extends Read1
  7. object Write extends Write1
  8. object analysis

    Module defining a type for analyzing the type alignment of prepared statements.

  9. object catchsql

    Module of additional combinators for ApplicativeError, specific to SQLException.

  10. object foldable

    Module of additional functions for Foldable.

  11. object fragment

    Module defining the Fragment data type.

  12. object fragments

    Module of Fragment constructors.

    Module of Fragment constructors.

    Annotations
    @nowarn()
  13. object invariant

    Module defining the type of exceptions representing unmet expectations.

    Module defining the type of exceptions representing unmet expectations. These typically indicate a problem with the schema, with type mapping, with driver compliance, and so on. The intent is that they be as fine-grained as reasonable for diagnostic purposes, but it is not expected that the application should be able to handle them in any meaningful way.

  14. object io

    Module for a constructor of modules of IO operations for effectful monads.

  15. object lens
  16. object pretty

    Some functions for pretty-printing.

  17. object query

    Module defining queries parameterized by input and output types.

  18. object stream

    Additional functions for manipulating Stream values.

  19. object transactor
  20. object update

    Module defining updates parameterized by input type.

  21. object yolo

    Module for implicit syntax useful in REPL session.

Ungrouped