I386LINUX/util/I386LINUX/doc/postgresql/html/protocol-error-fields.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <HTML
   3 ><HEAD
   4 ><TITLE
   5 >Error and Notice Message Fields</TITLE
   6 ><META
   7 NAME="GENERATOR"
   8 CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
   9 REV="MADE"
  10 HREF="mailto:pgsql-docs@postgresql.org"><LINK
  11 REL="HOME"
  12 TITLE="PostgreSQL 7.4.1 Documentation"
  13 HREF="index.html"><LINK
  14 REL="UP"
  15 TITLE="Frontend/Backend Protocol"
  16 HREF="protocol.html"><LINK
  17 REL="PREVIOUS"
  18 TITLE="Message Formats"
  19 HREF="protocol-message-formats.html"><LINK
  20 REL="NEXT"
  21 TITLE="Summary of Changes since Protocol 2.0"
  22 HREF="protocol-changes.html"><LINK
  23 REL="STYLESHEET"
  24 TYPE="text/css"
  25 HREF="stylesheet.css"><META
  26 NAME="creation"
  27 CONTENT="2003-12-22T03:48:47"></HEAD
  28 ><BODY
  29 CLASS="SECT1"
  30 ><DIV
  31 CLASS="NAVHEADER"
  32 ><TABLE
  33 SUMMARY="Header navigation table"
  34 WIDTH="100%"
  35 BORDER="0"
  36 CELLPADDING="0"
  37 CELLSPACING="0"
  38 ><TR
  39 ><TH
  40 COLSPAN="5"
  41 ALIGN="center"
  42 VALIGN="bottom"
  43 >PostgreSQL 7.4.1 Documentation</TH
  44 ></TR
  45 ><TR
  46 ><TD
  47 WIDTH="10%"
  48 ALIGN="left"
  49 VALIGN="top"
  50 ><A
  51 HREF="protocol-message-formats.html"
  52 ACCESSKEY="P"
  53 >Prev</A
  54 ></TD
  55 ><TD
  56 WIDTH="10%"
  57 ALIGN="left"
  58 VALIGN="top"
  59 ><A
  60 HREF="protocol.html"
  61 >Fast Backward</A
  62 ></TD
  63 ><TD
  64 WIDTH="60%"
  65 ALIGN="center"
  66 VALIGN="bottom"
  67 >Chapter 44. Frontend/Backend Protocol</TD
  68 ><TD
  69 WIDTH="10%"
  70 ALIGN="right"
  71 VALIGN="top"
  72 ><A
  73 HREF="protocol.html"
  74 >Fast Forward</A
  75 ></TD
  76 ><TD
  77 WIDTH="10%"
  78 ALIGN="right"
  79 VALIGN="top"
  80 ><A
  81 HREF="protocol-changes.html"
  82 ACCESSKEY="N"
  83 >Next</A
  84 ></TD
  85 ></TR
  86 ></TABLE
  87 ><HR
  88 ALIGN="LEFT"
  89 WIDTH="100%"></DIV
  90 ><DIV
  91 CLASS="SECT1"
  92 ><H1
  93 CLASS="SECT1"
  94 ><A
  95 NAME="PROTOCOL-ERROR-FIELDS"
  96 >44.5. Error and Notice Message Fields</A
  97 ></H1
  98 ><P
  99 >This section describes the fields that may appear in ErrorResponse and
 100 NoticeResponse messages.  Each field type has a single-byte identification
 101 token.  Note that any given field type should appear at most once per
 102 message.</P
 103 ><P
 104 ></P
 105 ><DIV
 106 CLASS="VARIABLELIST"
 107 ><DL
 108 ><DT
 109 ><TT
 110 CLASS="LITERAL"
 111 >S</TT
 112 ></DT
 113 ><DD
 114 ><P
 115 >        Severity: the field contents are
 116         <TT
 117 CLASS="LITERAL"
 118 >ERROR</TT
 119 >, <TT
 120 CLASS="LITERAL"
 121 >FATAL</TT
 122 >, or
 123         <TT
 124 CLASS="LITERAL"
 125 >PANIC</TT
 126 > (in an error message), or
 127         <TT
 128 CLASS="LITERAL"
 129 >WARNING</TT
 130 >, <TT
 131 CLASS="LITERAL"
 132 >NOTICE</TT
 133 >, <TT
 134 CLASS="LITERAL"
 135 >DEBUG</TT
 136 >,
 137         <TT
 138 CLASS="LITERAL"
 139 >INFO</TT
 140 >, or <TT
 141 CLASS="LITERAL"
 142 >LOG</TT
 143 > (in a notice message),
 144         or a localized translation of one of these.  Always present.</P
 145 ></DD
 146 ><DT
 147 ><TT
 148 CLASS="LITERAL"
 149 >C</TT
 150 ></DT
 151 ><DD
 152 ><P
 153 >        Code: the SQLSTATE code for the error (see <A
 154 HREF="errcodes-appendix.html"
 155 >Appendix A</A
 156 >).  Not localizable.  Always present.</P
 157 ></DD
 158 ><DT
 159 ><TT
 160 CLASS="LITERAL"
 161 >M</TT
 162 ></DT
 163 ><DD
 164 ><P
 165 >        Message: the primary human-readable error message.
 166         This should be accurate but terse (typically one line).
 167         Always present.</P
 168 ></DD
 169 ><DT
 170 ><TT
 171 CLASS="LITERAL"
 172 >D</TT
 173 ></DT
 174 ><DD
 175 ><P
 176 >        Detail: an optional secondary error message carrying more
 177         detail about the problem.  May run to multiple lines.</P
 178 ></DD
 179 ><DT
 180 ><TT
 181 CLASS="LITERAL"
 182 >H</TT
 183 ></DT
 184 ><DD
 185 ><P
 186 >        Hint: an optional suggestion what to do about the problem.
 187         This is intended to differ from Detail in that it offers advice
 188         (potentially inappropriate) rather than hard facts.
 189         May run to multiple lines.</P
 190 ></DD
 191 ><DT
 192 ><TT
 193 CLASS="LITERAL"
 194 >P</TT
 195 ></DT
 196 ><DD
 197 ><P
 198 >        Position: the field value is a decimal ASCII integer, indicating
 199         an error cursor position as an index into the original query string.
 200         The first character has index 1, and positions are measured in
 201         characters not bytes.</P
 202 ></DD
 203 ><DT
 204 ><TT
 205 CLASS="LITERAL"
 206 >W</TT
 207 ></DT
 208 ><DD
 209 ><P
 210 >        Where: an indication of the context in which the error occurred.
 211         Presently this includes a call stack traceback of active PL functions.
 212         The trace is one entry per line, most recent first.</P
 213 ></DD
 214 ><DT
 215 ><TT
 216 CLASS="LITERAL"
 217 >F</TT
 218 ></DT
 219 ><DD
 220 ><P
 221 >        File: the file name of the source-code location where the error
 222         was reported.</P
 223 ></DD
 224 ><DT
 225 ><TT
 226 CLASS="LITERAL"
 227 >L</TT
 228 ></DT
 229 ><DD
 230 ><P
 231 >        Line: the line number of the source-code location where the error
 232         was reported.</P
 233 ></DD
 234 ><DT
 235 ><TT
 236 CLASS="LITERAL"
 237 >R</TT
 238 ></DT
 239 ><DD
 240 ><P
 241 >        Routine: the name of the source-code routine reporting the error.</P
 242 ></DD
 243 ></DL
 244 ></DIV
 245 ><P
 246 >The client is responsible for formatting displayed information to meet its
 247 needs; in particular it should break long lines as needed.  Newline characters
 248 appearing in the error message fields should be treated as paragraph breaks,
 249 not line breaks.</P
 250 ></DIV
 251 ><DIV
 252 CLASS="NAVFOOTER"
 253 ><HR
 254 ALIGN="LEFT"
 255 WIDTH="100%"><TABLE
 256 SUMMARY="Footer navigation table"
 257 WIDTH="100%"
 258 BORDER="0"
 259 CELLPADDING="0"
 260 CELLSPACING="0"
 261 ><TR
 262 ><TD
 263 WIDTH="33%"
 264 ALIGN="left"
 265 VALIGN="top"
 266 ><A
 267 HREF="protocol-message-formats.html"
 268 ACCESSKEY="P"
 269 >Prev</A
 270 ></TD
 271 ><TD
 272 WIDTH="34%"
 273 ALIGN="center"
 274 VALIGN="top"
 275 ><A
 276 HREF="index.html"
 277 ACCESSKEY="H"
 278 >Home</A
 279 ></TD
 280 ><TD
 281 WIDTH="33%"
 282 ALIGN="right"
 283 VALIGN="top"
 284 ><A
 285 HREF="protocol-changes.html"
 286 ACCESSKEY="N"
 287 >Next</A
 288 ></TD
 289 ></TR
 290 ><TR
 291 ><TD
 292 WIDTH="33%"
 293 ALIGN="left"
 294 VALIGN="top"
 295 >Message Formats</TD
 296 ><TD
 297 WIDTH="34%"
 298 ALIGN="center"
 299 VALIGN="top"
 300 ><A
 301 HREF="protocol.html"
 302 ACCESSKEY="U"
 303 >Up</A
 304 ></TD
 305 ><TD
 306 WIDTH="33%"
 307 ALIGN="right"
 308 VALIGN="top"
 309 >Summary of Changes since Protocol 2.0</TD
 310 ></TR
 311 ></TABLE
 312 ></DIV
 313 ></BODY
 314 ></HTML
 315 >