connection

Algebra and free monad for primitive operations over a java.sql.Connection. 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.

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

The library provides a natural transformation to Kleisli[M, Connection, 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: ConnectionIO[Foo] = ...

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

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

Source: connection.scala

Linear Supertypes

AnyRef, Any

Type Members

type ConnectionIO[A] = Free[ConnectionOp, A]

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

Syntax for ConnectionIO.
sealed trait ConnectionOp[A] extends AnyRef

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

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
implicit val CaptureConnectionIO: Capture[ConnectionIO]

Capture instance for ConnectionIO.
implicit val CatchableConnectionIO: Catchable[ConnectionIO]

Catchable instance for ConnectionIO.
object ConnectionOp

Module of constructors for ConnectionOp.
def abort(a: Executor): ConnectionIO[Unit]
final def asInstanceOf[T0]: T0

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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val close: ConnectionIO[Unit]
val commit: ConnectionIO[Unit]
def createArrayOf(a: String, b: Array[AnyRef]): ConnectionIO[Array]
val createBlob: ConnectionIO[Blob]
val createClob: ConnectionIO[Clob]
val createNClob: ConnectionIO[NClob]
val createSQLXML: ConnectionIO[SQLXML]
def createStatement(a: Int, b: Int, c: Int): ConnectionIO[Statement]
def createStatement(a: Int, b: Int): ConnectionIO[Statement]
val createStatement: ConnectionIO[Statement]
def createStruct(a: String, b: Array[AnyRef]): ConnectionIO[Struct]
def delay[A](a: ⇒ A): ConnectionIO[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] )
val getAutoCommit: ConnectionIO[Boolean]
val getCatalog: ConnectionIO[String]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getClientInfo(a: String): ConnectionIO[String]
val getClientInfo: ConnectionIO[Properties]
val getHoldability: ConnectionIO[Int]
val getMetaData: ConnectionIO[DatabaseMetaData]
val getNetworkTimeout: ConnectionIO[Int]
val getSchema: ConnectionIO[String]
val getTransactionIsolation: ConnectionIO[Int]
val getTypeMap: ConnectionIO[Map[String, Class[_]]]
val getWarnings: ConnectionIO[SQLWarning]
def hashCode(): Int

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

Natural transformation from ConnectionOp to Kleisli for the given M, consuming a java.sql.Connection.
val isClosed: ConnectionIO[Boolean]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val isReadOnly: ConnectionIO[Boolean]
def isValid(a: Int): ConnectionIO[Boolean]
def isWrapperFor(a: Class[_]): ConnectionIO[Boolean]
def lift[Op[_], A, J](j: J, action: Free[Op, A])(implicit mod: Aux[Op, J]): ConnectionIO[A]

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def prepareCall(a: String): ConnectionIO[CallableStatement]
def prepareCall(a: String, b: Int, c: Int): ConnectionIO[CallableStatement]
def prepareCall(a: String, b: Int, c: Int, d: Int): ConnectionIO[CallableStatement]
def prepareStatement(a: String, b: Int, c: Int): ConnectionIO[PreparedStatement]
def prepareStatement(a: String): ConnectionIO[PreparedStatement]
def prepareStatement(a: String, b: Array[String]): ConnectionIO[PreparedStatement]
def prepareStatement(a: String, b: Array[Int]): ConnectionIO[PreparedStatement]
def prepareStatement(a: String, b: Int, c: Int, d: Int): ConnectionIO[PreparedStatement]
def prepareStatement(a: String, b: Int): ConnectionIO[PreparedStatement]
def raw[A](f: (Connection) ⇒ A): ConnectionIO[A]

Backdoor for arbitrary computations on the underlying Connection.
def releaseSavepoint(a: Savepoint): ConnectionIO[Unit]
def rollback(a: Savepoint): ConnectionIO[Unit]
val rollback: ConnectionIO[Unit]
def setAutoCommit(a: Boolean): ConnectionIO[Unit]
def setCatalog(a: String): ConnectionIO[Unit]
def setClientInfo(a: String, b: String): ConnectionIO[Unit]
def setClientInfo(a: Properties): ConnectionIO[Unit]
def setHoldability(a: Int): ConnectionIO[Unit]
def setNetworkTimeout(a: Executor, b: Int): ConnectionIO[Unit]
def setReadOnly(a: Boolean): ConnectionIO[Unit]
def setSavepoint(a: String): ConnectionIO[Savepoint]
val setSavepoint: ConnectionIO[Savepoint]
def setSchema(a: String): ConnectionIO[Unit]
def setTransactionIsolation(a: Int): ConnectionIO[Unit]
def setTypeMap(a: Map[String, Class[_]]): ConnectionIO[Unit]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

Natural transformation from ConnectionIO to Kleisli for the given M, consuming a java.sql.Connection.
def unwrap[T](a: Class[T]): ConnectionIO[T]
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( ... )

object connection

Type Members

type ConnectionIO[A] = Free[ConnectionOp, A]

implicit class ConnectionIOOps[A] extends AnyRef

sealed trait ConnectionOp[A] extends AnyRef

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

implicit val CaptureConnectionIO: Capture[ConnectionIO]

implicit val CatchableConnectionIO: Catchable[ConnectionIO]

object ConnectionOp

def abort(a: Executor): ConnectionIO[Unit]

final def asInstanceOf[T0]: T0

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

val clearWarnings: ConnectionIO[Unit]

def clone(): AnyRef

val close: ConnectionIO[Unit]

val commit: ConnectionIO[Unit]

def createArrayOf(a: String, b: Array[AnyRef]): ConnectionIO[Array]

val createBlob: ConnectionIO[Blob]

val createClob: ConnectionIO[Clob]

val createNClob: ConnectionIO[NClob]

val createSQLXML: ConnectionIO[SQLXML]

def createStatement(a: Int, b: Int, c: Int): ConnectionIO[Statement]

def createStatement(a: Int, b: Int): ConnectionIO[Statement]

val createStatement: ConnectionIO[Statement]

def createStruct(a: String, b: Array[AnyRef]): ConnectionIO[Struct]

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val getAutoCommit: ConnectionIO[Boolean]

val getCatalog: ConnectionIO[String]

final def getClass(): Class[_]

def getClientInfo(a: String): ConnectionIO[String]

val getClientInfo: ConnectionIO[Properties]

val getHoldability: ConnectionIO[Int]

val getMetaData: ConnectionIO[DatabaseMetaData]

val getNetworkTimeout: ConnectionIO[Int]

val getSchema: ConnectionIO[String]

val getTransactionIsolation: ConnectionIO[Int]

val getTypeMap: ConnectionIO[Map[String, Class[_]]]

val getWarnings: ConnectionIO[SQLWarning]

def hashCode(): Int

def interpK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[ConnectionOp, [γ]Kleisli[M, Connection, γ]]

val isClosed: ConnectionIO[Boolean]

final def isInstanceOf[T0]: Boolean

val isReadOnly: ConnectionIO[Boolean]

def isValid(a: Int): ConnectionIO[Boolean]

def isWrapperFor(a: Class[_]): ConnectionIO[Boolean]

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

def nativeSQL(a: String): ConnectionIO[String]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def prepareCall(a: String): ConnectionIO[CallableStatement]

def prepareCall(a: String, b: Int, c: Int): ConnectionIO[CallableStatement]

def prepareCall(a: String, b: Int, c: Int, d: Int): ConnectionIO[CallableStatement]

def prepareStatement(a: String, b: Int, c: Int): ConnectionIO[PreparedStatement]

def prepareStatement(a: String): ConnectionIO[PreparedStatement]

def prepareStatement(a: String, b: Array[String]): ConnectionIO[PreparedStatement]

def prepareStatement(a: String, b: Array[Int]): ConnectionIO[PreparedStatement]

def prepareStatement(a: String, b: Int, c: Int, d: Int): ConnectionIO[PreparedStatement]

def prepareStatement(a: String, b: Int): ConnectionIO[PreparedStatement]

def raw[A](f: (Connection) ⇒ A): ConnectionIO[A]

def releaseSavepoint(a: Savepoint): ConnectionIO[Unit]

def rollback(a: Savepoint): ConnectionIO[Unit]

val rollback: ConnectionIO[Unit]

def setAutoCommit(a: Boolean): ConnectionIO[Unit]

def setCatalog(a: String): ConnectionIO[Unit]

def setClientInfo(a: String, b: String): ConnectionIO[Unit]

def setClientInfo(a: Properties): ConnectionIO[Unit]

def setHoldability(a: Int): ConnectionIO[Unit]

def setNetworkTimeout(a: Executor, b: Int): ConnectionIO[Unit]

def setReadOnly(a: Boolean): ConnectionIO[Unit]

def setSavepoint(a: String): ConnectionIO[Savepoint]