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
83
84
85
86
87
88
89
90
91
92
|
<!--$Id: log_archive.so,v 10.26 2000/05/25 13:47:07 dda Exp $-->
<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<html>
<head>
<title>Berkeley DB: DbEnv.log_archive</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>DbEnv.log_archive</h1>
</td>
<td width="1%">
<a href="../api_java/java_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>
import com.sleepycat.db.*;
<p>
public String[] log_archive(int flags)
throws DbException;
</pre></h3>
<h1>Description</h1>
<p>The DbEnv.log_archive method
returns an array of log or database file names.
<p>By default, DbEnv.log_archive returns the names of all of the log files
that are no longer in use (e.g., no longer involved in active transactions),
and that may safely be archived for catastrophic recovery and then removed
from the system. If there were no file names to return, the memory location
referenced by <b>listp</b> will be set to null.
<p>The <b>flags</b> value must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one or more
of the following values.
<p><dl compact>
<p><dt><a name="Db.DB_ARCH_ABS">Db.DB_ARCH_ABS</a><dd>All pathnames are returned as absolute pathnames,
instead of relative to the database home directory.
<p><dt><a name="Db.DB_ARCH_DATA">Db.DB_ARCH_DATA</a><dd>Return the database files that need to be archived in order to recover
the database from catastrophic failure. If any of the database files
have not been accessed during the lifetime of the current log files,
DbEnv.log_archive will not include them in this list. It is also
possible that some of the files referenced in the log have since been
deleted from the system.
<p><dt><a name="Db.DB_ARCH_LOG">Db.DB_ARCH_LOG</a><dd>Return all the log file names regardless of whether or not they are in
use.
</dl>
<p>The Db.DB_ARCH_DATA and Db.DB_ARCH_LOG flags are mutually
exclusive.
<p>See the <a href="../utility/db_archive.html">db_archive</a> manual page for more information on database
archival procedures.
<p>The DbEnv.log_archive method throws an exception that encapsulates a non-zero error value on
failure.
<h1>Bugs</h1>
<p>In a threaded application (i.e., one where the environment was created
with the DB_THREAD flag specified), calling DbEnv.log_archive with the
DB_ARCH_DATA flag will fail, returning EINVAL. To work around this
problem, re-open the log explicitly without specifying DB_THREAD. This
restriction is expected to be removed in a future version of Berkeley DB.
<h1>Errors</h1>
<p>The DbEnv.log_archive method may fail and throw an exception encapsulating a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
<p>The log was corrupted.
</dl>
<p>The DbEnv.log_archive method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
If a catastrophic error has occurred, the DbEnv.log_archive method may fail and throw
a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>, in which case all subsequent Berkeley DB calls
will fail in the same way.
<h3>Class</h3>
<a href="../api_java/dbenv_class.html">DbEnv</a>
<h1>See Also</h1>
<a href="../api_java/env_set_lg_bsize.html">DbEnv.set_lg_bsize</a>,
<a href="../api_java/env_set_lg_max.html">DbEnv.set_lg_max</a>,
<a href="../api_java/log_archive.html">DbEnv.log_archive</a>,
<a href="../api_java/log_compare.html">DbEnv.log_compare</a>,
<a href="../api_java/log_file.html">DbEnv.log_file</a>,
<a href="../api_java/log_flush.html">DbEnv.log_flush</a>,
<a href="../api_java/log_get.html">DbEnv.log_get</a>,
<a href="../api_java/log_put.html">DbEnv.log_put</a>,
<a href="../api_java/log_register.html">DbEnv.log_register</a>,
<a href="../api_java/log_stat.html">DbEnv.log_stat</a>
and
<a href="../api_java/log_unregister.html">DbEnv.log_unregister</a>.
</tt>
<table><tr><td><br></td><td width="1%">
<a href="../api_java/java_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>
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>
|
