Package

doobie

Permalink

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

    Permalink

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

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

    Permalink

    Definition Classes
    Types

  3. type CallableStatementIO[A] = Free[CallableStatementOp, A]

    Permalink

    Definition Classes
    Types

  4. type ClobIO[A] = Free[ClobOp, A]

    Permalink

    Definition Classes
    Types

  5. type Composite[A] = doobie.util.composite.Composite[A]

    Permalink

    Definition Classes
    Types

  6. type ConnectionIO[A] = Free[ConnectionOp, A]

    Permalink

    Definition Classes
    Types

  7. type DatabaseMetaDataIO[A] = Free[DatabaseMetaDataOp, A]

    Permalink

    Definition Classes
    Types

  8. type DriverIO[A] = Free[DriverOp, A]

    Permalink

    Definition Classes
    Types

  9. type Fragment = doobie.util.fragment.Fragment

    Permalink

    Definition Classes
    Types

  10. type KleisliInterpreter[F[_]] = doobie.free.KleisliInterpreter[F]

    Permalink

    Definition Classes
    Types

  11. type LogHandler = doobie.util.log.LogHandler

    Permalink

    Definition Classes
    Types

  12. type Meta[A] = doobie.util.meta.Meta[A]

    Permalink

    Definition Classes
    Types

  13. trait Modules extends AnyRef

    Permalink

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

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

    Permalink

    Definition Classes
    Types

  15. type Param[A] = doobie.util.param.Param[A]

    Permalink

    Definition Classes
    Types

  16. type PreparedStatementIO[A] = Free[PreparedStatementOp, A]

    Permalink

    Definition Classes
    Types

  17. type Query[A, B] = doobie.util.query.Query[A, B]

    Permalink

    Definition Classes
    Types

  18. type Query0[A] = doobie.util.query.Query0[A]

    Permalink

    Definition Classes
    Types

  19. type RefIO[A] = Free[RefOp, A]

    Permalink

    Definition Classes
    Types

  20. type ResultSetIO[A] = Free[ResultSetOp, A]

    Permalink

    Definition Classes
    Types

  21. type SQLDataIO[A] = Free[SQLDataOp, A]

    Permalink

    Definition Classes
    Types

  22. type SQLInputIO[A] = Free[SQLInputOp, A]

    Permalink

    Definition Classes
    Types

  23. type SQLOutputIO[A] = Free[SQLOutputOp, A]

    Permalink

    Definition Classes
    Types

  24. type SqlState = doobie.enum.SqlState

    Permalink

    Definition Classes
    Types

  25. type StatementIO[A] = Free[StatementOp, A]

    Permalink

    Definition Classes
    Types

  26. type Transactor[M[_]] = doobie.util.transactor.Transactor[M]

    Permalink

    Definition Classes
    Types

  27. trait Types extends AnyRef

    Permalink

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

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

    Permalink

    Definition Classes
    Types

  29. type Update0 = doobie.util.update.Update0

    Permalink

    Definition Classes
    Types

Value Members

  1. val Composite: doobie.util.composite.Composite.type

    Permalink

    Definition Classes
    Modules

  2. lazy val FB: blob.type

    Permalink

    Definition Classes
    Modules

  3. lazy val FC: connection.type

    Permalink

    Definition Classes
    Modules

  4. lazy val FCL: clob.type

    Permalink

    Definition Classes
    Modules

  5. lazy val FCS: callablestatement.type

    Permalink

    Definition Classes
    Modules

  6. lazy val FD: driver.type

    Permalink

    Definition Classes
    Modules

  7. lazy val FDMD: databasemetadata.type

    Permalink

    Definition Classes
    Modules

  8. lazy val FNCL: nclob.type

    Permalink

    Definition Classes
    Modules

  9. lazy val FPS: preparedstatement.type

    Permalink

    Definition Classes
    Modules

  10. lazy val FREF: ref.type

    Permalink

    Definition Classes
    Modules

  11. lazy val FRS: resultset.type

    Permalink

    Definition Classes
    Modules

  12. lazy val FS: statement.type

    Permalink

    Definition Classes
    Modules

  13. lazy val FSD: sqldata.type

    Permalink

    Definition Classes
    Modules

  14. lazy val FSI: sqlinput.type

    Permalink

    Definition Classes
    Modules

  15. lazy val FSO: sqloutput.type

    Permalink

    Definition Classes
    Modules

  16. val Fragment: doobie.util.fragment.Fragment.type

    Permalink

    Definition Classes
    Modules

  17. val Fragments: fragments.type

    Permalink

    Definition Classes
    Modules

  18. lazy val HC: connection.type

    Permalink

    Definition Classes
    Modules

  19. lazy val HPS: preparedstatement.type

    Permalink

    Definition Classes
    Modules

  20. lazy val HRS: resultset.type

    Permalink

    Definition Classes
    Modules

  21. lazy val HS: statement.type

    Permalink

    Definition Classes
    Modules

  22. val KleisliInterpreter: doobie.free.KleisliInterpreter.type

    Permalink

    Definition Classes
    Modules

  23. val LogHandler: doobie.util.log.LogHandler.type

    Permalink

    Definition Classes
    Modules

  24. val Meta: doobie.util.meta.Meta.type

    Permalink

    Definition Classes
    Modules

  25. val Param: doobie.util.param.Param.type

    Permalink

    Definition Classes
    Modules

  26. val Query: doobie.util.query.Query.type

    Permalink

    Definition Classes
    Modules

  27. val Query0: doobie.util.query.Query0.type

    Permalink

    Definition Classes
    Modules

  28. val SqlState: doobie.enum.SqlState.type

    Permalink

    Definition Classes
    Modules

  29. val Transactor: doobie.util.transactor.Transactor.type

    Permalink

    Definition Classes
    Modules

  30. val Update: doobie.util.update.Update.type

    Permalink

    Definition Classes
    Modules

  31. val Update0: doobie.util.update.Update0.type

    Permalink

    Definition Classes
    Modules

  32. object buildinfo

    Permalink

    Auto-generated build information.

  33. package enum

    Permalink

    Enumerated types for JDBC constants.

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

  34. package free

    Permalink

  35. package hi

    Permalink

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

  36. object implicits extends Instances with AllSyntax

    Permalink

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

  37. package syntax

    Permalink

    Collection of modules that add syntax to existing types.

  38. package util

    Permalink

    Collection of modules for typeclasses and other helpful bits.

Deprecated Value Members

  1. object imports extends Aliases with doobie.hi.Modules with doobie.free.Modules with doobie.free.Types with Instances with AllSyntax

    Permalink
    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