Structs§
- Authentication
Cleartext Password - The
AuthenticationCleartextPasswordstruct represents a message indicating that a cleartext password is required for authentication. - Authentication
Cleartext Password Builder - AuthenticationGSS
- The
AuthenticationGSSstruct represents a message indicating that GSSAPI authentication is required. - AuthenticationGSS
Builder - AuthenticationGSS
Continue - The
AuthenticationGSSContinuestruct represents a message indicating the continuation of GSSAPI authentication. - AuthenticationGSS
Continue Builder - Authentication
Kerberos V5 - The
AuthenticationKerberosV5struct represents a message indicating that Kerberos V5 authentication is required. - Authentication
Kerberos V5Builder - AuthenticationM
D5Password - The
AuthenticationMD5Passwordstruct represents a message indicating that an MD5-encrypted password is required for authentication. - AuthenticationM
D5Password Builder - Authentication
Message - The
AuthenticationMessagestruct is a base for all Postgres authentication messages. - Authentication
Message Builder - Authentication
Ok - The
AuthenticationOkstruct represents a message indicating successful authentication. - Authentication
OkBuilder - AuthenticationSASL
- The
AuthenticationSASLstruct represents a message indicating that SASL authentication is required. - AuthenticationSASL
Builder - AuthenticationSASL
Continue - The
AuthenticationSASLContinuestruct represents a message containing a SASL challenge during the authentication process. - AuthenticationSASL
Continue Builder - AuthenticationSASL
Final - The
AuthenticationSASLFinalstruct represents a message indicating the completion of SASL authentication. - AuthenticationSASL
Final Builder - AuthenticationSCM
Credential - The
AuthenticationSCMCredentialstruct represents a message indicating that an SCM credential is required for authentication. - AuthenticationSCM
Credential Builder - AuthenticationSSPI
- The
AuthenticationSSPIstruct represents a message indicating that SSPI authentication is required. - AuthenticationSSPI
Builder - Backend
KeyData - The
BackendKeyDatastruct represents a message containing the process ID and secret key for this backend. - Backend
KeyData Builder - Bind
- The
Bindstruct represents a message to bind a named portal to a prepared statement. - Bind
Builder - Bind
Complete - The
BindCompletestruct represents a message indicating that a Bind operation was successful. - Bind
Complete Builder - Cancel
Request - The
CancelRequeststruct represents a message to request the cancellation of a query. - Cancel
Request Builder - Close
- The
Closestruct represents a message to close a prepared statement or portal. - Close
Builder - Close
Complete - The
CloseCompletestruct represents a message indicating that a Close operation was successful. - Close
Complete Builder - Command
Complete - The
CommandCompletestruct represents a message indicating the successful completion of a command. - Command
Complete Builder - Copy
Both Response - The
CopyBothResponseis used only for Streaming Replication. - Copy
Both Response Builder - Copy
Data - The
CopyDatastruct represents a message containing data for a copy operation. - Copy
Data Builder - Copy
Done - The
CopyDonestruct represents a message indicating that a copy operation is complete. - Copy
Done Builder - Copy
Fail - The
CopyFailstruct represents a message indicating that a copy operation has failed. - Copy
Fail Builder - Copy
InResponse - The
CopyInResponsestruct represents a message indicating that the server is ready to receive data for a copy-in operation. - Copy
InResponse Builder - Copy
OutResponse - The
CopyOutResponsestruct represents a message indicating that the server is ready to send data for a copy-out operation. - Copy
OutResponse Builder - DataRow
- The
DataRowstruct represents a message containing a row of data. - Data
RowBuilder - Describe
- The
Describestruct represents a message to describe a prepared statement or portal. - Describe
Builder - Empty
Query Response - The
EmptyQueryResponsestruct represents a message indicating that an empty query string was recognized. - Empty
Query Response Builder - Error
Field - The
ErrorFieldstruct represents a single error message within anErrorResponse. - Error
Field Builder - Error
Response - The
ErrorResponsestruct represents a message indicating that an error has occurred. - Error
Response Builder - Execute
- The
Executestruct represents a message to execute a prepared statement or portal. - Execute
Builder - Flush
- The
Flushstruct represents a message to flush the backend’s output buffer. - Flush
Builder - Function
Call - The
FunctionCallstruct represents a message to call a function. - Function
Call Builder - Function
Call Response - The
FunctionCallResponsestruct represents a message containing the result of a function call. - Function
Call Response Builder - GSSENC
Request - The
GSSENCRequeststruct represents a message requesting GSSAPI encryption. - GSSENC
Request Builder - GSSResponse
- The
GSSResponsestruct represents a message containing a GSSAPI or SSPI response. - GSSResponse
Builder - Initial
Message - A generic base for all initial Postgres messages.
- Initial
Message Builder - Message
- A generic base for all Postgres mtype/mlen-style messages.
- Message
Builder - Negotiate
Protocol Version - The
NegotiateProtocolVersionstruct represents a message requesting protocol version negotiation. - Negotiate
Protocol Version Builder - NoData
- The
NoDatastruct represents a message indicating that there is no data to return. - NoData
Builder - Notice
Field - The
NoticeFieldstruct represents a single error message within anNoticeResponse. - Notice
Field Builder - Notice
Response - The
NoticeResponsestruct represents a message containing a notice. - Notice
Response Builder - Notification
Response - The
NotificationResponsestruct represents a message containing a notification from the backend. - Notification
Response Builder - Parameter
Description - The
ParameterDescriptionstruct represents a message describing the parameters needed by a prepared statement. - Parameter
Description Builder - Parameter
Status - The
ParameterStatusstruct represents a message containing the current status of a parameter. - Parameter
Status Builder - Parse
- The
Parsestruct represents a message to parse a query string. - Parse
Builder - Parse
Complete - The
ParseCompletestruct represents a message indicating that a Parse operation was successful. - Parse
Complete Builder - Password
Message - The
PasswordMessagestruct represents a message containing a password. - Password
Message Builder - Portal
Suspended - The
PortalSuspendedstruct represents a message indicating that a portal has been suspended. - Portal
Suspended Builder - Query
- The
Querystruct represents a message to execute a simple query. - Query
Builder - Ready
ForQuery - The
ReadyForQuerystruct represents a message indicating that the backend is ready for a new query. - Ready
ForQuery Builder - RowDescription
- The
RowDescriptionstruct represents a message describing the rows that will be returned by a query. - RowDescription
Builder - RowField
- The
RowFieldstruct represents a row within theRowDescriptionmessage. - RowField
Builder - SASL
Initial Response - The
SASLInitialResponsestruct represents a message containing a SASL initial response. - SASL
Initial Response Builder - SASL
Response - The
SASLResponsestruct represents a message containing a SASL response. - SASL
Response Builder - SSLRequest
- The
SSLRequeststruct represents a message requesting SSL encryption. - SSLRequest
Builder - SSLResponse
- Available fields:
- SSLResponse
Builder - Startup
Message - The
StartupMessagestruct represents a message to initiate a connection. - Startup
Message Builder - Startup
Name Value - The
StartupMessagestruct represents a name/value pair within theStartupMessagemessage. - Startup
Name Value Builder - Sync
- The
Syncstruct represents a message to synchronize the frontend and backend. - Sync
Builder - Terminate
- The
Terminatestruct represents a message to terminate a connection. - Terminate
Builder
Enums§
- Backend
- The
Backendmessage group contains messages sent from the backend to the frontend. - Backend
Builder - Close
Type - The type of object to close.
- Copy
Format - The data format for a copy operation.
- Describe
Type - The type of object to describe.
- Format
Code - The format code for an input or output value.
- Frontend
- The
Frontendmessage group contains messages sent from the frontend to the backend. - Frontend
Builder - Initial
- The
Initialmessage group contains messages that are sent before the normal message flow. - Initial
Builder