public inbox for [email protected]
help / color / mirror / Atom feedFrom: Dave Cramer <[email protected]>
To: Austin Bonander <[email protected]>
Cc: PostgreSQL Hackers <[email protected]>
Subject: Re: Patch for bind message regarding the number of parameters and result column format codes
Date: Thu, 21 May 2026 14:55:35 -0700
Message-ID: <CADK3HH+Jo_qxDp8B6YJJVVOCRKQuPuH8rGLLeAzWvFMBdmLLyA@mail.gmail.com> (raw)
In-Reply-To: <CADcQg=W4Vfq5yzq88hVcFK3A_+uGjpwLbxxLLUm-o-kGQa5XiQ@mail.gmail.com>
References: <CADK3HHLv-4nU8wFNEodvNedtWP2qBnZvL-9RZzd11mMt7U6hQA@mail.gmail.com>
<CADcQg=W4Vfq5yzq88hVcFK3A_+uGjpwLbxxLLUm-o-kGQa5XiQ@mail.gmail.com>
On Wed, 20 May 2026 at 18:21, Austin Bonander <[email protected]>
wrote:
> I appreciate the follow-up, Dave.
>
> I hope this lands as-is, but for context here is the old thread I found
> that suggested that the full document should be audited and disambiguated
> for signed/unsigned:
> https://www.postgresql.org/message-id/20120901160523.GD2969%40momjian.us
>
> Given the additional effort required, I can understand why this was left
> unresolved for so long.
>
> On Wed, May 20, 2026, 18:12 Dave Cramer <[email protected]> wrote:
>
>> While talking to Austin he noted that the docs for the number of
>> parameters is actually an unsigned integer.
>>
>> This patch corrects that.
>>
>> See
>>
>> 1. Parameter format codes count (line 4323) — read at postgres.c:1725
>> 2. Parameter values count (line 4348) — read at postgres.c:1734
>> 3. Result-column format codes count (line 4396) — read at
>> postgres.c:2017
>>
>> Dave Cramer
>>
>
Using Claude I have created another patch which calls out all
signed/unsigned
see attached
Attachments:
[application/octet-stream] 0001-doc-clarify-unsigned-integer-fields-in-protocol-messages.patch (9.3K, 3-0001-doc-clarify-unsigned-integer-fields-in-protocol-messages.patch)
download | inline diff:
From c4bf7e27a96602409b08eef9bbd9e4ce75aec000 Mon Sep 17 00:00:00 2001
From: Dave Cramer <[email protected]>
Date: Thu, 21 May 2026 08:31:48 -0700
Subject: [PATCH] doc: clarify signedness of integer fields in protocol
messages
Add (unsigned) or (signed) annotations to protocol message fields
to help client implementors correctly size their integer types when
parsing or constructing protocol messages.
---
doc/src/sgml/protocol.sgml | 52 +++++++++++++++++++++-----------------
1 file changed, 29 insertions(+), 23 deletions(-)
diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
index 49f81676712..c6cefb48434 100644
--- a/doc/src/sgml/protocol.sgml
+++ b/doc/src/sgml/protocol.sgml
@@ -4242,7 +4242,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<term>Int32</term>
<listitem>
<para>
- The process ID of this backend.
+ The process ID of this backend (signed).
</para>
</listitem>
</varlistentry>
@@ -4326,7 +4326,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
or that the parameters all use the default format (text);
or one, in which case the specified format code is applied
to all parameters; or it can equal the actual number of
- parameters.
+ parameters (unsigned).
</para>
</listitem>
</varlistentry>
@@ -4346,7 +4346,8 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<listitem>
<para>
The number of parameter values that follow (possibly zero).
- This must match the number of parameters needed by the query.
+ This must match the number of parameters needed by the query
+ (unsigned).
</para>
</listitem>
</varlistentry>
@@ -4362,7 +4363,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<listitem>
<para>
The length of the parameter value, in bytes (this count
- does not include itself). Can be zero.
+ does not include itself, signed). Can be zero.
As a special case, -1 indicates a NULL parameter value.
No value bytes follow in the NULL case.
</para>
@@ -4397,7 +4398,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
(text);
or one, in which case the specified format code is applied
to all result columns (if any); or it can equal the actual
- number of result columns of the query.
+ number of result columns of the query (unsigned).
</para>
</listitem>
</varlistentry>
@@ -4795,7 +4796,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<listitem>
<para>
The number of columns in the data to be copied
- (denoted <replaceable>N</replaceable> below).
+ (denoted <replaceable>N</replaceable> below, unsigned).
</para>
</listitem>
</varlistentry>
@@ -4855,7 +4856,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<listitem>
<para>
The number of columns in the data to be copied
- (denoted <replaceable>N</replaceable> below).
+ (denoted <replaceable>N</replaceable> below, unsigned).
</para>
</listitem>
</varlistentry>
@@ -4915,7 +4916,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<listitem>
<para>
The number of columns in the data to be copied
- (denoted <replaceable>N</replaceable> below).
+ (denoted <replaceable>N</replaceable> below, unsigned).
</para>
</listitem>
</varlistentry>
@@ -4960,7 +4961,8 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<term>Int16</term>
<listitem>
<para>
- The number of column values that follow (possibly zero).
+ The number of column values that follow (possibly zero,
+ unsigned).
</para>
</listitem>
</varlistentry>
@@ -4976,7 +4978,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<listitem>
<para>
The length of the column value, in bytes (this count
- does not include itself). Can be zero.
+ does not include itself, signed). Can be zero.
As a special case, -1 indicates a NULL column value.
No value bytes follow in the NULL case.
</para>
@@ -5164,7 +5166,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<para>
Maximum number of rows to return, if portal contains
a query that returns rows (ignored otherwise). Zero
- denotes <quote>no limit</quote>.
+ denotes <quote>no limit</quote> (unsigned).
</para>
</listitem>
</varlistentry>
@@ -5238,7 +5240,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
or that the arguments all use the default format (text);
or one, in which case the specified format code is applied
to all arguments; or it can equal the actual number of
- arguments.
+ arguments (unsigned).
</para>
</listitem>
</varlistentry>
@@ -5258,7 +5260,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<listitem>
<para>
Specifies the number of arguments being supplied to the
- function.
+ function (unsigned).
</para>
</listitem>
</varlistentry>
@@ -5274,7 +5276,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<listitem>
<para>
The length of the argument value, in bytes (this count
- does not include itself). Can be zero.
+ does not include itself, signed). Can be zero.
As a special case, -1 indicates a NULL argument value.
No value bytes follow in the NULL case.
</para>
@@ -5338,7 +5340,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<listitem>
<para>
The length of the function result value, in bytes (this count
- does not include itself). Can be zero.
+ does not include itself, signed). Can be zero.
As a special case, -1 indicates a NULL function result.
No value bytes follow in the NULL case.
</para>
@@ -5460,7 +5462,8 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<term>Int32</term>
<listitem>
<para>
- Number of protocol options not recognized by the server.
+ Number of protocol options not recognized by the server
+ (unsigned).
</para>
</listitem>
</varlistentry>
@@ -5592,7 +5595,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<term>Int32</term>
<listitem>
<para>
- The process ID of the notifying backend process.
+ The process ID of the notifying backend process (signed).
</para>
</listitem>
</varlistentry>
@@ -5645,7 +5648,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<listitem>
<para>
The number of parameters used by the statement
- (can be zero).
+ (can be zero, unsigned).
</para>
</listitem>
</varlistentry>
@@ -5760,7 +5763,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
(can be zero). Note that this is not an indication of
the number of parameters that might appear in the
query string, only the number that the frontend wants to
- prespecify types for.
+ prespecify types for (unsigned).
</para>
</listitem>
</varlistentry>
@@ -5972,7 +5975,8 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<term>Int16</term>
<listitem>
<para>
- Specifies the number of fields in a row (can be zero).
+ Specifies the number of fields in a row (can be zero,
+ unsigned).
</para>
</listitem>
</varlistentry>
@@ -6025,7 +6029,8 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<term>Int16</term>
<listitem>
<para>
- The data type size (see <varname>pg_type.typlen</varname>).
+ The data type size (see <varname>pg_type.typlen</varname>,
+ signed).
Note that negative values denote variable-width types.
</para>
</listitem>
@@ -6035,7 +6040,8 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<term>Int32</term>
<listitem>
<para>
- The type modifier (see <varname>pg_attribute.atttypmod</varname>).
+ The type modifier (see <varname>pg_attribute.atttypmod</varname>,
+ signed).
The meaning of the modifier is type-specific.
</para>
</listitem>
@@ -6095,7 +6101,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
<listitem>
<para>
Length of SASL mechanism specific "Initial Client Response" that
- follows, or -1 if there is no Initial Response.
+ follows (signed), or -1 if there is no Initial Response.
</para>
</listitem>
</varlistentry>
--
2.50.1 (Apple Git-155)
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: [email protected]
Cc: [email protected], [email protected], [email protected]
Subject: Re: Patch for bind message regarding the number of parameters and result column format codes
In-Reply-To: <CADK3HH+Jo_qxDp8B6YJJVVOCRKQuPuH8rGLLeAzWvFMBdmLLyA@mail.gmail.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox