driver

Algebra and free monad for primitive operations over a java.sql.Driver. This is a low-level API that exposes lifecycle-managed JDBC objects directly and is intended mainly for library developers. End users will prefer a safer, higher-level API such as that provided in the doobie.hi package.

DriverIO is a free monad that must be run via an interpreter, most commonly via natural transformation of its underlying algebra DriverOp to another monad via Free#foldMap.

The library provides a natural transformation to Kleisli[M, Driver, A] for any exception-trapping (Catchable) and effect-capturing (Capture) monad M. Such evidence is provided for Task, IO, and stdlib Future; and transK[M] is provided as syntax.

// An action to run
val a: DriverIO[Foo] = ...

// A JDBC object
val s: Driver = ...

// Unfolding into a Task
val ta: Task[A] = a.transK[Task].run(s)

Source: driver.scala

Linear Supertypes

DriverIOInstances, AnyRef, Any

Type Members

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

Free monad over a free functor of DriverOp; abstractly, a computation that consumes a java.sql.Driver and produces a value of type A.
implicit class DriverIOOps[A] extends AnyRef

Syntax for DriverIO.
sealed trait DriverOp[A] extends AnyRef

Sum type of primitive operations over a java.sql.Driver.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
implicit val CaptureDriverIO: Capture[DriverIO]

Capture instance for DriverIO.
implicit val CatchableDriverIO: Catchable[DriverIO]

Catchable instance for DriverIO.
object DriverOp

Module of constructors for DriverOp.
Module of constructors for DriverOp. These are rarely useful outside of the implementation; prefer the smart constructors provided by the driver module.
def acceptsURL(a: String): DriverIO[Boolean]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def attempt[A](a: DriverIO[A]): DriverIO[\/[Throwable, A]]

Lift a DriverIO[A] into an exception-capturing DriverIO[Throwable \/ A].
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def connect(a: String, b: Properties): DriverIO[Connection]
def delay[A](a: ⇒ A): DriverIO[A]

Non-strict unit for capturing effects.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val getMajorVersion: DriverIO[Int]
val getMinorVersion: DriverIO[Int]
val getParentLogger: DriverIO[Logger]
def getPropertyInfo(a: String, b: Properties): DriverIO[Array[DriverPropertyInfo]]
def hashCode(): Int

Definition Classes
AnyRef → Any
def interpK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[DriverOp, [γ$3$]Kleisli[M, Driver, γ$3$]]

Natural transformation from DriverOp to Kleisli for the given M, consuming a java.sql.Driver.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val jdbcCompliant: DriverIO[Boolean]
def lift[Op[_], A, J](j: J, action: Free[Op, A])(implicit mod: Aux[Op, J]): DriverIO[A]

Lift a different type of program that has a default Kleisli interpreter.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def raw[A](f: (Driver) ⇒ A): DriverIO[A]

Backdoor for arbitrary computations on the underlying Driver.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def trans[M[_]](c: Driver)(implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[DriverIO, M]

Natural transformation from DriverIO to M, given a java.sql.Driver.
def transK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[DriverIO, [γ$4$]Kleisli[M, Driver, γ$4$]]

Natural transformation from DriverIO to Kleisli for the given M, consuming a java.sql.Driver.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package free

object driver extends DriverIOInstances

Type Members

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

implicit class DriverIOOps[A] extends AnyRef

sealed trait DriverOp[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit val CaptureDriverIO: Capture[DriverIO]

implicit val CatchableDriverIO: Catchable[DriverIO]

object DriverOp

def acceptsURL(a: String): DriverIO[Boolean]

final def asInstanceOf[T0]: T0

def attempt[A](a: DriverIO[A]): DriverIO[\/[Throwable, A]]

def clone(): AnyRef

def connect(a: String, b: Properties): DriverIO[Connection]

def delay[A](a: ⇒ A): DriverIO[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val getMajorVersion: DriverIO[Int]

val getMinorVersion: DriverIO[Int]

val getParentLogger: DriverIO[Logger]

def getPropertyInfo(a: String, b: Properties): DriverIO[Array[DriverPropertyInfo]]

def hashCode(): Int

def interpK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[DriverOp, [γ$3$]Kleisli[M, Driver, γ$3$]]

final def isInstanceOf[T0]: Boolean

val jdbcCompliant: DriverIO[Boolean]

def lift[Op[_], A, J](j: J, action: Free[Op, A])(implicit mod: Aux[Op, J]): DriverIO[A]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def raw[A](f: (Driver) ⇒ A): DriverIO[A]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def trans[M[_]](c: Driver)(implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[DriverIO, M]

def transK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[DriverIO, [γ$4$]Kleisli[M, Driver, γ$4$]]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from DriverIOInstances

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped