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.
- Alphabetic
- By Inheritance
- doobie
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Package Members
- 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 indoobie.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.
- Enumerated values represented by
- package syntax
- package util
Type Members
- type BlobIO[A] = Free[BlobOp, A]
- type CallableStatementIO[A] = Free[CallableStatementOp, A]
- type ClobIO[A] = Free[ClobOp, A]
- type ConnectionIO[A] = Free[ConnectionOp, A]
- type DatabaseMetaDataIO[A] = Free[DatabaseMetaDataOp, A]
- type DriverIO[A] = Free[DriverOp, A]
- type Fragment = doobie.util.fragment.Fragment
- type Get[A] = doobie.util.Get[A]
- type KleisliInterpreter[F[_]] = doobie.free.KleisliInterpreter[F]
- type Meta[A] = doobie.util.meta.Meta[A]
- type NClobIO[A] = Free[NClobOp, A]
- type PreparedStatementIO[A] = Free[PreparedStatementOp, A]
- type Put[A] = doobie.util.Put[A]
- type Query[A, B] = doobie.util.query.Query[A, B]
- type Query0[A] = doobie.util.query.Query0[A]
- type Read[A] = doobie.util.Read[A]
- type RefIO[A] = Free[RefOp, A]
- type ResultSetIO[A] = Free[ResultSetOp, A]
- type SQLDataIO[A] = Free[SQLDataOp, A]
- type SQLInputIO[A] = Free[SQLInputOp, A]
- type SQLOutputIO[A] = Free[SQLOutputOp, A]
- type SqlState = doobie.enumerated.SqlState
- type StatementIO[A] = Free[StatementOp, A]
- type Transactor[M[_]] = doobie.util.transactor.Transactor[M]
- type Update[A] = doobie.util.update.Update[A]
- type Update0 = doobie.util.update.Update0
- type Write[A] = doobie.util.Write[A]
Value Members
- val ExecutionContexts: doobie.util.ExecutionContexts.type
- val FB: blob.type
- val FC: connection.type
- val FCL: clob.type
- val FCS: callablestatement.type
- val FD: driver.type
- val FDMD: databasemetadata.type
- val FNCL: nclob.type
- val FPS: preparedstatement.type
- val FREF: ref.type
- val FRS: resultset.type
- val FS: statement.type
- val FSD: sqldata.type
- val FSI: sqlinput.type
- val FSO: sqloutput.type
- val Fragment: doobie.util.fragment.Fragment.type
- val Fragments: fragments.type
- val Get: doobie.util.Get.type
- val HC: connection.type
- val HPS: preparedstatement.type
- val HRS: resultset.type
- val HS: statement.type
- val KleisliInterpreter: doobie.free.KleisliInterpreter.type
- val Meta: doobie.util.meta.Meta.type
- val Put: doobie.util.Put.type
- val Query: doobie.util.query.Query.type
- val Query0: doobie.util.query.Query0.type
- val Read: doobie.util.Read.type
- val SqlState: doobie.enumerated.SqlState.type
- val Transactor: doobie.util.transactor.Transactor.type
- val Update: doobie.util.update.Update.type
- val Update0: doobie.util.update.Update0.type
- val Write: doobie.util.Write.type
- object implicits extends AllSyntax