head	1.6;
access;
symbols;
locks; strict;
comment	@# @;


1.6
date	92.07.14.05.54.17;	author ptong;	state Exp;
branches;
next	1.5;

1.5
date	92.07.12.20.45.07;	author mer;	state Exp;
branches;
next	1.4;

1.4
date	91.08.15.01.43.24;	author kemnitz;	state Exp;
branches;
next	1.3;

1.3
date	91.02.25.15.47.23;	author mike;	state Exp;
branches;
next	1.2;

1.2
date	90.07.19.16.28.13;	author keongwoo;	state Exp;
branches;
next	1.1;

1.1
date	90.07.18.16.22.18;	author mao;	state Exp;
branches;
next	;


desc
@man page for the purge postquel command
@


1.6
log
@reformated
@
text
@.\" XXX standard disclaimer belongs here....
.SP PURGE COMMANDS 6/14/90
.XA 2 Purge
.uh NAME
.lp
purge \*- discard historical data
.uh SYNOPSIS
.lp
.(l
\fBpurge\fR classname [ \fBbefore\fR abstime ] [ \fBafter\fR reltime ]
.)l
.uh DESCRIPTION
.lp
.b Purge
allows a user to specify the historical retention properties of a class.
The date specified is an absolute time such as 
Jan 1 1987, and
\*(PP will discard tuples whose validity expired before the indicated time.
.b Purge 
with no
.i before
clause is equivalent to
.q "purge before now."
Until specified with a purge command,
instance preservation defaults to
.q "forever."
.lp
The user may purge a class at any time as long
as the purge date never decreases.
\*(PP will enforce this restriction, silently.
.uh EXAMPLE
.lp
.nf
.ft C
/* Always discard data in the EMP class */
/* prior to January 1, 1989             */

purge EMP before "Jan 1 1989"

/* Retain only the current data in EMP */

purge EMP
.ft
.uh BUGS
.lp
Error messages are quite unhelpful.  A complaint about "inconsistent times"
followed by several nine-digit numbers indicates an attempt to "back up"
a purge date on a relation.
@


1.5
log
@fix up purge docs
@
text
@d9 3
a11 6
.b purge
classname [
.b before
abstime ] [
.b after
reltime ]
d33 5
a37 2
/* Always discard data in the EMP class prior to January 1, 1989 */
.lp
d39 1
a39 1
.lp
d41 1
a41 1
.lp
d43 1
a43 1
.lp
@


1.4
log
@fixed up bogus example date.
@
text
@d12 3
a14 1
abstime ] 
d24 1
a24 1
.i after
@


1.3
log
@objectified
@
text
@d34 13
a46 10
.nf
\* Always discard data in the EMP class prior to January 1, 1989 \*

   purge EMP before "January 1, 1989"
	
\* Retain only the current data in EMP \*

   purge EMP
.fi

@


1.2
log
@made it bold on "purge"
@
text
@d10 1
a10 1
relname [
d16 1
a16 1
allows a user to specify the historical retention properties of a relation.
d26 1
a26 1
tuple preservation defaults to
d29 1
a29 1
The user may purge a relation at any time as long
d35 1
a35 1
\* Always discard data in the EMP relation prior to January 1, 1989 \*
@


1.1
log
@Initial revision
@
text
@d20 2
a21 1
Purge with no
@