From 05fc744b967d15fa07c484ad87dd8cc943ad839f Mon Sep 17 00:00:00 2001
From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Mon, 24 Mar 2008 18:08:47 +0000
Subject: Add a new ereport auxiliary function errdetail_log(), which works the
 same as errdetail except the string goes only to the server log, replacing
 the normal errdetail there.  This provides a reasonably clean way of dealing
 with error details that are too security-sensitive or too bulky to send to
 the client.

This commit just adds the infrastructure --- actual uses to follow.
---
 doc/src/sgml/sources.sgml | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

(limited to 'doc/src')

diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml
index 65652dd3053..78d60bb5ae4 100644
--- a/doc/src/sgml/sources.sgml
+++ b/doc/src/sgml/sources.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.29 2007/11/07 13:12:21 petere Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/sources.sgml,v 2.30 2008/03/24 18:08:47 tgl Exp $ -->
 
  <chapter id="source">
   <title>PostgreSQL Coding Conventions</title>
@@ -158,6 +158,17 @@ ereport(ERROR,
      <function>errmsg</>.
     </para>
    </listitem>
+   <listitem>
+    <para>
+     <function>errdetail_log(const char *msg, ...)</function> is the same as
+     <function>errdetail</> except that this string goes only to the server
+     log, never to the client.  If both <function>errdetail</> and
+     <function>errdetail_log</> are used then one string goes to the client
+     and the other to the log.  This is useful for error details that are
+     too security-sensitive or too bulky to include in the report
+     sent to the client.
+    </para>
+   </listitem>
    <listitem>
     <para>
      <function>errhint(const char *msg, ...)</function> supplies an optional
-- 
cgit v1.2.3