mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Some copy editing of pg_read_binary_file() patch.

Browse Source
This commit is contained in:
Robert Haas 2010-12-15 21:02:31 -05:00
parent afc8f47b58
commit 290f1603b4
2 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/src/sgml/func.sgml
View File

@ -14489,19 +14489,21 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
at the given <parameter>offset</>, returning at most <parameter>length</>
bytes (less if the end of file is reached first). If <parameter>offset</>
is negative, it is relative to the end of the file.
When <parameter>offset</> and <parameter>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 <parameter>offset</> and <parameter>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.
</para>
<indexterm>
<primary>pg_read_binary_file</primary>
</indexterm>
<para>
<function>pg_read_binary_file</> returns part of a file as like as
<function>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
<function>convert_from</> function:
<function>pg_read_binary_file</> is similar to
<function>pg_read_file</>, except that the result is a bytea value;
accordingly, no encoding checks are performed.
In combination with the <function>convert_from</> function, this function
can be used to read a file in a specified encoding:
<programlisting>
SELECT convert_from(pg_read_binary_file('file_in_utf8.txt'), 'UTF8');
</programlisting>

4
src/backend/utils/adt/genfile.c
View File

@ -152,7 +152,7 @@ read_binary_file(text *filename_t, int64 seek_offset, int64 bytes_to_read)
}
/*
* In addition to read_binary_file, verify whether the contents are encoded
* Similar to read_binary_file, but we verify that the contents are valid
* in the database encoding.
*/
static text *
@ -163,7 +163,7 @@ read_text_file(text *filename, int64 seek_offset, int64 bytes_to_read)
/* Make sure the input is valid */
pg_verifymbstr(VARDATA(buf), VARSIZE(buf) - VARHDRSZ, false);
/* OK, we can cast it as text safely */
/* OK, we can cast it to text safely */
return (text *) buf;
}