From 290f1603b4208ca6a13776f744b586a958e98d74 Mon Sep 17 00:00:00 2001 From: Robert Haas Date: Wed, 15 Dec 2010 21:02:31 -0500 Subject: Some copy editing of pg_read_binary_file() patch. --- doc/src/sgml/func.sgml | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'doc') diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 7c1ba9d07f2..1485ac05511 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -14489,19 +14489,21 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup()); at the given offset, returning at most length bytes (less if the end of file is reached first). If offset is negative, it is relative to the end of the file. - When offset and length parameters are omitted, - it returns the whole of the file. - The part of a file must be a valid text in the server encoding. + If offset and length are omitted, the entire + file is returned. The bytes read from the file are interpreted as a string + in the server encoding; an error is thrown if they are not valid in that + encoding. pg_read_binary_file - pg_read_binary_file returns part of a file as like as - pg_read_file, but the result is a bytea value. - One of the usages is to read a file in the specified encoding combined with - convert_from function: + pg_read_binary_file is similar to + pg_read_file, except that the result is a bytea value; + accordingly, no encoding checks are performed. + In combination with the convert_from function, this function + can be used to read a file in a specified encoding: SELECT convert_from(pg_read_binary_file('file_in_utf8.txt'), 'UTF8'); -- cgit v1.2.3