Re: 9.4.1. format - Mailing list pgsql-docs

From David G. Johnston
Subject Re: 9.4.1. format
Date
Msg-id CAKFQuwZYpKRfpunJJV2t_nmTavU+TANoSaKsa1c36hthPYb5tA@mail.gmail.com
Whole thread
In response to 9.4.1. format  (PG Doc comments form <noreply@postgresql.org>)
Responses Re: 9.4.1. format
List pgsql-docs
On Saturday, September 19, 2026, PG Doc comments form <noreply@postgresql.org> wrote:
The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/18/functions-string.html
Description:

>> Here are some examples of the basic format conversions:

```html
SELECT format('INSERT INTO %I VALUES(%L)', 'locations', 'C:\Program Files');
Result: INSERT INTO locations VALUES('C:\Program Files')
```

```sql
db=# SELECT format('INSERT INTO %I VALUES(%L)', 'locations', 'C:\Program
Files');

                       format
----------------------------------------------------
 INSERT INTO locations VALUES(E'C:\\Program Files')
```

Indeed, the example doesn’t reflect the actual output since the presence of a backslash prompts format to produce syntax for an escape string.

I don’t see a point for explaining when it may choose to write an escape string but the examples should match reality.  I’d back-patch this to supported versions on that basis.

David J.

pgsql-docs by date:

Previous
From: PG Doc comments form
Date:
Subject: 9.4.1. format
Next
From: PG Doc comments form
Date:
Subject: E.6.3.2.1. Constraints