db_checkpoint.html 4.03 KB
Newer Older
unknown's avatar
unknown committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
<!--$Id: db_checkpoint.so,v 10.22 2000/04/03 20:10:39 bostic Exp $-->
<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<html>
<head>
<title>Berkeley DB: db_checkpoint</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
        <a name="2"><!--meow--></a>    
<table><tr valign=top>
<td>
<h1>db_checkpoint</h1>
</td>
<td width="1%">
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>db_checkpoint [<b>-1Vv</b>]
    [<b>-h home</b>] [<b>-k kbytes</b>] [<b>-L file</b>] [<b>-p min</b>]</pre></h3>
<h1>Description</h1>
        <a name="3"><!--meow--></a>    
<p>The db_checkpoint utility is a daemon process that monitors the
database log and periodically calls <a href="../api_c/txn_checkpoint.html">txn_checkpoint</a> to checkpoint it.
<p>The options are as follows:
<p><dl compact>
<p><dt><b>-1</b><dd>Checkpoint the log once, regardless of whether or not there has
been activity since the last checkpoint, and then exit.
<p><dt><b>-h</b><dd>Specify a home directory for the database environment; by
default, the current working directory is used.
<p><dt><b>-k</b><dd>Checkpoint the database at least as often as every <b>kbytes</b> of log
file are written.
<p><dt><b>-L</b><dd>Log the execution of the db_checkpoint utility to the specified file in the
following format, where <i>###</i> is the process ID, and the date
is the time the utility was started.
<p><blockquote><pre>db_checkpoint: ### Wed Jun 15 01:23:45 EDT 1995</pre></blockquote>
This file will be removed if the db_checkpoint utility exits gracefully.
<p><dt><b>-p</b><dd>Checkpoint the database at least every <b>min</b> minutes if
there has been any activity since the last checkpoint.
<p><dt><b>-V</b><dd>Write the version number to the standard output and exit.
<p><dt><b>-v</b><dd>Write the time of each checkpoint attempt to the standard
output.
</dl>
<p>At least one of the <b>-1</b>, <b>-k</b> and <b>-p</b> options must
be specified.
<p>The db_checkpoint utility uses a Berkeley DB environment (as described for the
<b>-h</b> option, the environment variable <b>DB_HOME</b>, or,
because the utility was run in a directory containing a Berkeley DB
environment).  In order to avoid environment corruption when using a Berkeley DB
environment, db_checkpoint should always be given the chance to detach from
the environment and exit gracefully.  To cause db_checkpoint to release all
environment resources and exit cleanly, send it an interrupt signal
(SIGINT).
<p>The db_checkpoint utility does not attempt to create the Berkeley DB
shared memory regions if they do not already exist.  The application
which creates the region should be started first, and then, once the
region is created, the db_checkpoint utility should be started.
<p>The db_checkpoint utility exits 0 on success, and &gt;0 if an error occurs.
<h1>Environment Variables</h1>
<p><dl compact>
<p><dt>DB_HOME<dd>If the <b>-h</b> option is not specified and the environment variable
DB_HOME is set, it is used as the path of the database home, as described
in <a href="../api_c/env_open.html">DBENV-&gt;open</a>.
</dl>
<h1>See Also</h1>
<a href="../utility/berkeley_db_svc.html">berkeley_db_svc</a>,
<a href="../utility/db_archive.html">db_archive</a>,
db_checkpoint,
<a href="../utility/db_deadlock.html">db_deadlock</a>,
<a href="../utility/db_dump.html">db_dump</a>,
<a href="../utility/db_load.html">db_load</a>,
<a href="../utility/db_recover.html">db_recover</a>,
<a href="../utility/db_stat.html">db_stat</a>,
<a href="../utility/db_upgrade.html">db_upgrade</a>,
and
<a href="../utility/db_verify.html">db_verify</a>.
</tt>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>