8000 Doc: clean up contrib/pageinspect's GIST function documentation. · postgres/postgres@7e57255 · GitHub
[go: up one dir, main page]
Skip to content

Commit 7e57255

Browse files
tglsfdctglsfdc
committed
Doc: clean up contrib/pageinspect's GIST function documentation.
I came to fix the overwidth-PDF-page warnings seen in the buildfarm, but stayed long enough to copy-edit some nearby text.
1 parent 39b66a9 commit 7e57255

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

‎doc/src/sgml/pageinspect.sgml

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -685,9 +685,9 @@ test=# SELECT first_tid, nbytes, tids[0:5] AS some_tids
685685

686686
<listitem>
687687
<para>
688-
<function>gist_page_opaque_info</function> returns information about
689-
a <acronym>GiST</acronym> index opaque area, like the NSN, rightlink and
690-
page type.
688+
<function>gist_page_opaque_info</function> returns information from
689+
a <acronym>GiST</acronym> index page's opaque area, such as the NSN,
690+
rightlink and page type.
691691
For example:
692692
<screen>
693693
test=# SELECT * FROM gist_page_opaque_info(get_raw_page('test_gist_idx', 2));
@@ -702,7 +702,7 @@ test=# SELECT * FROM gist_page_opaque_info(get_raw_page('test_gist_idx', 2));
702702

703703
<varlistentry>
704704
<term>
705-
<function>gist_page_items(page bytea, index oid) returns setof record</function>
705+
<function>gist_page_items(page bytea, index_oid regclass) returns setof record</function>
706706
<indexterm>
707707
<primary>gist_page_items</primary>
708708
</indexterm>
@@ -711,7 +711,7 @@ test=# SELECT * FROM gist_page_opaque_info(get_raw_page('test_gist_idx', 2));
711711
<listitem>
712712
<para>
713713
<function>gist_page_items</function> returns information about
714-
the data stored in a page of <acronym>GiST</acronym> index. For example:
714+
the data stored in a page of a <acronym>GiST</acronym> index. For example:
715715
<screen>
716716
test=# SELECT * FROM gist_page_items(get_raw_page('test_gist_idx', 0), 'test_gist_idx');
717717
itemoffset | ctid | itemlen | keys
@@ -739,19 +739,21 @@ test=# SELECT * FROM gist_page_items(get_raw_page('test_gist_idx', 0), 'test_gis
739739

740740
<listitem>
741741
<para>
742-
Same as <function>gist_page_items</function>, but returns the key data as a raw
743-
bytea blob. For example:
742+
Same as <function>gist_page_items</function>, but returns the key data
743+
as a raw <type>bytea</type> blob. Since it does not attempt to decode
744+
the key, it does not need to know which index is involved. For
745+
example:
744746
<screen>
745747
test=# SELECT * FROM gist_page_items_bytea(get_raw_page('test_gist_idx', 0));
746748
itemoffset | ctid | itemlen | key_data
747-
------------+-----------+---------+------------------------------------------------------------------------------------
748-
1 | (1,65535) | 40 | \x00000100ffff28000000000000c064400000000000c06440000000000000f03f000000000000f03f
749-
2 | (2,65535) | 40 | \x00000200ffff28000000000000c074400000000000c074400000000000e064400000000000e06440
750-
3 | (3,65535) | 40 | \x00000300ffff28000000000000207f400000000000207f400000000000d074400000000000d07440
751-
4 | (4,65535) | 40 | \x00000400ffff28000000000000c084400000000000c084400000000000307f400000000000307f40
752-
5 | (5,65535) | 40 | \x00000500ffff28000000000000f089400000000000f089400000000000c884400000000000c88440
753-
6 | (6,65535) | 40 | \x00000600ffff28000000000000208f400000000000208f400000000000f889400000000000f88940
754-
7 | (7,65535) | 40 | \x00000700ffff28000000000000408f400000000000408f400000000000288f400000000000288f40
749+
------------+-----------+---------+-------------------------------------------&zwsp;-----------------------------------------
750+
1 | (1,65535) | 40 | \x00000100ffff28000000000000c0644000000000&zwsp;00c06440000000000000f03f000000000000f03f
751+
2 | (2,65535) | 40 | \x00000200ffff28000000000000c0744000000000&zwsp;00c074400000000000e064400000000000e06440
752+
3 | (3,65535) | 40 | \x00000300ffff28000000000000207f4000000000&zwsp;00207f400000000000d074400000000000d07440
753+
4 | (4,65535) | 40 | \x00000400ffff28000000000000c0844000000000&zwsp;00c084400000000000307f400000000000307f40
754+
5 | (5,65535) | 40 | \x00000500ffff28000000000000f0894000000000&zwsp;00f089400000000000c884400000000000c88440
755+
6 | (6,65535) | 40 | \x00000600ffff28000000000000208f4000000000&zwsp;00208f400000000000f889400000000000f88940
756+
7 | (7,65535) | 40 | \x00000700ffff28000000000000408f4000000000&zwsp;00408f400000000000288f400000000000288f40
755757
(7 rows)
756758
</screen>
757759
</para>

0 commit comments

Comments
 (0)
0