~ubuntu-branches/ubuntu/trusty/postgresql-8.4/trusty

« back to all changes in this revision

Viewing changes to doc/src/sgml/pageinspect.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2009-07-11 16:59:35 UTC
  • mfrom: (5.1.1 karmic)
  • Revision ID: james.westby@ubuntu.com-20090711165935-jfwin6gfrxf0gfsi
Tags: 8.4.0-2
* debian/libpq-dev.install: Ship catalog/genbki.h. (Closes: #536139)
* debian/rules: Drop --enable-cassert for final release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<!-- $PostgreSQL: pgsql/doc/src/sgml/pageinspect.sgml,v 1.5 2008/10/06 14:13:17 heikki Exp $ -->
 
1
<!-- $PostgreSQL: pgsql/doc/src/sgml/pageinspect.sgml,v 1.6 2009/06/08 16:22:44 tgl Exp $ -->
2
2
 
3
3
<sect1 id="pageinspect">
4
4
 <title>pageinspect</title>
27
27
      <function>get_raw_page</function> reads the specified block of the named
28
28
      table and returns a copy as a <type>bytea</> value.  This allows a
29
29
      single time-consistent copy of the block to be obtained.
30
 
      <literal>fork</literal> should be <literal>'main'</literal> for the main
31
 
      data fork, or <literal>'fsm'</literal> for the FSM.
 
30
      <replaceable>fork</replaceable> should be <literal>'main'</literal> for
 
31
      the main data fork, or <literal>'fsm'</literal> for the free space map,
 
32
      or <literal>'vm'</literal> for the visibility map.
32
33
     </para>
33
34
    </listitem>
34
35
   </varlistentry>
40
41
 
41
42
    <listitem>
42
43
     <para>
43
 
      A shorthand of above, for reading from the main fork. Equal to
44
 
      <literal>get_raw_page(relname, 0, blkno)</literal>
 
44
      A shorthand version of <function>get_raw_page</function>, for reading
 
45
      from the main fork.  Equivalent to
 
46
      <literal>get_raw_page(relname, 'main', blkno)</literal>
45
47
     </para>
46
48
    </listitem>
47
49
   </varlistentry>