sqldata

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

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

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

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

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

Source: sqldata.scala

Linear Supertypes

SQLDataIOInstances, AnyRef, Any

Type Members

type SQLDataIO[A] = Free[SQLDataOp, A]

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

Syntax for SQLDataIO.
sealed trait SQLDataOp[A] extends AnyRef

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

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 CatchableSQLDataIO: Catchable[SQLDataIO]

Catchable instance for SQLDataIO.
object SQLDataOp

Module of constructors for SQLDataOp.
Module of constructors for SQLDataOp. These are rarely useful outside of the implementation; prefer the smart constructors provided by the sqldata module.
implicit val SuspendableSQLDataIO: Suspendable[SQLDataIO]

Suspendable instance for SQLDataIO.
Suspendable instance for SQLDataIO.

Definition Classes
SQLDataIOInstances
final def asInstanceOf[T0]: T0

Definition Classes
Any
def attempt[A](a: SQLDataIO[A]): SQLDataIO[Either[Throwable, A]]

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def delay[A](a: ⇒ A): SQLDataIO[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 getSQLTypeName: SQLDataIO[String]
def hashCode(): Int

Definition Classes
AnyRef → Any
def interpK[M[_]](implicit arg0: Catchable[M], arg1: Suspendable[M]): ~>[SQLDataOp, [γ$3$]Kleisli[M, SQLData, γ$3$]]

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

Definition Classes
Any
def lift[Op[_], A, J](j: J, action: Free[Op, A])(implicit mod: Aux[Op, J]): SQLDataIO[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: (SQLData) ⇒ A): SQLDataIO[A]

Backdoor for arbitrary computations on the underlying SQLData.
def readSQL(a: SQLInput, b: String): SQLDataIO[Unit]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def trans[M[_]](c: SQLData)(implicit arg0: Catchable[M], arg1: Suspendable[M]): ~>[SQLDataIO, M]

Natural transformation from SQLDataIO to M, given a java.sql.SQLData.
def transK[M[_]](implicit arg0: Catchable[M], arg1: Suspendable[M]): ~>[SQLDataIO, [γ$4$]Kleisli[M, SQLData, γ$4$]]

Natural transformation from SQLDataIO to Kleisli for the given M, consuming a java.sql.SQLData.
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( ... )
def writeSQL(a: SQLOutput): SQLDataIO[Unit]

Related Doc: package free

object sqldata extends SQLDataIOInstances

Type Members

type SQLDataIO[A] = Free[SQLDataOp, A]

implicit class SQLDataIOOps[A] extends AnyRef

sealed trait SQLDataOp[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit val CatchableSQLDataIO: Catchable[SQLDataIO]

object SQLDataOp

implicit val SuspendableSQLDataIO: Suspendable[SQLDataIO]

final def asInstanceOf[T0]: T0

def attempt[A](a: SQLDataIO[A]): SQLDataIO[Either[Throwable, A]]

def clone(): AnyRef

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val getSQLTypeName: SQLDataIO[String]

def hashCode(): Int

def interpK[M[_]](implicit arg0: Catchable[M], arg1: Suspendable[M]): ~>[SQLDataOp, [γ$3$]Kleisli[M, SQLData, γ$3$]]

final def isInstanceOf[T0]: Boolean

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def raw[A](f: (SQLData) ⇒ A): SQLDataIO[A]

def readSQL(a: SQLInput, b: String): SQLDataIO[Unit]

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

def toString(): String

def trans[M[_]](c: SQLData)(implicit arg0: Catchable[M], arg1: Suspendable[M]): ~>[SQLDataIO, M]

def transK[M[_]](implicit arg0: Catchable[M], arg1: Suspendable[M]): ~>[SQLDataIO, [γ$4$]Kleisli[M, SQLData, γ$4$]]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def writeSQL(a: SQLOutput): SQLDataIO[Unit]

Inherited from SQLDataIOInstances

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped