Packages

  • package root
    Definition Classes
    root
  • package doobie

    Top-level import, providing aliases for the most commonly used types and modules from doobie-free and doobie-core.

    Top-level import, providing aliases for the most commonly used types and modules from doobie-free and doobie-core. A typical starting set of imports would be something like this.

    import cats.implicits._
    import doobie._, doobie.implicits._
    Definition Classes
    root
    See also

    The doobie microsite for much more information.

  • package hi

    High-level database API.

    High-level database API. The constructors here are defined in terms of those in doobie.free.connection but differ in the following ways:

    • Enumerated values represented by Int values in JDBC are mapped to one of the proper types defined in doobie.enum.
    • Nullable values are represented in terms of Option.
    • Java collection types are translated to immutable Scala equivalents.
    • Actions that compute lifetime-managed resources do not return the resource directly, but rather take a continuation in the resource's monad.
    • Actions that compute values of impure types (CLOB, InputStream, etc.) do not appear in this API. They are available in the low-level API but must be used with considerable caution.
    • Lifting actions, low-level type mapping actions, and resource management actions do not appear in this API.
    Definition Classes
    doobie
  • Modules
  • connection
  • implicits
  • preparedstatement
  • resultset
  • statement
o

doobie.hi

preparedstatement

object preparedstatement

Module of high-level constructors for PreparedStatementIO actions. Batching operations are not provided; see the statement module for this functionality.

Annotations
@SuppressWarnings()
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
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val addBatch: hi.PreparedStatementIO[Unit]

  5. def addBatches[F[_], A](fa: F[A])(implicit arg0: Foldable[F], arg1: util.Write[A]): hi.PreparedStatementIO[Unit]

    Add many sets of parameters.

  6. def addBatchesAndExecute[F[_], A](fa: F[A])(implicit arg0: Foldable[F], arg1: util.Write[A]): hi.PreparedStatementIO[Int]

    Add many sets of parameters and execute as a batch update, returning total rows updated.

    Add many sets of parameters and execute as a batch update, returning total rows updated. Note that failed updates are not reported (see https://github.com/tpolecat/doobie/issues/706). This API is likely to change.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. def delay[A](a: ⇒ A): hi.PreparedStatementIO[A]

    Non-strict unit for capturing effects.

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. val executeBatch: hi.PreparedStatementIO[List[Int]]

  13. def executeQuery[A](k: hi.ResultSetIO[A]): hi.PreparedStatementIO[A]

  14. val executeUpdate: hi.PreparedStatementIO[Int]

  15. def executeUpdateWithGeneratedKeys[A](chunkSize: Int)(implicit arg0: util.Read[A]): Stream[hi.PreparedStatementIO, A]

  16. def executeUpdateWithUniqueGeneratedKeys[A](implicit arg0: util.Read[A]): hi.PreparedStatementIO[A]

  17. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getColumnJdbcMeta: hi.PreparedStatementIO[List[ColumnMeta]]

    Compute the column JdbcMeta list for this PreparedStatement.

  20. def getColumnMappings[A](implicit A: util.Read[A]): hi.PreparedStatementIO[List[Ior[(util.Get[_], NullabilityKnown), ColumnMeta]]]

    Compute the column mappings for this PreparedStatement by aligning its JdbcMeta with the JdbcMeta provided by a Write instance.

  21. val getFetchDirection: hi.PreparedStatementIO[FetchDirection]

  22. val getFetchSize: hi.PreparedStatementIO[Int]

  23. def getGeneratedKeys[A](k: hi.ResultSetIO[A]): hi.PreparedStatementIO[A]

  24. val getMaxFieldSize: hi.PreparedStatementIO[Int]

  25. val getMaxRows: hi.PreparedStatementIO[Int]

  26. val getMetaData: hi.PreparedStatementIO[ResultSetMetaData]

  27. def getParameterJdbcMeta: hi.PreparedStatementIO[List[ParameterMeta]]

    Compute the parameter JdbcMeta list for this PreparedStatement.

  28. def getParameterMappings[A](implicit A: util.Write[A]): hi.PreparedStatementIO[List[Ior[(util.Put[_], NullabilityKnown), ParameterMeta]]]

    Compute the parameter mappings for this PreparedStatement by aligning its JdbcMeta with the JdbcMeta provided by a Write instance.

  29. val getParameterMetaData: hi.PreparedStatementIO[ParameterMetaData]

  30. val getQueryTimeout: hi.PreparedStatementIO[Int]

  31. val getResultSetConcurrency: hi.PreparedStatementIO[ResultSetConcurrency]

  32. val getResultSetHoldability: hi.PreparedStatementIO[Holdability]

  33. val getResultSetType: hi.PreparedStatementIO[ResultSetType]

  34. def getUniqueGeneratedKeys[A](implicit arg0: util.Read[A]): hi.PreparedStatementIO[A]

  35. val getWarnings: hi.PreparedStatementIO[SQLWarning]

  36. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  37. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. def set[A](a: A)(implicit A: util.Write[A]): hi.PreparedStatementIO[Unit]

    Set the given writable value, starting at column 1.

  42. def set[A](n: Int, a: A)(implicit A: util.Write[A]): hi.PreparedStatementIO[Unit]

    Set the given writable value, starting at column n.

  43. def setCursorName(name: String): hi.PreparedStatementIO[Unit]

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

  45. def setFetchDirection(fd: FetchDirection): hi.PreparedStatementIO[Unit]

  46. def setFetchSize(n: Int): hi.PreparedStatementIO[Unit]

  47. def setMaxFieldSize(n: Int): hi.PreparedStatementIO[Unit]

  48. def setMaxRows(n: Int): hi.PreparedStatementIO[Unit]

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

  50. def stream[A](chunkSize: Int)(implicit arg0: util.Read[A]): Stream[hi.PreparedStatementIO, A]

  51. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  52. def toString(): String
    Definition Classes
    AnyRef → Any
  53. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Batching

Constructors (Lifting)

Execution

MetaData

Metadata

Parameters

Properties

Results

Ungrouped