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.

  • package free
  • 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.
  • package syntax

    Collection of modules that add syntax to existing types.

  • package util

    Collection of modules for typeclasses and other helpful bits.

  • Aliases
  • Modules
  • Types
  • buildinfo
  • implicits
  • imports
p

doobie

package doobie

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._
Source
package.scala
See also

The doobie microsite for much more information.

Linear Supertypes
doobie.free.Types, doobie.free.Modules, doobie.hi.Modules, Aliases, Modules, Types, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. doobie
  2. Types
  3. Modules
  4. Modules
  5. Aliases
  6. Modules
  7. Types
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Aliases extends Types with Modules

    Mixin containing aliases for the most commonly used types and modules from doobie-core.

  2. type BlobIO[A] = Free[BlobOp, A]

    Definition Classes
    Types
  3. type CallableStatementIO[A] = Free[CallableStatementOp, A]

    Definition Classes
    Types
  4. type ClobIO[A] = Free[ClobOp, A]

    Definition Classes
    Types
  5. type ConnectionIO[A] = Free[ConnectionOp, A]

    Definition Classes
    Types
  6. type DataSourceTransactor[F[_]] = doobie.util.transactor.Transactor[F] { type A = javax.sql.DataSource }

    Definition Classes
    Types
  7. type DatabaseMetaDataIO[A] = Free[DatabaseMetaDataOp, A]

    Definition Classes
    Types
  8. type DriverIO[A] = Free[DriverOp, A]

    Definition Classes
    Types
  9. type Fragment = doobie.util.fragment.Fragment

    Definition Classes
    Types
  10. type Get[A] = doobie.util.Get[A]

    Definition Classes
    Types
  11. type KleisliInterpreter[F[_]] = doobie.free.KleisliInterpreter[F]

    Definition Classes
    Types
  12. type LogHandler = doobie.util.log.LogHandler

    Definition Classes
    Types
  13. type Meta[A] = doobie.util.Meta[A]

    Definition Classes
    Types
  14. trait Modules extends AnyRef

    Mixin containing aliases for the most commonly used modules from doobie-core.

  15. type NClobIO[A] = Free[NClobOp, A]

    Definition Classes
    Types
  16. type Param[A <: HList] = doobie.util.param.Param[A]

    Definition Classes
    Types
  17. type PreparedStatementIO[A] = Free[PreparedStatementOp, A]

    Definition Classes
    Types
  18. type Put[A] = doobie.util.Put[A]

    Definition Classes
    Types
  19. type Query[A, B] = doobie.util.query.Query[A, B]

    Definition Classes
    Types
  20. type Query0[A] = doobie.util.query.Query0[A]

    Definition Classes
    Types
  21. type Read[A] = doobie.util.Read[A]

    Definition Classes
    Types
  22. type RefIO[A] = Free[RefOp, A]

    Definition Classes
    Types
  23. type ResultSetIO[A] = Free[ResultSetOp, A]

    Definition Classes
    Types
  24. type SQLDataIO[A] = Free[SQLDataOp, A]

    Definition Classes
    Types
  25. type SQLInputIO[A] = Free[SQLInputOp, A]

    Definition Classes
    Types
  26. type SQLOutputIO[A] = Free[SQLOutputOp, A]

    Definition Classes
    Types
  27. type SqlState = doobie.enum.SqlState

    Definition Classes
    Types
  28. type StatementIO[A] = Free[StatementOp, A]

    Definition Classes
    Types
  29. type Transactor[M[_]] = doobie.util.transactor.Transactor[M]

    Definition Classes
    Types
  30. trait Types extends AnyRef

    Mixin containing aliases for the most commonly used types from doobie-core.

  31. type Update[A] = doobie.util.update.Update[A]

    Definition Classes
    Types
  32. type Update0 = doobie.util.update.Update0

    Definition Classes
    Types
  33. type Write[A] = doobie.util.Write[A]

    Definition Classes
    Types

Value Members

  1. val ExecutionContexts: doobie.util.ExecutionContexts.type

    Definition Classes
    Modules
  2. lazy val FB: blob.type

    Definition Classes
    Modules
  3. lazy val FC: connection.type

    Definition Classes
    Modules
  4. lazy val FCL: clob.type

    Definition Classes
    Modules
  5. lazy val FCS: callablestatement.type

    Definition Classes
    Modules
  6. lazy val FD: driver.type

    Definition Classes
    Modules
  7. lazy val FDMD: databasemetadata.type

    Definition Classes
    Modules
  8. lazy val FNCL: nclob.type

    Definition Classes
    Modules
  9. lazy val FPS: preparedstatement.type

    Definition Classes
    Modules
  10. lazy val FREF: ref.type

    Definition Classes
    Modules
  11. lazy val FRS: resultset.type

    Definition Classes
    Modules
  12. lazy val FS: statement.type

    Definition Classes
    Modules
  13. lazy val FSD: sqldata.type

    Definition Classes
    Modules
  14. lazy val FSI: sqlinput.type

    Definition Classes
    Modules
  15. lazy val FSO: sqloutput.type

    Definition Classes
    Modules
  16. val Fragment: doobie.util.fragment.Fragment.type

    Definition Classes
    Modules
  17. val Fragments: fragments.type

    Definition Classes
    Modules
  18. val Get: doobie.util.Get.type

    Definition Classes
    Modules
  19. lazy val HC: connection.type

    Definition Classes
    Modules
  20. lazy val HPS: preparedstatement.type

    Definition Classes
    Modules
  21. lazy val HRS: resultset.type

    Definition Classes
    Modules
  22. lazy val HS: statement.type

    Definition Classes
    Modules
  23. val KleisliInterpreter: doobie.free.KleisliInterpreter.type

    Definition Classes
    Modules
  24. val LogHandler: doobie.util.log.LogHandler.type

    Definition Classes
    Modules
  25. val Meta: doobie.util.Meta.type

    Definition Classes
    Modules
  26. val Param: doobie.util.param.Param.type

    Definition Classes
    Modules
  27. val Put: doobie.util.Put.type

    Definition Classes
    Modules
  28. val Query: doobie.util.query.Query.type

    Definition Classes
    Modules
  29. val Query0: doobie.util.query.Query0.type

    Definition Classes
    Modules
  30. val Read: doobie.util.Read.type

    Definition Classes
    Modules
  31. val SqlState: doobie.enum.SqlState.type

    Definition Classes
    Modules
  32. val Transactor: doobie.util.transactor.Transactor.type

    Definition Classes
    Modules
  33. val Update: doobie.util.update.Update.type

    Definition Classes
    Modules
  34. val Update0: doobie.util.update.Update0.type

    Definition Classes
    Modules
  35. val Write: doobie.util.Write.type

    Definition Classes
    Modules
  36. object buildinfo

    Auto-generated build information.

  37. object implicits extends Instances with AllSyntax

    Top-level import for all instances and syntax provided by doobie-free and doobie-core.

Deprecated Value Members

  1. object imports extends Aliases with doobie.hi.Modules with doobie.free.Modules with doobie.free.Types with Instances with AllSyntax
    Annotations
    @deprecated
    Deprecated

    (Since version 0.5.0) import doobie._, doobie.implicits._

Inherited from doobie.free.Types

Inherited from doobie.free.Modules

Inherited from doobie.hi.Modules

Inherited from Aliases

Inherited from Modules

Inherited from Types

Inherited from AnyRef

Inherited from Any

Module Aliases - Core

Module Aliases - Free API

Module Aliases - Hi API

Type Aliases - Core

Type Aliases - Free API

Ungrouped