PostgresNIO Documentation

Structure Postgres​Message.​Describe

@available(*, deprecated, message: "Will be removed from public API")
    public struct Describe: PostgresMessageType  

Identifies the message as a Describe command.

%121 PostgresMessage.Describe PostgresMessage.Describe PostgresMessageType PostgresMessageType PostgresMessage.Describe->PostgresMessageType

Member Of

PostgresMessage

A frontend or backend Postgres message.

Nested Types

PostgresMessage.Describe.Command

Command type.

Conforms To

PostgresMessageType

Properties

identifier

public static var identifier: PostgresMessage.Identifier  

command

public let command: Command

'S' to describe a prepared statement; or 'P' to describe a portal.

name

public var name: String

The name of the prepared statement or portal to describe (an empty string selects the unnamed prepared statement or portal).

description

public var description: String  

See CustomStringConvertible.

Methods

serialize(into:​)

public func serialize(into buffer: inout ByteBuffer)  

Serializes this message into a byte buffer.