Structure
PostgresMessage
A frontend or backend Postgres message.
struct PostgresMessage
Topics
Structures
struct BackendKeyDataIdentifies the message as cancellation key data. The frontend must save these values if it wishes to be able to issue CancelRequest messages later.struct BindIdentifies the message as a Bind command.struct CloseIdentifies the message as a Close Commandstruct CommandCompleteIdentifies the message as a Close command.struct DataRowIdentifies the message as a data row.struct DescribeIdentifies the message as a Describe command.struct ErrorA Postgres error response message.struct ExecuteIdentifies the message as an Execute command.struct IdentifierIdentifies an incoming or outgoing postgres message. Sent as the first byte, before the message size. Values are not unique across all identifiers, meaning some messages will require keeping state to identify.struct NotificationResponseIdentifies the message as a notification response.struct ParameterDescriptionIdentifies the message as a parameter description.struct ParameterStatusstruct ParseIdentifies the message as a Parse command.struct PasswordIdentifies the message as a password response. Note that this is also used for GSSAPI and SSPI response messages (which is really a design error, since the contained data is not a null-terminated string in that case, but can be arbitrary binary data).struct ReadyForQueryIdentifies the message type. ReadyForQuery is sent whenever the backend is ready for a new query cycle.struct RowDescriptionIdentifies the message as a row description.struct SASLInitialResponseSASL initial challenge response message sent by the client.struct SASLResponseSASL ongoing challenge response message sent by the client.struct SSLRequestA message asking the PostgreSQL server if SSL is supported For more info, see https://www.postgresql.org/docs/10/static/protocol-flow.html#id-1.10.5.7.11struct SimpleQueryIdentifies the message as a simple query.struct StartupFirst message sent from the frontend during startup.struct SyncIdentifies the message as a Bind command.struct Terminate
Initializers
init<Data>(identifier: PostgresMessage.Identifier, bytes: Data)init(identifier: PostgresMessage.Identifier, data: ByteBuffer)
Instance Properties
Enumerations
enum AuthenticationAuthentication request returned by the server.
Relationships
Conforms To
Swift.Equatable
See Also
Deprecated APIs
protocol PostgresDatabasestruct PostgresDataprotocol PostgresDataConvertiblestruct PostgresQueryResultprotocol PostgresJSONCodableprotocol PostgresJSONBCodableclass PostgresMessageEncoderclass PostgresMessageDecoderprotocol PostgresRequestProtocol to encapsulate a function call on the Postgres serverprotocol PostgresMessageTypetypealias PostgresFormatCodeclass PostgresListenContextContext for receiving NotificationResponse messages on a connection, used for PostgreSQL’sLISTEN/NOTIFYsupport.struct PreparedQueryclass SASLAuthenticationManagerprotocol SASLAuthenticationMechanismThe protocol to which all SASL mechanism implementations must conform. It is the responsibility of each individual implementation to provide an API for creating instances of itself which are able to retrieve information from the caller (such as usernames and passwords) by some mechanism.