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.

  • 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.
  • package syntax
  • package util
  • implicits
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
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. doobie
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package enumerated

    Enumerated types for JDBC constants.

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

  2. 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.
  3. package syntax
  4. package util

Type Members

  1. type BlobIO[A] = Free[BlobOp, A]
  2. type CallableStatementIO[A] = Free[CallableStatementOp, A]
  3. type ClobIO[A] = Free[ClobOp, A]
  4. type ConnectionIO[A] = Free[ConnectionOp, A]
  5. type DatabaseMetaDataIO[A] = Free[DatabaseMetaDataOp, A]
  6. type DriverIO[A] = Free[DriverOp, A]
  7. type Fragment = doobie.util.fragment.Fragment
  8. type Get[A] = doobie.util.Get[A]
  9. type KleisliInterpreter[F[_]] = doobie.free.KleisliInterpreter[F]
  10. type Meta[A] = doobie.util.meta.Meta[A]
  11. type NClobIO[A] = Free[NClobOp, A]
  12. type PreparedStatementIO[A] = Free[PreparedStatementOp, A]
  13. type Put[A] = doobie.util.Put[A]
  14. type Query[A, B] = doobie.util.query.Query[A, B]
  15. type Query0[A] = doobie.util.query.Query0[A]
  16. type Read[A] = doobie.util.Read[A]
  17. type RefIO[A] = Free[RefOp, A]
  18. type ResultSetIO[A] = Free[ResultSetOp, A]
  19. type SQLDataIO[A] = Free[SQLDataOp, A]
  20. type SQLInputIO[A] = Free[SQLInputOp, A]
  21. type SQLOutputIO[A] = Free[SQLOutputOp, A]
  22. type SqlState = doobie.enumerated.SqlState
  23. type StatementIO[A] = Free[StatementOp, A]
  24. type Transactor[M[_]] = doobie.util.transactor.Transactor[M]
  25. type Update[A] = doobie.util.update.Update[A]
  26. type Update0 = doobie.util.update.Update0
  27. type Write[A] = doobie.util.Write[A]

Value Members

  1. val ExecutionContexts: doobie.util.ExecutionContexts.type
  2. val FB: blob.type
  3. val FC: connection.type
  4. val FCL: clob.type
  5. val FCS: callablestatement.type
  6. val FD: driver.type
  7. val FDMD: databasemetadata.type
  8. val FNCL: nclob.type
  9. val FPS: preparedstatement.type
  10. val FREF: ref.type
  11. val FRS: resultset.type
  12. val FS: statement.type
  13. val FSD: sqldata.type
  14. val FSI: sqlinput.type
  15. val FSO: sqloutput.type
  16. val Fragment: doobie.util.fragment.Fragment.type
  17. val Fragments: fragments.type
  18. val Get: doobie.util.Get.type
  19. val HC: connection.type
  20. val HPS: preparedstatement.type
  21. val HRS: resultset.type
  22. val HS: statement.type
  23. val KleisliInterpreter: doobie.free.KleisliInterpreter.type
  24. val Meta: doobie.util.meta.Meta.type
  25. val Put: doobie.util.Put.type
  26. val Query: doobie.util.query.Query.type
  27. val Query0: doobie.util.query.Query0.type
  28. val Read: doobie.util.Read.type
  29. val SqlState: doobie.enumerated.SqlState.type
  30. val Transactor: doobie.util.transactor.Transactor.type
  31. val Update: doobie.util.update.Update.type
  32. val Update0: doobie.util.update.Update0.type
  33. val Write: doobie.util.Write.type
  34. object implicits extends AllSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped