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.
- Grouped
- Alphabetic
- By Inheritance
- doobie
- Types
- Modules
- Modules
- Aliases
- Modules
- Types
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Package Members
- 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 indoobie.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.
- Enumerated values represented by
- package syntax
Collection of modules that add syntax to existing types.
- package util
Collection of modules for typeclasses and other helpful bits.
Type Members
- trait Aliases extends Types with Modules
Mixin containing aliases for the most commonly used types and modules from doobie-core.
- type BlobIO[A] = Free[BlobOp, A]
- Definition Classes
- Types
- type CallableStatementIO[A] = Free[CallableStatementOp, A]
- Definition Classes
- Types
- type ClobIO[A] = Free[ClobOp, A]
- Definition Classes
- Types
- type ConnectionIO[A] = Free[ConnectionOp, A]
- Definition Classes
- Types
- type DataSourceTransactor[F[_]] = doobie.util.transactor.Transactor[F] { type A = javax.sql.DataSource }
- Definition Classes
- Types
- type DatabaseMetaDataIO[A] = Free[DatabaseMetaDataOp, A]
- Definition Classes
- Types
- type DriverIO[A] = Free[DriverOp, A]
- Definition Classes
- Types
- type Fragment = doobie.util.fragment.Fragment
- Definition Classes
- Types
- type Get[A] = doobie.util.Get[A]
- Definition Classes
- Types
- type KleisliInterpreter[F[_]] = doobie.free.KleisliInterpreter[F]
- Definition Classes
- Types
- type LogHandler = doobie.util.log.LogHandler
- Definition Classes
- Types
- type Meta[A] = doobie.util.Meta[A]
- Definition Classes
- Types
- trait Modules extends AnyRef
Mixin containing aliases for the most commonly used modules from doobie-core.
- type NClobIO[A] = Free[NClobOp, A]
- Definition Classes
- Types
- type Param[A <: HList] = doobie.util.param.Param[A]
- Definition Classes
- Types
- type PreparedStatementIO[A] = Free[PreparedStatementOp, A]
- Definition Classes
- Types
- type Put[A] = doobie.util.Put[A]
- Definition Classes
- Types
- type Query[A, B] = doobie.util.query.Query[A, B]
- Definition Classes
- Types
- type Query0[A] = doobie.util.query.Query0[A]
- Definition Classes
- Types
- type Read[A] = doobie.util.Read[A]
- Definition Classes
- Types
- type RefIO[A] = Free[RefOp, A]
- Definition Classes
- Types
- type ResultSetIO[A] = Free[ResultSetOp, A]
- Definition Classes
- Types
- type SQLDataIO[A] = Free[SQLDataOp, A]
- Definition Classes
- Types
- type SQLInputIO[A] = Free[SQLInputOp, A]
- Definition Classes
- Types
- type SQLOutputIO[A] = Free[SQLOutputOp, A]
- Definition Classes
- Types
- type SqlState = doobie.enum.SqlState
- Definition Classes
- Types
- type StatementIO[A] = Free[StatementOp, A]
- Definition Classes
- Types
- type Transactor[M[_]] = doobie.util.transactor.Transactor[M]
- Definition Classes
- Types
- trait Types extends AnyRef
Mixin containing aliases for the most commonly used types from doobie-core.
- type Update[A] = doobie.util.update.Update[A]
- Definition Classes
- Types
- type Update0 = doobie.util.update.Update0
- Definition Classes
- Types
- type Write[A] = doobie.util.Write[A]
- Definition Classes
- Types
Value Members
- val ExecutionContexts: doobie.util.ExecutionContexts.type
- Definition Classes
- Modules
- lazy val FB: blob.type
- Definition Classes
- Modules
- lazy val FC: connection.type
- Definition Classes
- Modules
- lazy val FCL: clob.type
- Definition Classes
- Modules
- lazy val FCS: callablestatement.type
- Definition Classes
- Modules
- lazy val FD: driver.type
- Definition Classes
- Modules
- lazy val FDMD: databasemetadata.type
- Definition Classes
- Modules
- lazy val FNCL: nclob.type
- Definition Classes
- Modules
- lazy val FPS: preparedstatement.type
- Definition Classes
- Modules
- lazy val FREF: ref.type
- Definition Classes
- Modules
- lazy val FRS: resultset.type
- Definition Classes
- Modules
- lazy val FS: statement.type
- Definition Classes
- Modules
- lazy val FSD: sqldata.type
- Definition Classes
- Modules
- lazy val FSI: sqlinput.type
- Definition Classes
- Modules
- lazy val FSO: sqloutput.type
- Definition Classes
- Modules
- val Fragment: doobie.util.fragment.Fragment.type
- Definition Classes
- Modules
- val Fragments: fragments.type
- Definition Classes
- Modules
- val Get: doobie.util.Get.type
- Definition Classes
- Modules
- lazy val HC: connection.type
- Definition Classes
- Modules
- lazy val HPS: preparedstatement.type
- Definition Classes
- Modules
- lazy val HRS: resultset.type
- Definition Classes
- Modules
- lazy val HS: statement.type
- Definition Classes
- Modules
- val KleisliInterpreter: doobie.free.KleisliInterpreter.type
- Definition Classes
- Modules
- val LogHandler: doobie.util.log.LogHandler.type
- Definition Classes
- Modules
- val Meta: doobie.util.Meta.type
- Definition Classes
- Modules
- val Param: doobie.util.param.Param.type
- Definition Classes
- Modules
- val Put: doobie.util.Put.type
- Definition Classes
- Modules
- val Query: doobie.util.query.Query.type
- Definition Classes
- Modules
- val Query0: doobie.util.query.Query0.type
- Definition Classes
- Modules
- val Read: doobie.util.Read.type
- Definition Classes
- Modules
- val SqlState: doobie.enum.SqlState.type
- Definition Classes
- Modules
- val Transactor: doobie.util.transactor.Transactor.type
- Definition Classes
- Modules
- val Update: doobie.util.update.Update.type
- Definition Classes
- Modules
- val Update0: doobie.util.update.Update0.type
- Definition Classes
- Modules
- val Write: doobie.util.Write.type
- Definition Classes
- Modules
- object buildinfo
Auto-generated build information.
- object implicits extends Instances with AllSyntax
Top-level import for all instances and syntax provided by doobie-free and doobie-core.