Proposal: Extending the PostgreSQL Protocol with Command Metadata - Mailing list pgsql-hackers

From Kir Shatrov
Subject Proposal: Extending the PostgreSQL Protocol with Command Metadata
Date
Msg-id CACaFOWZ_qV6_MxTgoOcB0KUoabMcL6r-1_v4OS4=KJHN+Rj-Bw@mail.gmail.com
Whole thread Raw
List pgsql-hackers
Hi hackers,

I'd like to propose a backward-compatible extension to the PostgreSQL Frontend/Backend Protocol that would allow servers to send command metadata back to clients alongside query results.

## Background & Motivation

Coming from a MySQL background, I've found PostgreSQL's lack of session state tracking capabilities to be a significant gap. MySQL's session state tracking allows servers to piggyback metadata on query responses -- things like CPU/IO time consumed, server utilization metrics, tenant quotas, etc.

This capability enables powerful client-side patterns:
- Immediate backoff based on server utilization metadata
- Real-time tenant quota enforcement without separate polling systems
- Query performance tracking without additional round-trips
- Custom application metrics embedded in the protocol flow

## High-Level Proposal

The extension consists of four key components:

1. Client opt-in via a new parameter (`_pq_.send_command_metadata='on'`) on StartupMessage
2. Server-side metadata injection through C API or a SQL function as a demo (`pg_add_command_metadata(key, value)`)
3. New protocol message (`CommandMetadata`, type 'm') sent before `CommandComplete`
4. Client API extensions in libpq to consume the metadata

The goal is to keep backward compatibility while allowing flexibility of the interface, and zero additional cost if you have not opted in.

## Unlocking Greater Extensions

Extensions leveraging this metadata protocol could allow to build things with very little overhead that are not possible today:

- Multi-tenant applications tracking per-query resource consumption (buffer hits/misses, CPU/IO time)
- Connection poolers making routing decisions based on server load
- Applications implementing custom rate limiting based on DB metrics
- Performance monitoring without separate instrumentation queries
- Distributed tracing integration at the protocol level

## Why not session variables?

You could argue this could be achieved by reading session variables after each query, but that quickly becomes not practical: leveraging session variables breaks multiplexing (e.g. PgBouncer) and hitting the server with yet another query when it's already busy just increases the number of incoming queries that it needs to handle.

## Asking for feedback

Is there interest in this type of protocol extension?
What concerns do you have about protocol extensions in general?
Would you prefer a different approach (e.g., separate protocol messages vs. extending existing ones)?

I have a complete technical specification with detailed protocol message formats and API designs on Github [0].

Looking forward to your feedback and suggestions. Thanks!

Regards
Kir

[0] https://github.com/kirs/notes-public/blob/main/postgres-command-metadata.md

pgsql-hackers by date:

Previous
From: Peter Smith
Date:
Subject: Re: Add support for specifying tables in pg_createsubscriber.
Next
From: David Rowley
Date:
Subject: Re: Compilation issues for HASH_STATISTICS and HASH_DEBUG options