Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit cfcdc99

Browse files
committed
Improve description of inquiry functions that accept regclass.
Per a suggestion from Thom Brown, though this is not his proposed patch.
1 parent f8c0af8 commit cfcdc99

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

doc/src/sgml/func.sgml

+20-10
Original file line numberDiff line numberDiff line change
@@ -14341,8 +14341,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
1434114341
</entry>
1434214342
<entry><type>bigint</type></entry>
1434314343
<entry>
14344-
Total disk space used by indexes attached to the table with the
14345-
specified OID or name
14344+
Total disk space used by indexes attached to the specified table
1434614345
</entry>
1434714346
</row>
1434814347
<row>
@@ -14353,7 +14352,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
1435314352
<entry>
1435414353
Disk space used by the specified fork (<literal>'main'</literal>,
1435514354
<literal>'fsm'</literal> or <literal>'vm'</>)
14356-
of the table or index with the specified OID or name
14355+
of the specified table or index
1435714356
</entry>
1435814357
</row>
1435914358
<row>
@@ -14378,9 +14377,8 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
1437814377
</entry>
1437914378
<entry><type>bigint</type></entry>
1438014379
<entry>
14381-
Disk space used by the table with the specified OID or name,
14382-
excluding indexes (but including TOAST, free space map, and visibility
14383-
map)
14380+
Disk space used by the specified table, excluding indexes
14381+
(but including TOAST, free space map, and visibility map)
1438414382
</entry>
1438514383
</row>
1438614384
<row>
@@ -14403,7 +14401,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
1440314401
</entry>
1440414402
<entry><type>bigint</type></entry>
1440514403
<entry>
14406-
Total disk space used by the table with the specified OID or name,
14404+
Total disk space used by the specified table,
1440714405
including all indexes and <acronym>TOAST</> data
1440814406
</entry>
1440914407
</row>
@@ -14463,6 +14461,18 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
1446314461
appropriate.
1446414462
</para>
1446514463

14464+
<para>
14465+
The functions above that operate on tables or indexes accept a
14466+
<type>regclass</> argument, which is simply the OID of the table or index
14467+
in the <structname>pg_class</> system catalog. You do not have to look up
14468+
the OID by hand, however, since the <type>regclass</> data type's input
14469+
converter will do the work for you. Just write the table name enclosed in
14470+
single quotes so that it looks like a literal constant. For compatibility
14471+
with the handling of ordinary <acronym>SQL</acronym> names, the string
14472+
will be converted to lower case unless it contains double quotes around
14473+
the table name.
14474+
</para>
14475+
1446614476
<para>
1446714477
The functions shown in <xref linkend="functions-admin-dblocation"> assist
1446814478
in identifying the specific disk files associated with database objects.
@@ -14490,7 +14500,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
1449014500
</entry>
1449114501
<entry><type>oid</type></entry>
1449214502
<entry>
14493-
Filenode number of the relation with the specified OID or name
14503+
Filenode number of the specified relation
1449414504
</entry>
1449514505
</row>
1449614506
<row>
@@ -14499,7 +14509,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
1449914509
</entry>
1450014510
<entry><type>text</type></entry>
1450114511
<entry>
14502-
File path name of the relation with the specified OID or name
14512+
File path name of the specified relation
1450314513
</entry>
1450414514
</row>
1450514515
</tbody>
@@ -14610,7 +14620,7 @@ postgres=# SELECT * FROM pg_xlogfile_name_offset(pg_stop_backup());
1461014620
can be used to read a file in a specified encoding:
1461114621
<programlisting>
1461214622
SELECT convert_from(pg_read_binary_file('file_in_utf8.txt'), 'UTF8');
14613-
</programlisting>
14623+
</programlisting>
1461414624
</para>
1461514625

1461614626
<indexterm>

0 commit comments

Comments
 (0)