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 enum

    Enumerated types for JDBC constants.

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

    Definition Classes
    doobie
  • package free
    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.enum.
    • 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

    Collection of modules that add syntax to existing types.

    Collection of modules that add syntax to existing types.

    Definition Classes
    doobie
  • package util

    Collection of modules for typeclasses and other helpful bits.

    Collection of modules for typeclasses and other helpful bits.

    Definition Classes
    doobie
  • package compat
  • package testing

    Common utilities for query testing

  • EvenLower
  • EvenLowerPriorityWrite
  • ExecutionContexts
  • Get
  • GetInstances
  • LowerPriorityRead
  • LowerPriorityWrite
  • Meta
  • MetaConstructors
  • MetaDeprecatedConstructors
  • MetaInstances
  • Put
  • PutInstances
  • Read
  • ToTempStringOps
  • Write
  • analysis
  • catchsql
  • foldable
  • fragment
  • fragments
  • invariant
  • io
  • lens
  • log
  • param
  • pos
  • pretty
  • query
  • stream
  • transactor
  • update
  • yolo
p

doobie

util

package util

Collection of modules for typeclasses and other helpful bits.

Source
package.scala
Linear Supertypes
ToTempStringOps, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. util
  2. ToTempStringOps
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait EvenLower extends AnyRef
  2. trait EvenLowerPriorityWrite extends AnyRef
  3. sealed abstract class Get[A] extends AnyRef
  4. trait GetInstances extends AnyRef
  5. trait LowerPriorityRead extends EvenLower
  6. trait LowerPriorityWrite extends EvenLowerPriorityWrite
  7. final class Meta[A] extends AnyRef

    Convenience for introducing a symmetric Get/Put pair into implicit scope, and for deriving new symmetric pairs.

    Convenience for introducing a symmetric Get/Put pair into implicit scope, and for deriving new symmetric pairs. It's important to understand that Meta should never be demanded by user methods; instead demand both Get and Put. The reason for this is that while Meta implies Get and Put, the presence of both Get and Put does *not* imply Meta.

  8. trait MetaConstructors extends AnyRef
  9. trait MetaDeprecatedConstructors extends AnyRef
  10. trait MetaInstances extends AnyRef
  11. sealed abstract class Put[A] extends AnyRef
  12. trait PutInstances extends AnyRef
  13. final class Read[A] extends AnyRef
    Annotations
    @implicitNotFound( ... )
  14. trait ToTempStringOps extends AnyRef
  15. final class Write[A] extends AnyRef

Value Members

  1. object ExecutionContexts
  2. object Get extends GetInstances
  3. object Meta extends MetaConstructors with MetaInstances with MetaDeprecatedConstructors

    Module of constructors and instances for Meta.

  4. object Put extends PutInstances
  5. object Read extends LowerPriorityRead
  6. object Write extends LowerPriorityWrite
  7. object analysis

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

  8. object catchsql

    Module of additional combinators for ApplicativeError, specific to SQLException.

  9. object foldable

    Module of additional functions for Foldable.

  10. object fragment

    Module defining the Fragment data type.

  11. object fragments

    Module of Fragment constructors.

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

  13. object io

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

  14. object lens
  15. object log

    A module of types and instances for logged statements.

  16. object param

    Module defining the Param typeclass.

  17. object pos

    Module for source positions.

  18. object pretty

    Some functions for pretty-printing.

  19. object query

    Module defining queries parameterized by input and output types.

  20. object stream

    Additional functions for manipulating Stream values.

  21. object transactor
  22. object update

    Module defining updates parameterized by input type.

  23. object yolo

    Module for implicit syntax useful in REPL session.

Inherited from ToTempStringOps

Inherited from AnyRef

Inherited from Any

Ungrouped