From: Bruce Momjian <bruce@momjian.us>
Date: Sun, 17 Aug 2003 04:33:02 +0000 (+0000)
Subject: The attached patch adds some clarification to the documentation of the
X-Git-Tag: REL7_4_BETA2~54
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f7d9aa8fbf443b95a27738215802e6d2dcbc4f41;p=postgresql

The attached patch adds some clarification to the documentation of the
binary format read/created by COPY BINARY. It also mentions the
contrib/binarycopy module.

Lee Kindness.
---

diff --git a/doc/src/sgml/ref/copy.sgml b/doc/src/sgml/ref/copy.sgml
index 0e24f8b3ee..c53a5f9251 100644
--- a/doc/src/sgml/ref/copy.sgml
+++ b/doc/src/sgml/ref/copy.sgml
@@ -1,5 +1,5 @@
 <!--
-$Header: /cvsroot/pgsql/doc/src/sgml/ref/copy.sgml,v 1.46 2003/05/09 21:19:48 tgl Exp $
+$Header: /cvsroot/pgsql/doc/src/sgml/ref/copy.sgml,v 1.47 2003/08/17 04:33:02 momjian Exp $
 PostgreSQL documentation
 -->
 
@@ -380,7 +380,7 @@ COPY <replaceable class="parameter">table</replaceable> [ ( <replaceable class="
     The file format used for <command>COPY BINARY</command> changed in
     <application>PostgreSQL</application> 7.4. The new format consists
     of a file header, zero or more tuples containing the row data, and
-    a file trailer.
+    a file trailer. Headers and data are now in network byte order.
    </para>
 
    <refsect3>
@@ -483,6 +483,15 @@ future extension may add a header field that allows per-column format codes
 to be specified.
     </para>
 
+    <para>
+To determine the appropriate binary format for the actual tuple data you
+should consult the <application>PostgreSQL</application> source, in
+particular the <function>*send</> and <function>*recv</> functions for
+the data type (typically found in the <filename>src/backend/utils/adt</filename>
+directory). The <application>contrib/binarycopy</application> module
+can also be used to create an appropriate format file.
+    </para>
+
     <para>
 If OIDs are included in the file, the OID field immediately follows the
 field-count word.  It is a normal field except that it's not included