statement

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

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

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

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

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

Source: statement.scala

Linear Supertypes

StatementIOInstances, AnyRef, Any

Type Members

type StatementIO[A] = Free[StatementOp, A]

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

Syntax for StatementIO.
sealed trait StatementOp[A] extends AnyRef

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

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 CaptureStatementIO: Capture[StatementIO]

Capture instance for StatementIO.
implicit val CatchableStatementIO: Catchable[StatementIO]

Catchable instance for StatementIO.
object StatementOp

Module of constructors for StatementOp.
Module of constructors for StatementOp. These are rarely useful outside of the implementation; prefer the smart constructors provided by the statement module.
def addBatch(a: String): StatementIO[Unit]
final def asInstanceOf[T0]: T0

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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val close: StatementIO[Unit]
val closeOnCompletion: StatementIO[Unit]
def delay[A](a: ⇒ A): StatementIO[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 execute(a: String, b: Int): StatementIO[Boolean]
def execute(a: String, b: Array[String]): StatementIO[Boolean]
def execute(a: String, b: Array[Int]): StatementIO[Boolean]
def execute(a: String): StatementIO[Boolean]
val executeBatch: StatementIO[Array[Int]]
val executeLargeBatch: StatementIO[Array[Long]]
def executeLargeUpdate(a: String, b: Int): StatementIO[Long]
def executeLargeUpdate(a: String, b: Array[String]): StatementIO[Long]
def executeLargeUpdate(a: String, b: Array[Int]): StatementIO[Long]
def executeLargeUpdate(a: String): StatementIO[Long]
def executeQuery(a: String): StatementIO[ResultSet]
def executeUpdate(a: String, b: Int): StatementIO[Int]
def executeUpdate(a: String, b: Array[String]): StatementIO[Int]
def executeUpdate(a: String, b: Array[Int]): StatementIO[Int]
def executeUpdate(a: String): StatementIO[Int]
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 getConnection: StatementIO[Connection]
val getFetchDirection: StatementIO[Int]
val getFetchSize: StatementIO[Int]
val getGeneratedKeys: StatementIO[ResultSet]
val getLargeMaxRows: StatementIO[Long]
val getLargeUpdateCount: StatementIO[Long]
val getMaxFieldSize: StatementIO[Int]
val getMaxRows: StatementIO[Int]
def getMoreResults(a: Int): StatementIO[Boolean]
val getMoreResults: StatementIO[Boolean]
val getQueryTimeout: StatementIO[Int]
val getResultSet: StatementIO[ResultSet]
val getResultSetConcurrency: StatementIO[Int]
val getResultSetHoldability: StatementIO[Int]
val getResultSetType: StatementIO[Int]
val getUpdateCount: StatementIO[Int]
val getWarnings: StatementIO[SQLWarning]
def hashCode(): Int

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

Natural transformation from StatementOp to Kleisli for the given M, consuming a java.sql.Statement.
val isCloseOnCompletion: StatementIO[Boolean]
val isClosed: StatementIO[Boolean]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val isPoolable: StatementIO[Boolean]
def isWrapperFor(a: Class[_]): StatementIO[Boolean]
def lift[Op[_], A, J](j: J, action: Free[Op, A])(implicit mod: Aux[Op, J]): StatementIO[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: (Statement) ⇒ A): StatementIO[A]

Backdoor for arbitrary computations on the underlying Statement.
def setCursorName(a: String): StatementIO[Unit]
def setEscapeProcessing(a: Boolean): StatementIO[Unit]
def setFetchDirection(a: Int): StatementIO[Unit]
def setFetchSize(a: Int): StatementIO[Unit]
def setLargeMaxRows(a: Long): StatementIO[Unit]
def setMaxFieldSize(a: Int): StatementIO[Unit]
def setMaxRows(a: Int): StatementIO[Unit]
def setPoolable(a: Boolean): StatementIO[Unit]
def setQueryTimeout(a: Int): StatementIO[Unit]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Related Doc: package free

object statement extends StatementIOInstances

Type Members

type StatementIO[A] = Free[StatementOp, A]

implicit class StatementIOOps[A] extends AnyRef

sealed trait StatementOp[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit val CaptureStatementIO: Capture[StatementIO]

implicit val CatchableStatementIO: Catchable[StatementIO]

object StatementOp

def addBatch(a: String): StatementIO[Unit]

final def asInstanceOf[T0]: T0

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

val cancel: StatementIO[Unit]

val clearBatch: StatementIO[Unit]

val clearWarnings: StatementIO[Unit]

def clone(): AnyRef

val close: StatementIO[Unit]

val closeOnCompletion: StatementIO[Unit]

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def execute(a: String, b: Int): StatementIO[Boolean]

def execute(a: String, b: Array[String]): StatementIO[Boolean]

def execute(a: String, b: Array[Int]): StatementIO[Boolean]

def execute(a: String): StatementIO[Boolean]

val executeBatch: StatementIO[Array[Int]]

val executeLargeBatch: StatementIO[Array[Long]]

def executeLargeUpdate(a: String, b: Int): StatementIO[Long]

def executeLargeUpdate(a: String, b: Array[String]): StatementIO[Long]

def executeLargeUpdate(a: String, b: Array[Int]): StatementIO[Long]

def executeLargeUpdate(a: String): StatementIO[Long]

def executeQuery(a: String): StatementIO[ResultSet]

def executeUpdate(a: String, b: Int): StatementIO[Int]

def executeUpdate(a: String, b: Array[String]): StatementIO[Int]

def executeUpdate(a: String, b: Array[Int]): StatementIO[Int]

def executeUpdate(a: String): StatementIO[Int]

def finalize(): Unit

final def getClass(): Class[_]

val getConnection: StatementIO[Connection]

val getFetchDirection: StatementIO[Int]

val getFetchSize: StatementIO[Int]

val getGeneratedKeys: StatementIO[ResultSet]

val getLargeMaxRows: StatementIO[Long]

val getLargeUpdateCount: StatementIO[Long]

val getMaxFieldSize: StatementIO[Int]

val getMaxRows: StatementIO[Int]

def getMoreResults(a: Int): StatementIO[Boolean]

val getMoreResults: StatementIO[Boolean]

val getQueryTimeout: StatementIO[Int]

val getResultSet: StatementIO[ResultSet]

val getResultSetConcurrency: StatementIO[Int]

val getResultSetHoldability: StatementIO[Int]

val getResultSetType: StatementIO[Int]

val getUpdateCount: StatementIO[Int]

val getWarnings: StatementIO[SQLWarning]

def hashCode(): Int

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

val isCloseOnCompletion: StatementIO[Boolean]

val isClosed: StatementIO[Boolean]

final def isInstanceOf[T0]: Boolean

val isPoolable: StatementIO[Boolean]

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

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def raw[A](f: (Statement) ⇒ A): StatementIO[A]

def setCursorName(a: String): StatementIO[Unit]

def setEscapeProcessing(a: Boolean): StatementIO[Unit]

def setFetchDirection(a: Int): StatementIO[Unit]

def setFetchSize(a: Int): StatementIO[Unit]

def setLargeMaxRows(a: Long): StatementIO[Unit]

def setMaxFieldSize(a: Int): StatementIO[Unit]

def setMaxRows(a: Int): StatementIO[Unit]

def setPoolable(a: Boolean): StatementIO[Unit]