From 85e9a5a0148f7aff1a0e9488de2839cc33c89bb6 Mon Sep 17 00:00:00 2001 From: Bruce Momjian Date: Fri, 29 Jul 2005 15:13:11 +0000 Subject: Move reindexdb from /contrib to /bin. Euler Taveira de Oliveira --- doc/src/sgml/ref/allfiles.sgml | 3 +- doc/src/sgml/ref/reindexdb.sgml | 294 ++++++++++++++++++++++++++++++++++++++++ doc/src/sgml/reference.sgml | 3 +- 3 files changed, 298 insertions(+), 2 deletions(-) create mode 100644 doc/src/sgml/ref/reindexdb.sgml (limited to 'doc/src') diff --git a/doc/src/sgml/ref/allfiles.sgml b/doc/src/sgml/ref/allfiles.sgml index 98dfbda111b..c08b09b67d4 100644 --- a/doc/src/sgml/ref/allfiles.sgml +++ b/doc/src/sgml/ref/allfiles.sgml @@ -1,5 +1,5 @@ @@ -136,4 +136,5 @@ Complete list of usable sgml source files in this directory. + diff --git a/doc/src/sgml/ref/reindexdb.sgml b/doc/src/sgml/ref/reindexdb.sgml new file mode 100644 index 00000000000..d52fe6a0d43 --- /dev/null +++ b/doc/src/sgml/ref/reindexdb.sgml @@ -0,0 +1,294 @@ + + + + + reindexdb + 1 + Application + + + + reindexdb + reindex a PostgreSQL database + + + + reindexdb + + + + + reindexdb + connection-option + --table | -t table + --index | -i index + dbname + + reindexdb + connection-option + --all | -a + + reindexdb + connection-option + --system | -s + dbname + + + + + + Description + + + reindexdb is a utility for rebuilding indexes + in a PostgreSQL database. + + + + reindexdb is a wrapper around the SQL + command . + There is no effective difference between reindexing databases via + this utility and via other methods for accessing the server. + + + + + + + Options + + + reindexdb accepts the following command-line arguments: + + + + + + + + Reindex all databases. + + + + + + + + + + Reindex database's system catalogs. + + + + + + + + + + Reindex table only. + + + + + + + + + + Recreate index only. + + + + + + + + + + Specifies the name of the database to be reindexed. + If this is not specified and (or + ) is not used, the database name is read + from the environment variable PGDATABASE. If + that is not set, the user name specified for the connection is + used. + + + + + + + + + + Echo the commands that reindexdb generates + and sends to the server. + + + + + + + + + + Do not display a response. + + + + + + + + + reindexdb also accepts + the following command-line arguments for connection parameters: + + + + + + + + Specifies the host name of the machine on which the server is + running. If the value begins with a slash, it is used as the + directory for the Unix domain socket. + + + + + + + + + + Specifies the TCP port or local Unix domain socket file + extension on which the server + is listening for connections. + + + + + + + + + + User name to connect as. + + + + + + + + + + Force password prompt. + + + + + + + + + + Environment + + + + PGDATABASE + PGHOST + PGPORT + PGUSER + + + + Default connection parameters + + + + + + + + + Diagnostics + + + In case of difficulty, see and for + discussions of potential problems and error messages. + The database server must be running at the + targeted host. Also, any default connection settings and environment + variables used by the libpq front-end + library will apply. + + + + + + + Notes + + + reindexdb might need to connect several + times to the PostgreSQL server, asking + for a password each time. It is convenient to have a + ~/.pgpass file in such cases. See for more information. + + + + + + Examples + + + To reindex the database test: + +$ reindexdb test + + + + + To reindex the table foo and the index + bar in a database named abcd: + +$ reindexdb --table foo --index bar abcd + + + + + + + See Also + + + + Environment Variables () + + + + + + diff --git a/doc/src/sgml/reference.sgml b/doc/src/sgml/reference.sgml index 5a06288c735..0191ec8b3c3 100644 --- a/doc/src/sgml/reference.sgml +++ b/doc/src/sgml/reference.sgml @@ -1,5 +1,5 @@ @@ -176,6 +176,7 @@ PostgreSQL Reference Manual &pgDumpall; &pgRestore; &psqlRef; + &reindexdb; &vacuumdb; -- cgit v1.2.3