doobie-core
API
Generated with
doobie-core/doobie

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

Attributes

See also

The doobie microsite for much more information.

Members list

Packages

package doobie.enumerated

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

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

Attributes

package doobie.free
package doobie.hi

High-level database API. The constructors here are defined in terms of those in doobie.free.connection but differ in the following ways:

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.

Attributes

package doobie.syntax

Collection of modules that add syntax to existing types.

Collection of modules that add syntax to existing types.

Attributes

package doobie.util

Collection of modules for typeclasses and other helpful bits.

Collection of modules for typeclasses and other helpful bits.

Attributes

Grouped members

Type Aliases - Free API

type BlobIO[A] = BlobIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type CallableStatementIO[A] = CallableStatementIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type ClobIO[A] = ClobIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type ConnectionIO[A] = ConnectionIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type DatabaseMetaDataIO[A] = DatabaseMetaDataIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type DriverIO[A] = DriverIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type NClobIO[A] = NClobIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type PreparedStatementIO[A] = PreparedStatementIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type RefIO[A] = RefIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type ResultSetIO[A] = ResultSetIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type SQLDataIO[A] = SQLDataIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type SQLInputIO[A] = SQLInputIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type SQLOutputIO[A] = SQLOutputIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala
type StatementIO[A] = StatementIO[A]

Attributes

Inherited from:
Types
Source
Aliases.scala

Module Aliases - Hi API

lazy val HC: connection.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val HPS: preparedstatement.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val HRS: resultset.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val HS: statement.type

Attributes

Inherited from:
Modules
Source
Aliases.scala

Type Aliases - Core

type DataSourceTransactor[F[_]] = Aux[F, DataSource]

Attributes

Inherited from:
Types
Source
aliases.scala
type Fragment = Fragment

Attributes

Inherited from:
Types
Source
aliases.scala
type Get[A] = Get[A]

Attributes

Inherited from:
Types
Source
aliases.scala
type KleisliInterpreter[F[_]] = KleisliInterpreter[F]

Attributes

Inherited from:
Types
Source
aliases.scala
type LogHandler[M[_]] = LogHandler[M]

Attributes

Inherited from:
Types
Source
aliases.scala
type Meta[A] = Meta[A]

Attributes

Inherited from:
Types
Source
aliases.scala
type Put[A] = Put[A]

Attributes

Inherited from:
Types
Source
aliases.scala
type Query[A, B] = Query[A, B]

Attributes

Inherited from:
Types
Source
aliases.scala
type Query0[A] = Query0[A]

Attributes

Inherited from:
Types
Source
aliases.scala
type Read[A] = Read[A]

Attributes

Inherited from:
Types
Source
aliases.scala
type SqlState = SqlState

Attributes

Inherited from:
Types
Source
aliases.scala
type Transactor[M[_]] = Transactor[M]

Attributes

Inherited from:
Types
Source
aliases.scala
type Update[A] = Update[A]

Attributes

Inherited from:
Types
Source
aliases.scala
type Update0 = Update0

Attributes

Inherited from:
Types
Source
aliases.scala
type Write[A] = Write[A]

Attributes

Inherited from:
Types
Source
aliases.scala

Module Aliases - Free API

lazy val FB: blob.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FC: connection.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FCL: clob.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FCS: callablestatement.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FD: driver.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FDMD: databasemetadata.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FNCL: nclob.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FPS: preparedstatement.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FREF: ref.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FRS: resultset.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FS: statement.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FSD: sqldata.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FSI: sqlinput.type

Attributes

Inherited from:
Modules
Source
Aliases.scala
lazy val FSO: sqloutput.type

Attributes

Inherited from:
Modules
Source
Aliases.scala

Module Aliases - Core

val ExecutionContexts: ExecutionContexts.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val Fragment: Fragment.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val Fragments: fragments.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val Get: Get.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val KleisliInterpreter: KleisliInterpreter.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val LogHandler: LogHandler.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val Meta: Meta.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val Put: Put.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val Query: Query.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val Query0: Query0.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val Read: Read.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val SqlState: SqlState.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val Transactor: Transactor.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val Update: Update.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val Update0: Update0.type

Attributes

Inherited from:
Modules
Source
aliases.scala
val Write: Write.type

Attributes

Inherited from:
Modules
Source
aliases.scala

Type members

Classlikes

trait Aliases extends Types, Modules

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

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

Attributes

Source
aliases.scala
Supertypes
trait Modules
trait Types
class Object
trait Matchable
class Any
trait Modules

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

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

Attributes

Source
aliases.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Aliases
trait Types

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

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

Attributes

Source
aliases.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Aliases
object buildinfo

Auto-generated build information.

Auto-generated build information.

Attributes

Source
buildinfo.scala
Supertypes
class Object
trait Matchable
class Any
Self type
buildinfo.type
object implicits extends Instances, AllSyntax, SqlMeta, TimeMeta, LegacyMeta

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

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

Attributes

Source
package.scala
Supertypes
trait LegacyMeta
trait TimeMeta
trait SqlMeta
trait AllSyntax
trait ToPutOps
trait ToStreamOps
trait Instances
class Object
trait Matchable
class Any
Show all
Self type
implicits.type
Generated with