data.drivers._pelt._messages

Page actions AI-ready formats and sharing
Open LLM text
Share with AI
Ask Claude Ask ChatGPT Ask Gemini Ask Copilot
module

Typed, immutable representations of PostgreSQL backend (server → client) messages.

Every message isfrozen=True, slots=True— they are produced by the sans-I/O framer (._framing) and handed cheaply between free-threaded workers;…

Typed, immutable representations of PostgreSQL backend (server → client) messages.

Every message isfrozen=True, slots=True— they are produced by the sans-I/O framer (._framing) and handed cheaply between free-threaded workers; frozenness is the thread-safety guarantee. ThePGMessageunion (PEP 695) is the single typed value the framer returns. This module touches no socket and no anyio.

Only the message set pelt needs for the E1 spine + the extended-query protocol (epic E3) is modelled here; COPY and replication messages are out of scope.

data.drivers._pelt._messages

Name Type Default Description
type —
qualified_name —
element_type —
description —
source_file —
line_number —
is_autodoc —
autodoc_element —
_autodoc_template —
_autodoc_url_path —
_autodoc_page_type —
title —
doc_content_hash —

Symbols on this page

class AuthenticationOk

AuthenticationOk— the server accepted the credentials.

Jump to symbol class AuthenticationCleartextPassword

The server wants a cleartext password.

Jump to symbol class AuthenticationMD5Password

The server wants an MD5-hashed password, salted withsalt.

Jump to symbol class AuthenticationSASL

The server offers SASL authentication with these mechanisms (e.g. SCRAM-SHA-256).

Jump to symbol class AuthenticationSASLContinue

A SASL challenge from the server.

Jump to symbol class AuthenticationSASLFinal

The final SASL message from the server.

Jump to symbol class ParameterStatus

A server runtime parameter report (tag'S'), e.g. server_version.

Jump to symbol class BackendKeyData

Cancellation key material (tag'K') — needed to cancel a running query.

Jump to symbol class ReadyForQuery

The server is ready (tag'Z'). status is 'I' idle, 'T'in-transaction, or'E'failed-transaction.

Jump to symbol class FieldDescription

One column descriptor within aRowDescription.

Jump to symbol class RowDescription

The column layout of a result set (tag'T').

Jump to symbol class DataRow

One result row (tag'D'). Each value is the raw wire bytes or Nonefor SQL NULL; decoding to Python objects happens later…

Jump to symbol class CommandComplete

A command finished (tag'C'). tag is e.g. 'INSERT 0 1' / 'SELECT 5'.

Jump to symbol class ParameterDescription

Parameter OIDs for a prepared statement (tag't').

Jump to symbol class ErrorResponse

A server error (tag'E'). Fields are kept as (code, value)pairs to stay hashable + frozen; the common ones are exposed as properties.

Jump to symbol class NoticeResponse

A non-fatal notice (tag'N'). Same structure as ErrorResponse.

Jump to symbol class NotificationResponse

An asyncNOTIFY payload (tag 'A') — drives LISTEN/NOTIFY (epic E5).

Jump to symbol class ParseComplete

Tag'1'.

Jump to symbol class BindComplete

Tag'2'.

Jump to symbol class CloseComplete

Tag'3'.

Jump to symbol class NoData

Tag'n'— a prepared statement returns no rows.

Jump to symbol class PortalSuspended

Tag's' — an Executerow limit was reached; more rows remain.

Jump to symbol class EmptyQueryResponse

Tag'I'— the query string was empty.

Jump to symbol
AuthenticationOk
class

AuthenticationOk— the server accepted the credentials.

AuthenticationCleartextPassword
class

The server wants a cleartext password.

AuthenticationMD5Password
class

The server wants an MD5-hashed password, salted withsalt.

AuthenticationSASL
class

The server offers SASL authentication with these mechanisms (e.g. SCRAM-SHA-256).

AuthenticationSASLContinue
class

A SASL challenge from the server.

AuthenticationSASLFinal
class

The final SASL message from the server.

ParameterStatus
class

A server runtime parameter report (tag'S'), e.g. server_version.

BackendKeyData
class

Cancellation key material (tag'K') — needed to cancel a running query.

ReadyForQuery
class

The server is ready (tag'Z'). status is 'I' idle, 'T'in-transaction, or'E'failed-transaction.

FieldDescription
class

One column descriptor within aRowDescription.

RowDescription
class

The column layout of a result set (tag'T').

DataRow
class

One result row (tag'D'). Each value is the raw wire bytes or Nonefor SQL NULL; decoding to Python objects happens later via the codec plan (epic E2).

CommandComplete
class

A command finished (tag'C'). tag is e.g. 'INSERT 0 1' / 'SELECT 5'.

ParameterDescription
class

Parameter OIDs for a prepared statement (tag't').

ErrorResponse
class

A server error (tag'E'). Fields are kept as (code, value)pairs to stay hashable + frozen; the common ones are exposed as properties.

NoticeResponse
class

A non-fatal notice (tag'N'). Same structure as ErrorResponse.

NotificationResponse
class

An asyncNOTIFY payload (tag 'A') — drives LISTEN/NOTIFY (epic E5).

ParseComplete
class

Tag'1'.

BindComplete
class

Tag'2'.

CloseComplete
class

Tag'3'.

NoData
class

Tag'n'— a prepared statement returns no rows.

PortalSuspended
class

Tag's' — an Executerow limit was reached; more rows remain.

EmptyQueryResponse
class

Tag'I'— the query string was empty.

View source · /home/runner/work/chirp/chirp/site/../src/chirp/data/drivers/_pelt/_messages.py:1