Type Members

1.  type *:[A, B <: Tuple] = ::[A, B]

   Definition Classes

   TwiddleCompat

2.  sealed trait AppliedFragment extends AnyRef

   A fragment applied to its argument, yielding an existentially-typed fragment + argument pair that can be useful when constructing dynamic queries in application code.

   A fragment applied to its argument, yielding an existentially-typed fragment + argument pair that can be useful when constructing dynamic queries in application code. Applied fragments must be deconstructed in order to prepare and execute.

3.  trait Channel[F[_], A, B] extends Pipe[F, A, Unit]

   A channel that can be used for inter-process communication, implemented in terms of LISTEN and NOTIFY.

   A channel that can be used for inter-process communication, implemented in terms of LISTEN and NOTIFY. All instances start life as a Channel[F, String, Notification] but can be mapped out to different input and output types. See the linked documentation for more information on the transactional semantics of these operations.

   See also

   LISTEN

   NOTIFY

4.  trait Codec[A] extends Encoder[A] with Decoder[A]

   Symmetric encoder and decoder of Postgres text-format data to and from Scala types.

5.  final case class Command[A](sql: String, origin: Origin, encoder: Encoder[A]) extends Statement[A] with Product with Serializable

   SQL and parameter encoder for a statement that returns no rows.

   SQL and parameter encoder for a statement that returns no rows. We assume that sql has the same number of placeholders of the form $1, $2, etc., as the number of slots encoded by encoder, and that the parameter types specified by encoder are consistent with the schema. The check methods on Session provide a means to verify this assumption.

   You can construct a Command directly, although it is more typical to use the sql interpolator.

   sql"INSERT INTO foo VALUES ($int2, $varchar)".command // Command[(Short, String)]

   sql

   A SQL statement returning no rows.

   encoder

   An encoder for all parameters $1, $2, etc., in sql.

   See also

   StringContextOps for information on the sql interpolator.

   Session for information on executing a Command.

6.  trait Cursor[F[_], A] extends AnyRef

   An open cursor from which rows can be fetched, valid during the lifetime its defining Session.

   An open cursor from which rows can be fetched, valid during the lifetime its defining Session. You can use this mechanism to implement chunked reads and paged results, although it is ofen more pleasant to use a Cursor-backed Stream, as produced by PreparedQuery#stream.

7.  trait Decoder[A] extends AnyRef

   Decoder of Postgres text-format data into Scala types.

8.  type EmptyTuple = HNil

   Definition Classes

   TwiddleCompat

9.  trait Encoder[A] extends AnyRef

   Encoder of Postgres text-format data from Scala types.

10.  final case class Fragment[A](parts: List[Either[String, State[Int, String]]], encoder: Encoder[A], origin: Origin) extends (A) => AppliedFragment with Product with Serializable

    A composable, embeddable hunk of SQL and typed parameters (common precursor to Command and Query).

    A composable, embeddable hunk of SQL and typed parameters (common precursor to Command and Query). Although it is possible to construct a Fragment directly it is more typical to use the sql interpolator.

11.  trait PreparedCommand[F[_], A] extends AnyRef

    A prepared command, valid for the life of its defining Session.

12.  trait PreparedQuery[F[_], A, B] extends AnyRef

    A prepared query, valid for the life of its originating Session.

13.  final case class Query[A, B](sql: String, origin: Origin, encoder: Encoder[A], decoder: Decoder[B], isDynamic: Boolean = false) extends Statement[A] with Product with Serializable

    SQL, parameter encoder, and row decoder for a statement that returns rows.

    SQL, parameter encoder, and row decoder for a statement that returns rows. We assume that sql has the same number of placeholders of the form $1, $2, etc., as the number of slots encoded by encoder, that sql selects the same number of columns are the number of slots decoded by decoder, and that the parameter and column types specified by encoder and decoder are consistent with the schema. The check methods on Session provide a means to verify this assumption.

    You can construct a Query directly, although it is more typical to use the sql interpolator.

    sql"SELECT name, age FROM person WHERE age > $int2".query(varchar *: int2) // Query[Short, (String, Short)]

    sql

    A SQL statement returning no rows.

    origin

    The Origin where the sql was defined, if any.

    encoder

    An encoder for all parameters $1, $2, etc., in sql.

    decoder

    A decoder for selected columns.

    See also

    StringContextOps for information on the sql interpolator.

    Session for information on executing a Query.

14.  sealed trait RedactionStrategy extends AnyRef

    Specifies how encoded values are redacted before being shown in exceptions and traces.

15.  abstract class SSL extends AnyRef
16.  trait Session[F[_]] extends AnyRef

    Represents a live connection to a Postgres database.

    Represents a live connection to a Postgres database. Operations provided here are safe to use concurrently. Note that this is a lifetime-managed resource and as such is invalid outside the scope of its owning Resource, as are any streams constructed here. If you start an operation be sure to join its Fiber before releasing the resource.

    See the companion object for information on obtaining a pooled or single-use instance.

17.  type SessionPool[F[_]] = Resource[F, Resource[F, Session[F]]]
18.  sealed abstract class SqlState extends EnumEntry

    Enumerated type of Postgres error codes.

    Enumerated type of Postgres error codes. See the companion object for more information.

19.  trait Statement[A] extends AnyRef
20.  type Strategy = skunk.util.Typer.Strategy
21.  trait Transaction[F[_]] extends AnyRef

    Control methods for use within a transaction block.

    Control methods for use within a transaction block. An instance is provided when you call Session.transaction(...).use.

    See also

    Session#transaction for information on default commit/rollback behavior

22.  type Tuple = HList

    Definition Classes

    TwiddleCompat

23.  sealed trait Void extends AnyRef

    A singly-inhabited type representing arguments to a parameterless statement.

24.  type ~[+A, +B] = (A, B)

    Infix alias for (A, B) that provides convenient syntax for left-associated HLists.