head	1.12;
access;
symbols
	REL7_4_29:1.9
	REL8_0_25:1.11
	REL8_1_21:1.11
	REL8_2_17:1.11
	REL7_4_28:1.9
	REL8_0_24:1.11
	REL8_1_20:1.11
	REL8_2_16:1.11
	REL7_4_27:1.9
	REL8_0_23:1.11
	REL8_1_19:1.11
	REL8_2_15:1.11
	REL7_4_26:1.9
	REL8_0_22:1.11
	REL8_1_18:1.11
	REL8_2_14:1.11
	REL7_4_25:1.9
	REL8_0_21:1.11
	REL8_1_17:1.11
	REL8_2_13:1.11
	REL7_4_24:1.9
	REL8_0_20:1.11
	REL8_1_16:1.11
	REL8_2_12:1.11
	REL7_4_23:1.9
	REL8_0_19:1.11
	REL8_1_15:1.11
	REL8_2_11:1.11
	REL7_4_22:1.9
	REL8_0_18:1.11
	REL8_1_14:1.11
	REL8_2_10:1.11
	REL7_4_21:1.9
	REL8_0_17:1.11
	REL8_1_13:1.11
	REL8_2_9:1.11
	REL7_4_20:1.9
	REL8_0_16:1.11
	REL8_1_12:1.11
	REL8_2_8:1.11
	REL8_2_7:1.11
	REL7_3_21:1.9
	REL7_4_19:1.9
	REL8_0_15:1.11
	REL8_1_11:1.11
	REL8_2_6:1.11
	REL8_3_BETA2:1.11
	REL8_3_BETA1:1.11
	REL7_3_20:1.9
	REL7_4_18:1.9
	REL8_0_14:1.11
	REL8_1_10:1.11
	REL8_2_5:1.11
	REL7_3_19:1.9
	REL7_4_17:1.9
	REL8_0_13:1.11
	REL8_1_9:1.11
	REL8_2_4:1.11
	REL8_0_12:1.11
	REL8_1_8:1.11
	REL8_2_3:1.11
	REL7_3_18:1.9
	REL7_4_16:1.9
	REL8_0_11:1.11
	REL8_1_7:1.11
	REL8_2_2:1.11
	REL8_0_10:1.11
	REL8_1_6:1.11
	REL8_2_1:1.11
	REL7_4_15:1.9
	REL7_3_17:1.9
	REL8_2_STABLE:1.11.0.8
	REL8_2_0:1.11
	REL8_2_RC1:1.11
	REL8_2_BETA3:1.11
	REL8_2_BETA2:1.11
	REL8_1_5:1.11
	REL8_0_9:1.11
	REL7_4_14:1.9
	REL7_3_16:1.9
	REL8_2_BETA1:1.11
	REL7_3_15:1.9
	REL7_4_13:1.9
	REL8_0_8:1.11
	REL8_1_4:1.11
	REL7_3_14:1.9
	REL7_4_12:1.9
	REL8_0_7:1.11
	REL8_1_3:1.11
	REL7_3_13:1.9
	REL7_4_11:1.9
	REL8_0_6:1.11
	REL8_1_2:1.11
	REL7_3_12:1.9
	REL7_4_10:1.9
	REL8_0_5:1.11
	REL8_1_1:1.11
	REL8_1_STABLE:1.11.0.6
	REL8_1_0:1.11
	REL8_1_0RC1:1.11
	REL8_1_0BETA4:1.11
	REL8_1_0BETA3:1.11
	REL7_3_11:1.9
	REL7_4_9:1.9
	REL8_0_4:1.11
	REL8_1_0BETA2:1.11
	REL8_1_0BETA1:1.11
	REL7_2_8:1.1
	REL7_3_10:1.9
	REL7_4_8:1.9
	REL8_0_3:1.11
	REL8_0_2:1.11
	REL7_2_7:1.1
	REL7_3_9:1.9
	REL7_4_7:1.9
	REL8_0_1:1.11
	REL8_0_STABLE:1.11.0.4
	REL8_0_0:1.11.0.2
	REL8_0_0RC5:1.11
	REL8_0_0RC4:1.11
	REL8_0_0RC3:1.11
	REL8_0_0RC2:1.11
	REL8_0_0RC1:1.11
	REL8_0_0BETA5:1.11
	REL8_0_0BETA4:1.10
	REL7_4_6:1.9
	REL7_3_8:1.9
	REL7_2_6:1.1
	REL8_0_0BETA3:1.10
	REL8_0_0BETA2:1.9
	REL7_2_5:1.1
	REL7_4_5:1.9
	REL7_3_7:1.9
	REL7_4_4:1.9
	REL8_0_0BETA1:1.9
	REL7_4_3:1.9
	REL7_4_2:1.9
	REL7_3_6:1.9
	REL7_4_1:1.9
	REL7_3_5:1.9
	REL7_4:1.9
	REL7_4_RC2:1.9
	REL7_4_STABLE:1.9.0.6
	REL7_4_RC1:1.9
	REL7_4_BETA5:1.9
	REL7_4_BETA4:1.9
	REL7_4_BETA3:1.9
	REL7_4_BETA2:1.9
	WIN32_DEV:1.9.0.4
	REL7_4_BETA1:1.9
	REL7_3_4:1.9
	REL7_3_2:1.9
	REL7_2_4:1.1
	REL7_3_STABLE:1.9.0.2
	REL7_2_3:1.1
	REL7_2_STABLE:1.1.0.4
	REL7_2:1.1
	REL7_2_RC2:1.1
	REL7_2_RC1:1.1
	REL7_2_BETA5:1.1
	REL7_2_BETA4:1.1
	REL7_2_BETA3:1.1
	REL7_2_BETA2:1.1
	REL7_2_BETA1:1.1
	REL7_1_2:1.1
	REL7_1_STABLE:1.1.0.2
	REL7_1:1.1;
locks; strict;
comment	@# @;


1.12
date	2007.11.10.23.30.45;	author momjian;	state dead;
branches;
next	1.11;

1.11
date	2004.11.12.21.55.01;	author tgl;	state Exp;
branches;
next	1.10;

1.10
date	2004.09.17.21.14.19;	author tgl;	state Exp;
branches;
next	1.9;

1.9
date	2002.10.12.19.15.09;	author momjian;	state Exp;
branches;
next	1.8;

1.8
date	2002.07.05.00.29.34;	author momjian;	state Exp;
branches;
next	1.7;

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

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

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

1.4
date	2002.06.12.23.42.48;	author momjian;	state Exp;
branches;
next	1.3;

1.3
date	2002.06.12.23.41.50;	author momjian;	state Exp;
branches;
next	1.2;

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

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


desc
@@


1.12
log
@Move most /contrib README files into SGML.  Some still need conversion
or will never be converted.
@
text
@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 the "Database File Layout" chapter of
the "Internals" section of the PostgreSQL documentation.

Oid2name connects to the database and extracts OID, filenode, and table
name information.  You can also have it show database OIDs and tablespace
OIDs.

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.

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.

Additional switches:
	-i	include indexes and sequences in the database listing.
	-x	display more information about each object shown:
		tablespace name, schema name, OID.
	-S	also show system objects
		(those in information_schema, pg_toast and pg_catalog schemas)
	-q	don't display headers
		(useful for scripting)

---------------------------------------------------------------------------

Sample session:

$ 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

$ cd $PGDATA/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

$ 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 also mix the options, and have more details
$ 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

$ # end of sample session.

---------------------------------------------------------------------------

You can also get approximate size data for each object using psql.  For
example,

SELECT relpages, relfilenode, relname FROM pg_class ORDER BY relpages DESC;

Each page is typically 8k.  Relpages is updated by VACUUM.

---------------------------------------------------------------------------

Mail me with any problems or additions you would like to see.  Clearing 
house for the code will be at:  http://www.crimelabs.net

b. palmer, bpalmer@@crimelabs.net
@


1.11
log
@Remove now-redundant description of Postgres file layout, in favor of
referencing the Database File Layout chapter I just added to the main
documentation.
@
text
@@


1.10
log
@Here is a patch bringing oid2name into the 21st century.

Alvaro Herrera
@
text
@d2 3
a4 24
PostgreSQL.

Databases are placed in directories named after their OIDs in pg_database,
and the table files within a database's directory are named by "filenode"
numbers, which are stored in pg_class.relfilenode.

Note that while a table's filenode often matches its OID, this is *not*
necessarily the case; some operations, like TRUNCATE, REINDEX, CLUSTER
and some forms of ALTER TABLE, can change the filenode while preserving
the OID.  Avoid assuming that filenode and table OID are the same.

When a table exceeds 1Gb, it is divided into gigabyte-sized "segments".
The first segment's file name is the same as the filenode; subsequent
segments are named filenode.1, filenode.2, etc.

Tablespaces make the scenario more complicated.  Each non-default
tablespace has a symlink inside the pg_tblspc directory, which points to
the physical tablespace directory (as specified in its CREATE TABLESPACE
command).  The symlink is named after the tablespace's OID.  Inside the
physical tablespace directory there is another directory for each database
that has elements in the tablespace, named after the database's OID.
Tables within that directory follow the filenode naming scheme.  The
"pg_default" tablespace is not addressed via pg_tblspc, but corresponds to
$PGDATA/base.
@


1.9
log
@Update README for oid2name.
@
text
@d1 2
a2 5
This utility allows administrators to view the file structure used by
PostgreSQL.  Databases are placed in directories based on their OIDs in
pg_database, and the tables in that directory are named by original
OIDs, stored in pg_class.relfilenode.  Oid2name connects to the database
and extracts the OID and table name information.
d4 47
a50 52
---------------------------------------------------------------------------

It can be used in four ways:


oid2name

  This will connect to the template1 database and display all databases
  in the system:

  $ oid2name
  All databases:
  ---------------------------------
  18720  = test1
  1      = template1
  18719  = template0
  18721  = test
  18735  = postgres
  18736  = cssi


oid2name -d test [-x]

  This connects to the database test and shows all tables and their OIDs:

  $ oid2name -d test
  All tables from database "test":
  ---------------------------------
  18766  = dns
  18737  = ips
  18722  = testdate


oid2name -d test -o 18737
oid2name -d test -t testdate

  This will connect to the database test and display the table name for oid
  18737 and the oid for table name testdate respectively:

  $ oid2name -d test -o 18737
  Tablename of oid 18737 from database "test":
  ---------------------------------
  18737  = ips


  $ oid2name -d test -t testdate 
  Oid of table testdate from database "test":
  ---------------------------------
  18722  = testdate

Keep in mind tables over one gigabyte will be split into separate files
with numeric file extensions.
a55 1
$ cd /u/pg/data/base
d58 52
a109 22
---------------------------------
16817  = test2
16578  = x
16756  = test
1      = template1
16569  = template0
16818  = test3
16811  = floattest

$ cd 16756
$ ls 1873*
18730   18731   18732   18735   18736   18737   18738   18739

$ oid2name -d test -o 18737
Tablename of oid 18737 from database "test":
---------------------------------
18737  = ips

$ oid2name -d test -t ips
Oid of table ips from database "test":
---------------------------------
18737  = ips
d112 2
a113 1
$ du * | while read SIZE OID
d115 1
a115 1
>	echo "$SIZE      `oid2name -q -d test -o $OID`"
d117 3
a119 2
24      18737  = ips
36      18722  = cities
d122 2
a123 2
$ # same as above, but sort by largest first
$ du * | while read SIZE OID
d125 5
a129 5
>	echo "$SIZE      `oid2name -q -d test -o $OID`"
> done |
> sort -rn
2048    19324  = bigtable
1950    23903  = customers
d132 41
a172 11
$ # show disk usage per database
$ cd /u/pg/data/base
$ du -s * |
> while read SIZE OID
> do
>	echo "$SIZE      `aspg oid2name -q | grep ^$OID' '`"
> done |
> sort -rn
2256        18721  = test
2135        18735  = postgres
..
d174 2
a175 1
This can be done in psql with:  
d177 1
a177 1
test=> SELECT relpages, relfilenode, relname FROM pg_class ORDER BY relpages DESC;
@


1.8
log
@Cleanup.
@
text
@d3 3
a5 3
pg_database, and the tables in that directory are named by their OIDs,
stored in pg_class.relfilenode.  Oid2name connects to the database and
extracts the OID and table name information.
@


1.7
log
@Add mention of segmented files to oid2name.
@
text
@d111 1
a111 1
$ du -s * | 
@


1.6
log
@Mention vacuum for relpages.
@
text
@d57 3
@


1.5
log
@Add script to show disk space per db.
@
text
@d118 1
a118 1
This can be done in psql with:  (each page is typically 8k)
d122 1
@


1.4
log
@Improve query.
@
text
@d87 1
d96 1
d106 12
a128 1

@


1.3
log
@Add mention of query showing pages used.
@
text
@d106 1
a106 1
test=> SELECT relpages, relname FROM pg_class ORDER BY relpages DESC;
@


1.2
log
@Add -q option to oid2name.  Add sample session to README.
@
text
@d104 4
@


1.1
log
@Add oid2name.  Add streaming option later.
@
text
@d1 5
a5 7
With version 7.1 of PostgreSQL server,  the old naming scheme for
databases and tables (in $PGDATA/base) has changed.  The databases
are put in folders for their OID in pg_database and the tables in
that folder are named for their OIDs in pg_class.  This app connects
to the database (you can specify host, port, user, pass etc to 
connect to a host other than localhost) and extracts the OID and 
table name information.  It has 4 ways it can be run:
d7 6
a12 1
 pg_oid2name
d15 1
a15 1
   in the system.
d17 1
a17 1
  $ ./pg_oid2name                                                                
a26 1
 pg_oid2name -d test [-x]
d28 3
a30 1
  This connects to the database test and shows all tables and their OIDs.
d32 1
a32 1
  $ ./pg_oid2name -d test                                                        
d39 3
a41 2
 pg_oid2name -d test -o 18737      or
 pg_oid2name -d test -t testdate
d44 1
a44 1
   18737 and the oid for table name testdate respectivly.
d46 1
a46 1
  $ ./pg_oid2name -d test -o 18737
d52 1
a52 1
  $ ./pg_oid2name -d test -t testdate 
d54 1
a54 1
  _______________________________
d57 46
a103 2
There should be a decent amount of error handling in the app,  a lot of it
 dealt with via the postgres function calls.
d105 1
a105 10
  $ ./pg_oid2name -d nothere -t testdate 
  Oid of table testdate from database "nothere":
  _______________________________
  Connection to database 'nothere' failed.
  FATAL 1:  Database "nothere" does not exist in the system catalog.

  $ ./pg_oid2name -d test -t nothere     
  Oid of table nothere from database "test":
  _______________________________
  No tables with that name found
a106 1
  
d108 1
a108 1
 house for the code will be at:  http://www.crimelabs.net
@
