head	1.10;
access;
symbols
	REL9_0_0:1.8.2.2
	REL9_1_ALPHA1:1.10
	REL9_0_RC1:1.8.2.2
	REL9_0_BETA4:1.8.2.1
	REL9_0_STABLE:1.8.0.2
	REL9_0_BETA3:1.8
	REL9_0_BETA2:1.8
	REL8_3_11:1.4
	REL8_4_4:1.4
	REL9_0_BETA1:1.4
	REL9_0_ALPHA5_BRANCH:1.4.0.14
	REL9_0_ALPHA5:1.4
	REL8_3_10:1.4
	REL8_4_3:1.4
	REL9_0_ALPHA4:1.4
	REL9_0_ALPHA4_BRANCH:1.4.0.12
	REL8_5_ALPHA3:1.4
	REL8_5_ALPHA3_BRANCH:1.4.0.10
	REL8_3_9:1.4
	REL8_4_2:1.4
	REL8_5_ALPHA2:1.4
	REL8_5_ALPHA2_BRANCH:1.4.0.8
	REL8_3_8:1.4
	REL8_4_1:1.4
	REL8_5_ALPHA1:1.4
	REL8_5_ALPHA1_BRANCH:1.4.0.6
	REL8_4_STABLE:1.4.0.4
	REL8_4_0:1.4
	REL8_4_RC2:1.4
	REL8_4_RC1:1.4
	REL8_4_BETA2:1.4
	REL8_4_BETA1:1.4
	REL8_3_7:1.4
	REL8_3_6:1.4
	REL8_3_5:1.4
	REL8_3_4:1.4
	REL8_3_3:1.4
	REL8_3_2:1.4
	REL8_3_1:1.4
	REL8_3_STABLE:1.4.0.2
	REL8_3_0:1.4
	REL8_3_RC2:1.4
	REL8_3_RC1:1.4
	REL8_3_BETA4:1.2
	REL8_3_BETA3:1.2;
locks; strict;
comment	@# @;


1.10
date	2010.08.17.04.37.20;	author petere;	state Exp;
branches;
next	1.9;

1.9
date	2010.07.29.19.34.40;	author petere;	state Exp;
branches;
next	1.8;

1.8
date	2010.05.25.15.55.28;	author momjian;	state Exp;
branches
	1.8.2.1;
next	1.7;

1.7
date	2010.05.20.03.45.38;	author momjian;	state Exp;
branches;
next	1.6;

1.6
date	2010.05.19.20.22.05;	author momjian;	state Exp;
branches;
next	1.5;

1.5
date	2010.05.19.20.20.38;	author momjian;	state Exp;
branches;
next	1.4;

1.4
date	2007.12.11.02.31.49;	author tgl;	state Exp;
branches;
next	1.3;

1.3
date	2007.12.10.05.32.51;	author tgl;	state Exp;
branches;
next	1.2;

1.2
date	2007.11.11.14.23.18;	author momjian;	state Exp;
branches;
next	1.1;

1.1
date	2007.11.10.23.30.46;	author momjian;	state Exp;
branches;
next	;

1.8.2.1
date	2010.07.29.19.34.36;	author petere;	state Exp;
branches;
next	1.8.2.2;

1.8.2.2
date	2010.08.17.04.37.17;	author petere;	state Exp;
branches;
next	;


desc
@@


1.10
log
@Spell and markup checking
@
text
@<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.9 2010/07/29 19:34:40 petere Exp $ -->

<sect1 id="oid2name">
 <title>oid2name</title>

 <indexterm zone="oid2name">
  <primary>oid2name</primary>
 </indexterm>

 <para>
  <application>oid2name</> is a utility program that helps administrators to
  examine the file structure used by PostgreSQL.  To make use of it, you need
  to be familiar with the database file structure, which is described in
  <xref linkend="storage">.
 </para>

 <note>
  <para>
   The name <quote>oid2name</> is historical, and is actually rather
   misleading, since most of the time when you use it, you will really
   be concerned with tables' filenode numbers (which are the file names
   visible in the database directories).  Be sure you understand the
   difference between table OIDs and table filenodes!
  </para>
 </note>

 <sect2>
  <title>Overview</title>

  <para>
   <application>oid2name</application> connects to a target database and
   extracts OID, filenode, and/or table name information.  You can also have
   it show database OIDs or tablespace OIDs.
  </para>

 </sect2>

 <sect2>
  <title><application>oid2name</> Options</title>

  <para>
   <application>oid2name</application> accepts the following command-line arguments:

   <variablelist>

    <varlistentry>
     <term><option>-o</option> <replaceable>oid</></term>
     <listitem><para>show info for table with OID <replaceable>oid</></para></listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-f</option> <replaceable>filenode</></term>
     <listitem><para>show info for table with filenode <replaceable>filenode</></para></listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-t</option> <replaceable>tablename_pattern</></term>
     <listitem><para>show info for table(s) matching <replaceable>tablename_pattern</></para></listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-s</option></term>
     <listitem><para>show tablespace OIDs</para></listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-S</option></term>
     <listitem><para>include system objects (those in
      <option>information_schema</option>, <option>pg_toast</option>
      and <option>pg_catalog</option> schemas)
     </para></listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-i</option></term>
     <listitem><para>include indexes and sequences in the listing</para></listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-x</option></term>
     <listitem><para>display more information about each object shown: tablespace name,
      schema name, and OID
     </para></listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-q</option></term>
     <listitem><para>omit headers (useful for scripting)</para></listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-d</option> <replaceable>database</></term>
     <listitem><para>database to connect to</para></listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-H</option> <replaceable>host</></term>
     <listitem><para>database server's host</para></listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-p</option> <replaceable>port</></term>
     <listitem><para>database server's port</para></listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-U</option> <replaceable>username</></term>
     <listitem><para>user name to connect as</para></listitem>
    </varlistentry>

    <varlistentry>
     <term><option>-P</option> <replaceable>password</></term>
     <listitem><para>password (deprecated &mdash; putting this on the command line
      is a security hazard)</para></listitem>
    </varlistentry>

   </variablelist>
  </para>

  <para>
   To display specific tables, select which tables to show by
   using <option>-o</>, <option>-f</> and/or <option>-t</>.
   <option>-o</> takes an OID,
   <option>-f</> takes a filenode,
   and <option>-t</> takes a table name (actually, it's a <literal>LIKE</>
   pattern, so you can use things like <literal>foo%</>).
   You can use as many
   of these options as you like, and the listing will include all objects
   matched by any of the options.  But note that these options can only
   show objects in the database given by <option>-d</>.
  </para>

  <para>
   If you don't give any of <option>-o</>, <option>-f</> or <option>-t</>,
   but do give <option>-d</>, it will list all tables in the database
   named by <option>-d</>.  In this mode, the <option>-S</> and
   <option>-i</> options control what gets listed.
  </para>

  <para>
   If you don't give <option>-d</> either, it will show a listing of database
   OIDs.  Alternatively you can give <option>-s</> to get a tablespace
   listing.
  </para>
 </sect2>

 <sect2>
  <title>Examples</title>

<screen>
$ # what's in this database server, anyway?
$ oid2name
All databases:
    Oid  Database Name  Tablespace
----------------------------------
  17228       alvherre  pg_default
  17255     regression  pg_default
  17227      template0  pg_default
      1      template1  pg_default

$ oid2name -s
All tablespaces:
     Oid  Tablespace Name
-------------------------
    1663       pg_default
    1664        pg_global
  155151         fastdisk
  155152          bigdisk

$ # OK, let's look into database alvherre
$ cd $PGDATA/base/17228

$ # get top 10 db objects in the default tablespace, ordered by size
$ ls -lS * | head -10
-rw-------  1 alvherre alvherre 136536064 sep 14 09:51 155173
-rw-------  1 alvherre alvherre  17965056 sep 14 09:51 1155291
-rw-------  1 alvherre alvherre   1204224 sep 14 09:51 16717
-rw-------  1 alvherre alvherre    581632 sep  6 17:51 1255
-rw-------  1 alvherre alvherre    237568 sep 14 09:50 16674
-rw-------  1 alvherre alvherre    212992 sep 14 09:51 1249
-rw-------  1 alvherre alvherre    204800 sep 14 09:51 16684
-rw-------  1 alvherre alvherre    196608 sep 14 09:50 16700
-rw-------  1 alvherre alvherre    163840 sep 14 09:50 16699
-rw-------  1 alvherre alvherre    122880 sep  6 17:51 16751

$ # I wonder what file 155173 is ...
$ oid2name -d alvherre -f 155173
From database "alvherre":
  Filenode  Table Name
----------------------
    155173    accounts

$ # you can ask for more than one object
$ oid2name -d alvherre -f 155173 -f 1155291
From database "alvherre":
  Filenode     Table Name
-------------------------
    155173       accounts
   1155291  accounts_pkey

$ # you can mix the options, and get more details with -x
$ oid2name -d alvherre -t accounts -f 1155291 -x
From database "alvherre":
  Filenode     Table Name      Oid  Schema  Tablespace
------------------------------------------------------
    155173       accounts   155173  public  pg_default
   1155291  accounts_pkey  1155291  public  pg_default

$ # show disk space for every db object
$ du [0-9]* |
> while read SIZE FILENODE
> do
>   echo "$SIZE       `oid2name -q -d alvherre -i -f $FILENODE`"
> done
16            1155287  branches_pkey
16            1155289  tellers_pkey
17561            1155291  accounts_pkey
...

$ # same, but sort by size
$ du [0-9]* | sort -rn | while read SIZE FN
> do
>   echo "$SIZE   `oid2name -q -d alvherre -f $FN`"
> done
133466             155173    accounts
17561            1155291  accounts_pkey
1177              16717  pg_proc_proname_args_nsp_index
...

$ # If you want to see what's in tablespaces, use the pg_tblspc directory
$ cd $PGDATA/pg_tblspc
$ oid2name -s
All tablespaces:
     Oid  Tablespace Name
-------------------------
    1663       pg_default
    1664        pg_global
  155151         fastdisk
  155152          bigdisk

$ # what databases have objects in tablespace "fastdisk"?
$ ls -d 155151/*
155151/17228/  155151/PG_VERSION

$ # Oh, what was database 17228 again?
$ oid2name
All databases:
    Oid  Database Name  Tablespace
----------------------------------
  17228       alvherre  pg_default
  17255     regression  pg_default
  17227      template0  pg_default
      1      template1  pg_default

$ # Let's see what objects does this database have in the tablespace.
$ cd 155151/17228
$ ls -l
total 0
-rw-------  1 postgres postgres 0 sep 13 23:20 155156

$ # OK, this is a pretty small table ... but which one is it?
$ oid2name -d alvherre -f 155156
From database "alvherre":
  Filenode  Table Name
----------------------
    155156         foo
</screen>
 </sect2>

 <sect2>
  <title>Limitations</title>

  <para>
   <application>oid2name</> requires a running database server with
   non-corrupt system catalogs.  It is therefore of only limited use
   for recovering from catastrophic database corruption situations.
  </para>
 </sect2>

 <sect2>
  <title>Author</title>

  <para>
   B. Palmer <email>bpalmer@@crimelabs.net</email>
  </para>
 </sect2>

</sect1>
@


1.9
log
@Fix indentation of verbatim block elements

Block elements with verbatim formatting (literallayout, programlisting,
screen, synopsis) should be aligned at column 0 independent of the surrounding
SGML, because whitespace is significant, and indenting them creates erratic
whitespace in the output.  The CSS stylesheets already take care of indenting
the output.

Assorted markup improvements to go along with it.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.8 2010/05/25 15:55:28 momjian Exp $ -->
d108 1
a108 1
     <listitem><para>username to connect as</para></listitem>
d125 2
a126 2
   and <option>-t</> takes a tablename (actually, it's a LIKE
   pattern, so you can use things like <option>foo%</>).
@


1.8
log
@Modify pg_standby, pgbench, and pg_upgrade manual pages to be consistent
in their display of command-line options with other client applications.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.7 2010/05/20 03:45:38 momjian Exp $ -->
d150 1
a150 1
  <programlisting>
d267 1
a267 1
  </programlisting>
@


1.8.2.1
log
@Fix indentation of verbatim block elements

Block elements with verbatim formatting (literallayout, programlisting,
screen, synopsis) should be aligned at column 0 independent of the surrounding
SGML, because whitespace is significant, and indenting them creates erratic
whitespace in the output.  The CSS stylesheets already take care of indenting
the output.

Assorted markup improvements to go along with it.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.8 2010/05/25 15:55:28 momjian Exp $ -->
d150 1
a150 1
<screen>
d267 1
a267 1
</screen>
@


1.8.2.2
log
@Spell and markup checking
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.8.2.1 2010/07/29 19:34:36 petere Exp $ -->
d108 1
a108 1
     <listitem><para>user name to connect as</para></listitem>
d125 2
a126 2
   and <option>-t</> takes a table name (actually, it's a <literal>LIKE</>
   pattern, so you can use things like <literal>foo%</>).
@


1.7
log
@Show oid2name command-line arguments in documentation like we do for
non-contrib command-line tools (no longer in a single table display).
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.6 2010/05/19 20:22:05 momjian Exp $ -->
d39 1
a39 1
  <title><application>oid2name</> options</title>
@


1.6
log
@Restore oid2name doc change.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.5 2010/05/19 20:20:38 momjian Exp $ -->
d33 1
a33 3
   it show database OIDs or tablespace OIDs.  The program is controlled by
   a large number of command-line options, as shown in
   <xref linkend="oid2name-options">.
d36 83
a118 84
  <table id="oid2name-options">
   <title><application>oid2name</> options</title>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>Option</entry>
      <entry>Description</entry>
     </row>
    </thead>

    <tbody>
     <row>
      <entry><literal>-o</literal> <replaceable>oid</></entry>
      <entry>show info for table with OID <replaceable>oid</></entry>
     </row>

     <row>
      <entry><literal>-f</literal> <replaceable>filenode</></entry>
      <entry>show info for table with filenode <replaceable>filenode</></entry>
     </row>

     <row>
      <entry><literal>-t</literal> <replaceable>tablename_pattern</></entry>
      <entry>show info for table(s) matching <replaceable>tablename_pattern</></entry>
     </row>

     <row>
      <entry><literal>-s</literal></entry>
      <entry>show tablespace OIDs</entry>
     </row>

     <row>
      <entry><literal>-S</literal></entry>
      <entry>include system objects (those in
       <literal>information_schema</literal>, <literal>pg_toast</literal>
       and <literal>pg_catalog</literal> schemas)
      </entry>
     </row>

     <row>
      <entry><literal>-i</literal></entry>
      <entry>include indexes and sequences in the listing</entry>
     </row>

     <row>
      <entry><literal>-x</literal></entry>
      <entry>display more information about each object shown: tablespace name,
       schema name, and OID
      </entry>
     </row>

     <row>
      <entry><literal>-q</literal></entry>
      <entry>omit headers (useful for scripting)</entry>
     </row>

     <row>
      <entry><literal>-d</literal> <replaceable>database</></entry>
      <entry>database to connect to</entry>
     </row>

     <row>
      <entry><literal>-H</literal> <replaceable>host</></entry>
      <entry>database server's host</entry>
     </row>

     <row>
      <entry><literal>-p</literal> <replaceable>port</></entry>
      <entry>database server's port</entry>
     </row>

     <row>
      <entry><literal>-U</literal> <replaceable>username</></entry>
      <entry>username to connect as</entry>
     </row>

     <row>
      <entry><literal>-P</literal> <replaceable>password</></entry>
      <entry>password (deprecated &mdash; putting this on the command line
       is a security hazard)</entry>
     </row>
    </tbody>
   </tgroup>
  </table>
d122 5
a126 5
   using <literal>-o</>, <literal>-f</> and/or <literal>-t</>.
   <literal>-o</> takes an OID,
   <literal>-f</> takes a filenode,
   and <literal>-t</> takes a tablename (actually, it's a LIKE
   pattern, so you can use things like <literal>foo%</>).
d130 1
a130 1
   show objects in the database given by <literal>-d</>.
d134 4
a137 4
   If you don't give any of <literal>-o</>, <literal>-f</> or <literal>-t</>,
   but do give <literal>-d</>, it will list all tables in the database
   named by <literal>-d</>.  In this mode, the <literal>-S</> and
   <literal>-i</> options control what gets listed.
d141 2
a142 2
   If you don't give <literal>-d</> either, it will show a listing of database
   OIDs.  Alternatively you can give <literal>-s</> to get a tablespace
@


1.5
log
@Add command-line documentation for pg_upgrade.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.4 2007/12/11 02:31:49 tgl Exp $ -->
d113 6
@


1.4
log
@Remove the -P options of oid2name and pgbench, as they are security
hazards.  Instead teach these programs to prompt for a password when
necessary, just like all our other programs.
I did not bother to invent -W switches for them, since the return on
investment seems so low.
@
text
@d1 1
a1 1
<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.3 2007/12/10 05:32:51 tgl Exp $ -->
d34 2
a35 2
   a large number of command-line switches, as shown in
   <xref linkend="oid2name-switches">.
d38 2
a39 2
  <table id="oid2name-switches">
   <title><application>oid2name</> switches</title>
d43 1
a43 1
      <entry>Switch</entry>
d125 2
a126 2
   of these switches as you like, and the listing will include all objects
   matched by any of the switches.  But note that these switches can only
d134 1
a134 1
   <literal>-i</> switches control what gets listed.
@


1.3
log
@Make an editorial pass over the newly SGML-ified contrib documentation.
Fix lots of bad markup, bad English, bad explanations.

Second round of commits.  pgcrypto and pgstandby still to go...
@
text
@d1 1
a1 1
<!-- $PostgreSQL$ -->
a112 6

     <row>
      <entry><literal>-P</literal> <replaceable>password</></entry>
      <entry>password (deprecated &mdash; putting this on the command line
       is a security hazard)</entry>
     </row>
@


1.2
log
@Remove tabs from SGML files.
@
text
@d1 2
d5 1
a5 1
 
d11 4
a14 3
  This utility allows administrators to examine the file structure used by
  PostgreSQL.  To make use of it, you need to be familiar with the file
  structure, which is described in <xref linkend="storage">.
d16 11
a26 1
 
d29 1
d31 5
a35 3
   <literal>oid2name</literal> connects to the database and extracts OID, 
   filenode, and table name information.  You can also have it show database 
   OIDs and tablespace OIDs.
d37 3
a39 16
  <para>
   When displaying specific tables, you can select which tables to show by
   using -o, -f and -t.  The first switch takes an OID, the second takes
   a filenode, and the third takes a tablename (actually, it's a LIKE
   pattern, so you can use things like "foo%").  Note that you can use as many
   of these switches as you like, and the listing will include all objects
   matched by any of the switches.  Also note that these switches can only
   show objects in the database given in -d.
  </para>
  <para>
   If you don't give any of -o, -f or -t it will dump all the tables in the
   database given in -d.  If you don't give -d, it will show a database
   listing.  Alternatively you can give -s to get a tablespace listing.
  </para>
  <table>
   <title>Additional switches</title>
d41 7
d50 28
d79 1
a79 1
      <entry>include indexes and sequences in the database listing.</entry>
d81 1
d84 2
a85 2
      <entry>display more information about each object shown: tablespace name, 
       schema name, OID.
d88 21
d110 2
a111 4
      <entry><literal>-S</literal></entry>
      <entry>also show system objects (those in information_schema, pg_toast 
       and pg_catalog schemas)
      </entry>
d113 1
d115 3
a117 2
      <entry><literal>-q</literal></entry>
      <entry>don't display headers(useful for scripting)</entry>
d122 26
d149 1
a149 1
 
d152 1
a152 1
 
d154 1
d173 2
a174 1
$ cd $PGDATA/17228
d189 1
d204 1
a204 1
$ # you can also mix the options, and have more details
d249 1
a249 1
$ oid2name   
d270 2
d273 2
a274 2
$ # end of sample session.
  </programlisting>
d277 3
a279 8
   You can also get approximate size data for each object using psql.  For
   example, 
  </para>
  <programlisting>
   SELECT relpages, relfilenode, relname FROM pg_class ORDER BY relpages DESC;
  </programlisting>
  <para>
   Each page is typically 8k.  Relpages is updated by VACUUM.
d282 1
a282 1
 
d285 1
d287 1
a287 1
   b. palmer, <email>bpalmer@@crimelabs.net</email>
a291 1

@


1.1
log
@Move most /contrib README files into SGML.  Some still need conversion
or will never be converted.
@
text
@d129 3
a131 3
16 	   1155287  branches_pkey
16 	   1155289  tellers_pkey
17561 	   1155291  accounts_pkey
d139 3
a141 3
133466 	    155173    accounts
17561 	   1155291  accounts_pkey
1177 	     16717  pg_proc_proname_args_nsp_index
@

