Crate mz_pgwire

PostgreSQL network (“wire”) protocol.

For brevity, we often refer to the protocol as “pgwire,” hence the name of this module. Beware that this name is only commonly used in the CockroachDB and Materialize ecosystems. The PostgreSQL documentation, for example, uses the long-winded “Frontend/Backend Protocol” title instead.

Useful references

• PostgreSQL Frontend/Backend Protocol documentation
• CockroachDB pgwire implementation
• “Postgres on the wire” PGCon talk

Modules

• codec 🔒
  Encoding/decoding of messages in pgwire. See “Frontend/Backend Protocol: Message Formats” in the PostgreSQL reference for the specification.
• message 🔒
• metrics 🔒
• protocol 🔒
• server 🔒

Structs

• Config
  Configures a Server.
• MetricsConfig
• Server
  A server that communicates with clients via the pgwire protocol.

Functions

• match_handshake
  Reports whether the given stream begins with a pgwire handshake.