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

doc: Document pg_encoding_to_char() and pg_char_to_encoding().

Browse Source 
Previously both functions were not described anywhere in the docs.
But since they have been around since 7.0 and mentioned in the description
for system catalog like pg_database, it's reasonable to add short
descriptions for them.

Author: Ian Lawrence Barwick
Reviewed-by: Laurenz Albe, Fujii Masao
Discussion: https://postgr.es/m/CAB8KJ=infievn4q1N4X7Vx8w4_RMPPG0pLvxhSDjy5WQOSHW9g@mail.gmail.com
This commit is contained in:
Fujii Masao 2021-10-05 12:52:51 +09:00
parent 826584fa52
commit f6b5d05ba9
2 changed files with 35 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/src/sgml/catalogs.sgml
View File

@ -2819,7 +2819,8 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
<structfield>conforencoding</structfield> <type>int4</type>
</para>
<para>
Source encoding ID
Source encoding ID (<link linkend="pg-encoding-to-char"><function>pg_encoding_to_char()</function></link>
can translate this number to the encoding name)
</para></entry>
</row>
@ -2828,7 +2829,8 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
<structfield>contoencoding</structfield> <type>int4</type>
</para>
<para>
Destination encoding ID
Destination encoding ID (<link linkend="pg-encoding-to-char"><function>pg_encoding_to_char()</function></link>
can translate this number to the encoding name)
</para></entry>
</row>
@ -2927,7 +2929,7 @@ SCRAM-SHA-256$<replaceable>&lt;iteration count&gt;</replaceable>:<replaceable>&l
</para>
<para>
Character encoding for this database
(<function>pg_encoding_to_char()</function> can translate
(<link linkend="pg-encoding-to-char"><function>pg_encoding_to_char()</function></link> can translate
this number to the encoding name)
</para></entry>
</row>

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

@ -23328,6 +23328,36 @@ SELECT pg_type_is_visible('myschema.widget'::regtype);
</para></entry>
</row>
<row>
<entry id="pg-char-to-encoding" role="func_table_entry"><para role="func_signature">
<indexterm>
<primary>pg_char_to_encoding</primary>
</indexterm>
<function>pg_char_to_encoding</function> ( <parameter>encoding</parameter> <type>name</type> )
<returnvalue>integer</returnvalue>
</para>
<para>
Converts the supplied encoding name into an integer representing the
internal identifier used in some system catalog tables.
Returns <literal>-1</literal> if an unknown encoding name is provided.
</para></entry>
</row>
<row>
<entry id="pg-encoding-to-char" role="func_table_entry"><para role="func_signature">
<indexterm>
<primary>pg_encoding_to_char</primary>
</indexterm>
<function>pg_encoding_to_char</function> ( <parameter>encoding</parameter> <type>integer</type> )
<returnvalue>name</returnvalue>
</para>
<para>
Converts the integer used as the internal identifier of an encoding in some
system catalog tables into a human-readable string.
Returns an empty string if an invalid encoding number is provided.
</para></entry>
</row>
<row>
<entry role="func_table_entry"><para role="func_signature">
<indexterm>