doobie.free

preparedstatement

object preparedstatement

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

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

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

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

// Unfolding into a Task
val ta: Task[A] = a.transK[Task].run(s)
Source
preparedstatement.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. preparedstatement
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type PreparedStatementIO[A] = Free[PreparedStatementOp, A]

    Free monad over a free functor of PreparedStatementOp; abstractly, a computation that consumes a java.sql.PreparedStatement and produces a value of type A.

  2. implicit class PreparedStatementIOOps[A] extends AnyRef

    Syntax for PreparedStatementIO.

  3. sealed trait PreparedStatementOp[A] extends AnyRef

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

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. implicit val CapturePreparedStatementIO: Capture[PreparedStatementIO]

    Capture instance for PreparedStatementIO.

  7. implicit val CatchablePreparedStatementIO: Catchable[PreparedStatementIO]

    Catchable instance for PreparedStatementIO.

  8. object PreparedStatementOp

    Module of constructors for PreparedStatementOp.

  9. def addBatch(a: String): PreparedStatementIO[Unit]

  10. val addBatch: PreparedStatementIO[Unit]

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  12. def attempt[A](a: PreparedStatementIO[A]): PreparedStatementIO[\/[Throwable, A]]

    Lift a PreparedStatementIO[A] into an exception-capturing PreparedStatementIO[Throwable \/ A].

  13. val cancel: PreparedStatementIO[Unit]

  14. val clearBatch: PreparedStatementIO[Unit]

  15. val clearParameters: PreparedStatementIO[Unit]

  16. val clearWarnings: PreparedStatementIO[Unit]

  17. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  18. val close: PreparedStatementIO[Unit]

  19. val closeOnCompletion: PreparedStatementIO[Unit]

  20. def delay[A](a: ⇒ A): PreparedStatementIO[A]

    Non-strict unit for capturing effects.

  21. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  22. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  23. def execute(a: String, b: Array[String]): PreparedStatementIO[Boolean]

  24. def execute(a: String): PreparedStatementIO[Boolean]

  25. def execute(a: String, b: Int): PreparedStatementIO[Boolean]

  26. def execute(a: String, b: Array[Int]): PreparedStatementIO[Boolean]

  27. val execute: PreparedStatementIO[Boolean]

  28. val executeBatch: PreparedStatementIO[Array[Int]]

  29. def executeQuery(a: String): PreparedStatementIO[ResultSet]

  30. val executeQuery: PreparedStatementIO[ResultSet]

  31. def executeUpdate(a: String, b: Int): PreparedStatementIO[Int]

  32. def executeUpdate(a: String, b: Array[Int]): PreparedStatementIO[Int]

  33. def executeUpdate(a: String, b: Array[String]): PreparedStatementIO[Int]

  34. def executeUpdate(a: String): PreparedStatementIO[Int]

  35. val executeUpdate: PreparedStatementIO[Int]

  36. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  37. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  38. val getConnection: PreparedStatementIO[Connection]

  39. val getFetchDirection: PreparedStatementIO[Int]

  40. val getFetchSize: PreparedStatementIO[Int]

  41. val getGeneratedKeys: PreparedStatementIO[ResultSet]

  42. val getMaxFieldSize: PreparedStatementIO[Int]

  43. val getMaxRows: PreparedStatementIO[Int]

  44. val getMetaData: PreparedStatementIO[ResultSetMetaData]

  45. def getMoreResults(a: Int): PreparedStatementIO[Boolean]

  46. val getMoreResults: PreparedStatementIO[Boolean]

  47. val getParameterMetaData: PreparedStatementIO[ParameterMetaData]

  48. val getQueryTimeout: PreparedStatementIO[Int]

  49. val getResultSet: PreparedStatementIO[ResultSet]

  50. val getResultSetConcurrency: PreparedStatementIO[Int]

  51. val getResultSetHoldability: PreparedStatementIO[Int]

  52. val getResultSetType: PreparedStatementIO[Int]

  53. val getUpdateCount: PreparedStatementIO[Int]

  54. val getWarnings: PreparedStatementIO[SQLWarning]

  55. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  56. def interpK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[PreparedStatementOp, [γ]Kleisli[M, PreparedStatement, γ]]

    Natural transformation from PreparedStatementOp to Kleisli for the given M, consuming a java.sql.PreparedStatement.

  57. val isCloseOnCompletion: PreparedStatementIO[Boolean]

  58. val isClosed: PreparedStatementIO[Boolean]

  59. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  60. val isPoolable: PreparedStatementIO[Boolean]

  61. def isWrapperFor(a: Class[_]): PreparedStatementIO[Boolean]

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

    Lift a different type of program that has a default Kleisli interpreter.

  63. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  64. final def notify(): Unit

    Definition Classes
    AnyRef

  65. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  66. def raw[A](f: (PreparedStatement) ⇒ A): PreparedStatementIO[A]

    Backdoor for arbitrary computations on the underlying PreparedStatement.

  67. def setArray(a: Int, b: Array): PreparedStatementIO[Unit]

  68. def setAsciiStream(a: Int, b: InputStream): PreparedStatementIO[Unit]

  69. def setAsciiStream(a: Int, b: InputStream, c: Int): PreparedStatementIO[Unit]

  70. def setAsciiStream(a: Int, b: InputStream, c: Long): PreparedStatementIO[Unit]

  71. def setBigDecimal(a: Int, b: BigDecimal): PreparedStatementIO[Unit]

  72. def setBinaryStream(a: Int, b: InputStream, c: Long): PreparedStatementIO[Unit]

  73. def setBinaryStream(a: Int, b: InputStream): PreparedStatementIO[Unit]

  74. def setBinaryStream(a: Int, b: InputStream, c: Int): PreparedStatementIO[Unit]

  75. def setBlob(a: Int, b: InputStream): PreparedStatementIO[Unit]

  76. def setBlob(a: Int, b: InputStream, c: Long): PreparedStatementIO[Unit]

  77. def setBlob(a: Int, b: Blob): PreparedStatementIO[Unit]

  78. def setBoolean(a: Int, b: Boolean): PreparedStatementIO[Unit]

  79. def setByte(a: Int, b: Byte): PreparedStatementIO[Unit]

  80. def setBytes(a: Int, b: Array[Byte]): PreparedStatementIO[Unit]

  81. def setCharacterStream(a: Int, b: Reader, c: Long): PreparedStatementIO[Unit]

  82. def setCharacterStream(a: Int, b: Reader, c: Int): PreparedStatementIO[Unit]

  83. def setCharacterStream(a: Int, b: Reader): PreparedStatementIO[Unit]

  84. def setClob(a: Int, b: Reader, c: Long): PreparedStatementIO[Unit]

  85. def setClob(a: Int, b: Reader): PreparedStatementIO[Unit]

  86. def setClob(a: Int, b: Clob): PreparedStatementIO[Unit]

  87. def setCursorName(a: String): PreparedStatementIO[Unit]

  88. def setDate(a: Int, b: Date, c: Calendar): PreparedStatementIO[Unit]

  89. def setDate(a: Int, b: Date): PreparedStatementIO[Unit]

  90. def setDouble(a: Int, b: Double): PreparedStatementIO[Unit]

  91. def setEscapeProcessing(a: Boolean): PreparedStatementIO[Unit]

  92. def setFetchDirection(a: Int): PreparedStatementIO[Unit]

  93. def setFetchSize(a: Int): PreparedStatementIO[Unit]

  94. def setFloat(a: Int, b: Float): PreparedStatementIO[Unit]

  95. def setInt(a: Int, b: Int): PreparedStatementIO[Unit]

  96. def setLong(a: Int, b: Long): PreparedStatementIO[Unit]

  97. def setMaxFieldSize(a: Int): PreparedStatementIO[Unit]

  98. def setMaxRows(a: Int): PreparedStatementIO[Unit]

  99. def setNCharacterStream(a: Int, b: Reader, c: Long): PreparedStatementIO[Unit]

  100. def setNCharacterStream(a: Int, b: Reader): PreparedStatementIO[Unit]

  101. def setNClob(a: Int, b: Reader): PreparedStatementIO[Unit]

  102. def setNClob(a: Int, b: NClob): PreparedStatementIO[Unit]

  103. def setNClob(a: Int, b: Reader, c: Long): PreparedStatementIO[Unit]

  104. def setNString(a: Int, b: String): PreparedStatementIO[Unit]

  105. def setNull(a: Int, b: Int, c: String): PreparedStatementIO[Unit]

  106. def setNull(a: Int, b: Int): PreparedStatementIO[Unit]

  107. def setObject(a: Int, b: AnyRef): PreparedStatementIO[Unit]

  108. def setObject(a: Int, b: AnyRef, c: Int): PreparedStatementIO[Unit]

  109. def setObject(a: Int, b: AnyRef, c: Int, d: Int): PreparedStatementIO[Unit]

  110. def setPoolable(a: Boolean): PreparedStatementIO[Unit]

  111. def setQueryTimeout(a: Int): PreparedStatementIO[Unit]

  112. def setRef(a: Int, b: Ref): PreparedStatementIO[Unit]

  113. def setRowId(a: Int, b: RowId): PreparedStatementIO[Unit]

  114. def setSQLXML(a: Int, b: SQLXML): PreparedStatementIO[Unit]

  115. def setShort(a: Int, b: Short): PreparedStatementIO[Unit]

  116. def setString(a: Int, b: String): PreparedStatementIO[Unit]

  117. def setTime(a: Int, b: Time): PreparedStatementIO[Unit]

  118. def setTime(a: Int, b: Time, c: Calendar): PreparedStatementIO[Unit]

  119. def setTimestamp(a: Int, b: Timestamp, c: Calendar): PreparedStatementIO[Unit]

  120. def setTimestamp(a: Int, b: Timestamp): PreparedStatementIO[Unit]

  121. def setURL(a: Int, b: URL): PreparedStatementIO[Unit]

  122. def setUnicodeStream(a: Int, b: InputStream, c: Int): PreparedStatementIO[Unit]

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

    Definition Classes
    AnyRef

  124. def toString(): String

    Definition Classes
    AnyRef → Any

  125. def trans[M[_]](c: PreparedStatement)(implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[PreparedStatementIO, M]

    Natural transformation from PreparedStatementIO to M, given a java.sql.PreparedStatement.

  126. def transK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[PreparedStatementIO, [γ]Kleisli[M, PreparedStatement, γ]]

    Natural transformation from PreparedStatementIO to Kleisli for the given M, consuming a java.sql.PreparedStatement.

  127. def unwrap[T](a: Class[T]): PreparedStatementIO[T]

  128. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  130. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped