pgconnection

Algebra and free monad for primitive operations over a org.postgresql.PGConnection. 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.postgres.hi package.

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

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

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

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

Source: pgconnection.scala

Linear Supertypes

AnyRef, Any

Type Members

type PGConnectionIO[A] = Free[PGConnectionOp, A]

Free monad over a free functor of PGConnectionOp; abstractly, a computation that consumes a org.postgresql.PGConnection and produces a value of type A.
implicit class PGConnectionIOOps[A] extends AnyRef

Syntax for PGConnectionIO.
sealed trait PGConnectionOp[A] extends AnyRef

Sum type of primitive operations over a org.postgresql.PGConnection.

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 CapturePGConnectionIO: Capture[PGConnectionIO]

Capture instance for PGConnectionIO.
implicit val CatchablePGConnectionIO: Catchable[PGConnectionIO]

Catchable instance for PGConnectionIO.
object PGConnectionOp

Module of constructors for PGConnectionOp.
Module of constructors for PGConnectionOp. These are rarely useful outside of the implementation; prefer the smart constructors provided by the pgconnection module.
def addDataType(a: String, b: Class[_ <: PGobject]): PGConnectionIO[Unit]
def addDataType(a: String, b: String): PGConnectionIO[Unit]
final def asInstanceOf[T0]: T0

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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def delay[A](a: ⇒ A): PGConnectionIO[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 getBackendPID: PGConnectionIO[Int]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val getCopyAPI: PGConnectionIO[CopyManager]
val getFastpathAPI: PGConnectionIO[Fastpath]
val getLargeObjectAPI: PGConnectionIO[LargeObjectManager]
val getNotifications: PGConnectionIO[Array[PGNotification]]
val getPrepareThreshold: PGConnectionIO[Int]
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def kleisliTrans[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[PGConnectionOp, [γ$0$]Kleisli[M, PGConnection, γ$0$]]

Natural transformation from PGConnectionOp to Kleisli for the given M, consuming a org.postgresql.PGConnection.
def liftCopyManager[A](s: CopyManager, action: CopyManagerIO[A]): PGConnectionIO[A]
def liftFastpath[A](s: Fastpath, action: FastpathIO[A]): PGConnectionIO[A]
def liftLargeObjectManager[A](s: LargeObjectManager, action: LargeObjectManagerIO[A]): PGConnectionIO[A]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def setPrepareThreshold(a: Int): PGConnectionIO[Unit]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 pgconnection

Type Members

type PGConnectionIO[A] = Free[PGConnectionOp, A]

implicit class PGConnectionIOOps[A] extends AnyRef

sealed trait PGConnectionOp[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit val CapturePGConnectionIO: Capture[PGConnectionIO]

implicit val CatchablePGConnectionIO: Catchable[PGConnectionIO]

object PGConnectionOp

def addDataType(a: String, b: Class[_ <: PGobject]): PGConnectionIO[Unit]

def addDataType(a: String, b: String): PGConnectionIO[Unit]

final def asInstanceOf[T0]: T0

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

def clone(): AnyRef

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val getBackendPID: PGConnectionIO[Int]

final def getClass(): Class[_]

val getCopyAPI: PGConnectionIO[CopyManager]

val getFastpathAPI: PGConnectionIO[Fastpath]

val getLargeObjectAPI: PGConnectionIO[LargeObjectManager]

val getNotifications: PGConnectionIO[Array[PGNotification]]

val getPrepareThreshold: PGConnectionIO[Int]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def kleisliTrans[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[PGConnectionOp, [γ$0$]Kleisli[M, PGConnection, γ$0$]]

def liftCopyManager[A](s: CopyManager, action: CopyManagerIO[A]): PGConnectionIO[A]

def liftFastpath[A](s: Fastpath, action: FastpathIO[A]): PGConnectionIO[A]

def liftLargeObjectManager[A](s: LargeObjectManager, action: LargeObjectManagerIO[A]): PGConnectionIO[A]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def setPrepareThreshold(a: Int): PGConnectionIO[Unit]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped