skunk-core
0.6.1
API
Generated with
skunk-core/skunk/skunk.net/Protocol

Protocol

skunk.net.Protocol
See theProtocol companion trait
object Protocol

Attributes

Companion
trait
Source
Protocol.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Protocol.type

Members list

Type members

Classlikes

abstract class CommandPortal[F[_], A](val id: PortalId, val preparedCommand: PreparedCommand[F, A], val arguments: A, val argumentsOrigin: Origin) extends Portal[F, A]

Attributes

Source
Protocol.scala
Supertypes
trait Portal[F, A]
class Object
trait Matchable
class Any
sealed trait Portal[F[_], A]

Value parameters

id

the Postgres identifier of this statement.

preparedStatement

the PreparedStatement used to construct this Portal.

Attributes

Source
Protocol.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class CommandPortal[F, A]
class QueryPortal[F, A, B]
final case class PortalId(value: String)

Postgres identifier of a portal, used by the protocol in subsequent Execute operations.

Postgres identifier of a portal, used by the protocol in subsequent Execute operations.

Attributes

Source
Protocol.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
abstract class PreparedCommand[F[_], A](val id: StatementId, val command: Command[A]) extends PreparedStatement[F, A]

A prepared command.

A prepared command.

Value parameters

command

the userland Command used to construct this PreparedCommand.

id

the Postgres identifier of this statement.

Attributes

Source
Protocol.scala
Supertypes
trait PreparedStatement[F, A]
class Object
trait Matchable
class Any
abstract class PreparedQuery[F[_], A, B](val id: StatementId, val query: Query[A, B], val rowDescription: TypedRowDescription) extends PreparedStatement[F, A]

A prepared query.

A prepared query.

Value parameters

id

the Postgres identifier of this statement.

query

the userland Query used to construct this PreparedQuery.

rowDescription

a RowDescription specifying this PreparedQuery's output format.'.

Attributes

Source
Protocol.scala
Supertypes
trait PreparedStatement[F, A]
class Object
trait Matchable
class Any
sealed trait PreparedStatement[F[_], A]

A prepared statement.

A prepared statement.

Value parameters

id

the Postgres identifier of this statement.

statement

the userland Statement used to construct this PreparedStatement.

Attributes

Source
Protocol.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class PreparedCommand[F, A]
class PreparedQuery[F, A, B]
abstract class QueryPortal[F[_], A, B](val id: PortalId, val preparedQuery: PreparedQuery[F, A, B], val arguments: A, val argumentsOrigin: Origin) extends Portal[F, A]

Attributes

Source
Protocol.scala
Supertypes
trait Portal[F, A]
class Object
trait Matchable
class Any
final case class StatementId(value: String)

Postgres identifier of a prepared statement, used by the protocol in subsequent Bind operations.

Postgres identifier of a prepared statement, used by the protocol in subsequent Bind operations.

Attributes

Source
Protocol.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Concrete methods

def apply[F[_] : Console](host: String, port: Int, debug: Boolean, nam: Namer[F], sg: SocketGroup[F], socketOptions: List[SocketOption], sslOptions: Option[Options[F]], describeCache: Cache[F], parseCache: Cache[F], readTimeout: Duration): Resource[F, Protocol[F]]

Resource yielding a new Protocol with the given host and port.

Resource yielding a new Protocol with the given host and port.

Value parameters

host

Postgres server host

port

Postgres port, default 5432

Attributes

Source
Protocol.scala
def fromMessageSocket[F[_] : Trace](bms: BufferedMessageSocket[F], nam: Namer[F], dc: Cache[F], pc: Cache[F]): F[Protocol[F]]

Attributes

Source
Protocol.scala
Generated with