Adding upstream version 13.4.upstream/13.4 upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
author: Daniel Baumann <daniel.baumann@progress-linux.org> 2024-05-04 12:19:15 +0000
committer: Daniel Baumann <daniel.baumann@progress-linux.org> 2024-05-04 12:19:15 +0000
commit: 6eb9c5a5657d1fe77b55cc261450f3538d35a94d (patch)
tree: 657d8194422a5daccecfd42d654b8a245ef7b4c8 /doc/src/sgml/html/protocol-error-fields.html
parent: Initial commit. (diff)
download: postgresql-13-upstream.tar.xz
postgresql-13-upstream.zip
1 files changed, 135 insertions, 0 deletions
diff --git a/doc/src/sgml/html/protocol-error-fields.html b/doc/src/sgml/html/protocol-error-fields.html
new file mode 100644
index 0000000..63b59b6
--- /dev/null
+++ b/doc/src/sgml/html/protocol-error-fields.html
@@ -0,0 +1,135 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>52.8. Error and Notice Message Fields</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="prev" href="protocol-message-formats.html" title="52.7. Message Formats" /><link rel="next" href="protocol-logicalrep-message-formats.html" title="52.9. Logical Replication Message Formats" /></head><body id="docContent" class="container-fluid col-10"><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">52.8. Error and Notice Message Fields</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="protocol-message-formats.html" title="52.7. Message Formats">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="protocol.html" title="Chapter 52. Frontend/Backend Protocol">Up</a></td><th width="60%" align="center">Chapter 52. Frontend/Backend Protocol</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 13.4 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="protocol-logicalrep-message-formats.html" title="52.9. Logical Replication Message Formats">Next</a></td></tr></table><hr></hr></div><div class="sect1" id="PROTOCOL-ERROR-FIELDS"><div class="titlepage"><div><div><h2 class="title" style="clear: both">52.8. Error and Notice Message Fields</h2></div></div></div><p>
+This section describes the fields that can appear in ErrorResponse and
+NoticeResponse messages.  Each field type has a single-byte identification
+token.  Note that any given field type should appear at most once per
+message.
+</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
+<code class="literal">S</code>
+</span></dt><dd><p>
+        Severity: the field contents are
+        <code class="literal">ERROR</code>, <code class="literal">FATAL</code>, or
+        <code class="literal">PANIC</code> (in an error message), or
+        <code class="literal">WARNING</code>, <code class="literal">NOTICE</code>, <code class="literal">DEBUG</code>,
+        <code class="literal">INFO</code>, or <code class="literal">LOG</code> (in a notice message),
+        or a localized translation of one of these.  Always present.
+</p></dd><dt><span class="term">
+<code class="literal">V</code>
+</span></dt><dd><p>
+        Severity: the field contents are
+        <code class="literal">ERROR</code>, <code class="literal">FATAL</code>, or
+        <code class="literal">PANIC</code> (in an error message), or
+        <code class="literal">WARNING</code>, <code class="literal">NOTICE</code>, <code class="literal">DEBUG</code>,
+        <code class="literal">INFO</code>, or <code class="literal">LOG</code> (in a notice message).
+        This is identical to the <code class="literal">S</code> field except
+        that the contents are never localized.  This is present only in
+        messages generated by <span class="productname">PostgreSQL</span> versions 9.6
+        and later.
+</p></dd><dt><span class="term">
+<code class="literal">C</code>
+</span></dt><dd><p>
+        Code: the SQLSTATE code for the error (see <a class="xref" href="errcodes-appendix.html" title="Appendix A. PostgreSQL Error Codes">Appendix A</a>).  Not localizable.  Always present.
+</p></dd><dt><span class="term">
+<code class="literal">M</code>
+</span></dt><dd><p>
+        Message: the primary human-readable error message.
+        This should be accurate but terse (typically one line).
+        Always present.
+</p></dd><dt><span class="term">
+<code class="literal">D</code>
+</span></dt><dd><p>
+        Detail: an optional secondary error message carrying more
+        detail about the problem.  Might run to multiple lines.
+</p></dd><dt><span class="term">
+<code class="literal">H</code>
+</span></dt><dd><p>
+        Hint: an optional suggestion what to do about the problem.
+        This is intended to differ from Detail in that it offers advice
+        (potentially inappropriate) rather than hard facts.
+        Might run to multiple lines.
+</p></dd><dt><span class="term">
+<code class="literal">P</code>
+</span></dt><dd><p>
+        Position: the field value is a decimal ASCII integer, indicating
+        an error cursor position as an index into the original query string.
+        The first character has index 1, and positions are measured in
+        characters not bytes.
+</p></dd><dt><span class="term">
+<code class="literal">p</code>
+</span></dt><dd><p>
+        Internal position: this is defined the same as the <code class="literal">P</code>
+        field, but it is used when the cursor position refers to an internally
+        generated command rather than the one submitted by the client.
+        The <code class="literal">q</code> field will always appear when this field appears.
+</p></dd><dt><span class="term">
+<code class="literal">q</code>
+</span></dt><dd><p>
+        Internal query: the text of a failed internally-generated command.
+        This could be, for example, a SQL query issued by a PL/pgSQL function.
+</p></dd><dt><span class="term">
+<code class="literal">W</code>
+</span></dt><dd><p>
+        Where: an indication of the context in which the error occurred.
+        Presently this includes a call stack traceback of active
+        procedural language functions and internally-generated queries.
+        The trace is one entry per line, most recent first.
+</p></dd><dt><span class="term">
+<code class="literal">s</code>
+</span></dt><dd><p>
+        Schema name: if the error was associated with a specific database
+        object, the name of the schema containing that object, if any.
+</p></dd><dt><span class="term">
+<code class="literal">t</code>
+</span></dt><dd><p>
+        Table name: if the error was associated with a specific table, the
+        name of the table.  (Refer to the schema name field for the name of
+        the table's schema.)
+</p></dd><dt><span class="term">
+<code class="literal">c</code>
+</span></dt><dd><p>
+        Column name: if the error was associated with a specific table column,
+        the name of the column.  (Refer to the schema and table name fields to
+        identify the table.)
+</p></dd><dt><span class="term">
+<code class="literal">d</code>
+</span></dt><dd><p>
+        Data type name: if the error was associated with a specific data type,
+        the name of the data type.  (Refer to the schema name field for the
+        name of the data type's schema.)
+</p></dd><dt><span class="term">
+<code class="literal">n</code>
+</span></dt><dd><p>
+        Constraint name: if the error was associated with a specific
+        constraint, the name of the constraint.  Refer to fields listed above
+        for the associated table or domain.  (For this purpose, indexes are
+        treated as constraints, even if they weren't created with constraint
+        syntax.)
+</p></dd><dt><span class="term">
+<code class="literal">F</code>
+</span></dt><dd><p>
+        File: the file name of the source-code location where the error
+        was reported.
+</p></dd><dt><span class="term">
+<code class="literal">L</code>
+</span></dt><dd><p>
+        Line: the line number of the source-code location where the error
+        was reported.
+</p></dd><dt><span class="term">
+<code class="literal">R</code>
+</span></dt><dd><p>
+        Routine: the name of the source-code routine reporting the error.
+</p></dd></dl></div><div class="note"><h3 class="title">Note</h3><p>
+  The fields for schema name, table name, column name, data type name, and
+  constraint name are supplied only for a limited number of error types;
+  see <a class="xref" href="errcodes-appendix.html" title="Appendix A. PostgreSQL Error Codes">Appendix A</a>.  Frontends should not assume that
+  the presence of any of these fields guarantees the presence of another
+  field.  Core error sources observe the interrelationships noted above, but
+  user-defined functions may use these fields in other ways.  In the same
+  vein, clients should not assume that these fields denote contemporary
+  objects in the current database.
+ </p></div><p>
+The client is responsible for formatting displayed information to meet its
+needs; in particular it should break long lines as needed.  Newline characters
+appearing in the error message fields should be treated as paragraph breaks,
+not line breaks.
+</p></div><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navfooter"><hr></hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="protocol-message-formats.html" title="52.7. Message Formats">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="protocol.html" title="Chapter 52. Frontend/Backend Protocol">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="protocol-logicalrep-message-formats.html" title="52.9. Logical Replication Message Formats">Next</a></td></tr><tr><td width="40%" align="left" valign="top">52.7. Message Formats </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 13.4 Documentation">Home</a></td><td width="40%" align="right" valign="top"> 52.9. Logical Replication Message Formats</td></tr></table></div></body></html>
+\ No newline at end of file
author	Daniel Baumann <daniel.baumann@progress-linux.org>	2024-05-04 12:19:15 +0000
committer	Daniel Baumann <daniel.baumann@progress-linux.org>	2024-05-04 12:19:15 +0000
commit	6eb9c5a5657d1fe77b55cc261450f3538d35a94d (patch)
tree	657d8194422a5daccecfd42d654b8a245ef7b4c8 /doc/src/sgml/html/protocol-error-fields.html
parent	Initial commit. (diff)
download	postgresql-13-upstream.tar.xz postgresql-13-upstream.zip