farrokhi/pg_repack
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improvements to the install section of the docs

Browse Source 
Fixed cleanup procedure with EXTENSION, added uninstall section.
This commit is contained in:
Daniele Varrazzo 2012-11-13 14:07:43 +00:00
parent 673a8ea100
commit 4f9269cab8
1 changed files with 31 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
doc/pg_repack.rst
View File

@ -59,7 +59,8 @@ You can choose one of the following methods to reorganize:
NOTICE: NOTICE:
* Only superusers can use the utility. * Only superusers can use the utility.
* Target table must have PRIMARY KEY. * Target table must have a PRIMARY KEY, or at least a UNIQUE total index on a
NOT NULL column.
.. _pg_repack: http://reorg.github.com/pg_repack .. _pg_repack: http://reorg.github.com/pg_repack
.. _project page: https://github.com/reorg/pg_repack .. _project page: https://github.com/reorg/pg_repack
@ -195,10 +196,13 @@ Diagnostics
Error messages are reported when pg_repack fails. The following list shows the Error messages are reported when pg_repack fails. The following list shows the
cause of errors. cause of errors.
You need to cleanup by hand after fatal errors. To cleanup, execute You need to cleanup by hand after fatal errors. To cleanup, just remove
``$PGHOME/share/contrib/uninstall_pg_repack.sql`` to the database where the pg_repack from the database and install it again: for PostgreSQL 9.1 and
error occured and then execute ``$PGHOME/share/contrib/pg_repack.sql``. (Do following execute ``DROP EXTENSION pg_repack CASCADE`` in the database where
uninstall and reinstall.) the error occurred, followed by ``CREATE EXTENSION pg_repack``; for previous
version load the script ``$SHAREDIR/contrib/uninstall_pg_repack.sql`` into the
database where the error occured and then load
``$SHAREDIR/contrib/pg_repack.sql`` again.
pg_repack: repack database "template1" ... skipped pg_repack: repack database "template1" ... skipped
pg_repack is not installed in the database when ``--all`` option is pg_repack is not installed in the database when ``--all`` option is
@ -290,33 +294,42 @@ table. Then, it updates the system catalogs directly to swap the work table
and the original one. and the original one.
Installations Installation
------------- ------------
pg_repack can be built with "make" on UNIX or Linux. pgxs build framework is pg_repack can be built with ``make`` on UNIX or Linux. The PGXS build
used automatically. Before building, you might need to install postgres framework is used automatically. Before building, you might need to install
packages for developer (postgresql-devel, etc.) and add ``pg_config`` to your the PostgreSQL development packages (``postgresql-devel``, etc.) and add the
``$PATH``. :: directory containing ``pg_config`` to your ``$PATH``. Then you can run::
$ cd pg_repack $ cd pg_repack
$ make $ make
$ su $ sudo make install
$ make install
You can also use Microsoft Visual C++ 2010 to build the program on Windows. You can also use Microsoft Visual C++ 2010 to build the program on Windows.
There are project files in the ``msvc`` folder. There are project files in the ``msvc`` folder.
Install the pg_repack extension in the database you want to process. On After installation, load the pg_repack extension in the database you want to
PostgreSQL 9.1 or following pg_repack is packaged as an extension:: process. On PostgreSQL 9.1 and following pg_repack is packaged as an
extension, so you can execute::
$ psql -c "CREATE EXTENSION pg_repack" -d your_database $ psql -c "CREATE EXTENSION pg_repack" -d your_database
For previous PostgreSQL versions you should load the script ``pg_repack.sql`` For previous PostgreSQL versions you should load the script
that can be found in the ``contrib`` subdirectory of the directory reported by ``$SHAREDIR/contrib/pg_repack.sql`` in the database to process; you can
``--pg_config sharedir``, e.g. :: get ``$SHAREDIR`` using ``pg_config --sharedir``, e.g. ::
$ psql -f "$(pg_config --sharedir)/contrib/pg_repack.sql" -d your_database $ psql -f "$(pg_config --sharedir)/contrib/pg_repack.sql" -d your_database
You can remove pg_repack from a PostgreSQL 9.1 and following database using
``DROP EXTENSION pg_repack``. For previous Postgresql versions load the
``$SHAREDIR/contrib/uninstall_pg_repack.sql`` script or just drop the
``repack`` schema.
If you are upgrading from a previous version of pg_repack or pg_reorg, just
drop the old version from the database as explained above and install the new
version.
Requirements Requirements
------------ ------------