Changeset 31 for trunk/table_growth

Show
Ignore:
Timestamp:
12/10/08 05:06:14 (5 years ago)
Author:
robert
Message:

make a nicer readme based on the wiki page, and bump version

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/table_growth/README.txt

    r30 r31  
    1 INFO: 
     1NAME  
    22 
    3 Table growth is a simple set of schema/functions used for monitoring table 
    4 growth on your database.  
     3    table_growth - a set of scripts for reporting table size growth in postgres 
    54 
    6 INSTALL: 
     5SYNOPSIS  
    76 
    8 You should install the .sql files into database for which you want to  
    9 gather growth information and schedule a postgres cron job to gather  
    10 the information. 
     7    A set of schema, functions, and shell script to report table size growth. 
    118 
    12 45 6 1 * * /var/lib/pgsql/scripts/table_growth_report.sh 1>/dev/null 
     9 
     10VERSION  
     11 
     12    This document refers to version 0.2 of table_growth, released December 9th, 
     13    2008 
     14 
     15USAGE  
     16 
     17    To use table_growth, you need to add the schema for holding table size 
     18    information, install the included functions into your database, set up a cron 
     19    job to do the data population, and set up a cron job to send the reports. We 
     20    typically setup the conr jobs to look like this: 
     21 
     22    15 0 * * * psql -c "select otools.collect_table_growth(); select 
     23    otools.summarize_table_growth(); " 1>/dev/null  
     24 
     25    45 6 1 * * /var/lib/pgsql/scripts/table_growth_report.sh 1>/dev/null 
     26 
     27BUGS AND LIMITATIONS  
     28 
     29    The package is designed to work on single databases at a time, if you want to 
     30    report on multiple databases in a cluster, you will need to install this in 
     31    each individual database, and also set cron jobs independently for each 
     32    database. 
     33 
     34    Some actions may not work on older versions of Postgres (before 8.1) 
     35 
     36    Please report any problems to robert@omniti.com. 
     37 
     38TODO  
     39 
     40LICENSE AND COPYRIGHT  
     41 
     42    Copyright (c) 2008 OmniTI, Inc. 
     43 
     44    Redistribution and use in source and binary forms, with or without 
     45    modification, are permitted provided that the following conditions are met: 
     46 
     47    1. Redistributions of source code must retain the above copyright notice, 
     48     this list of conditions and the following disclaimer. 
     49    2. Redistributions in binary form must reproduce the above copyright notice, 
     50     this list of conditions and the following disclaimer in the documentation 
     51     and/or other materials provided with the distribution. 
     52 
     53 
     54    THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED 
     55    WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
     56    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO 
     57    EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
     58    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
     59    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
     60    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
     61    IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
     62    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
     63    POSSIBILITY OF SUCH DAMAGE. 
     64