PostgresNIO Documentation

Structure Postgres​Message.​Bind

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

Identifies the message as a Bind command.

%125 PostgresMessage.Bind PostgresMessage.Bind PostgresMessageType PostgresMessageType PostgresMessage.Bind->PostgresMessageType

Member Of

PostgresMessage

A frontend or backend Postgres message.

Nested Types

PostgresMessage.Bind.Parameter

Conforms To

PostgresMessageType

Properties

identifier

public static var identifier: PostgresMessage.Identifier  

description

public var description: String  

portal​Name

public var portalName: String

The name of the destination portal (an empty string selects the unnamed portal).

statement​Name

public var statementName: String

The name of the source prepared statement (an empty string selects the unnamed prepared statement).

parameter​Format​Codes

public var parameterFormatCodes: [PostgresFormat] 

The number of parameter format codes that follow (denoted C below). This can be zero to indicate that there are no parameters or that the parameters all use the default format (text); or one, in which case the specified format code is applied to all parameters; or it can equal the actual number of parameters. The parameter format codes. Each must presently be zero (text) or one (binary).

parameters

public var parameters: [Parameter] 

The number of parameter values that follow (possibly zero). This must match the number of parameters needed by the query.

result​Format​Codes

public var resultFormatCodes: [PostgresFormat] 

The number of result-column format codes that follow (denoted R below). This can be zero to indicate that there are no result columns or that the result columns should all use the default format (text); or one, in which case the specified format code is applied to all result columns (if any); or it can equal the actual number of result columns of the query.

Methods

serialize(into:​)

public func serialize(into buffer: inout ByteBuffer)  

Serializes this message into a byte buffer.