<!--$Id: log_file.so,v 10.18 2000/03/01 21:41:29 bostic Exp $-->
<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<html>
<head>
<title>Berkeley DB: DbEnv.log_file</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_file</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_file(DbLsn lsn)
throws DbException;
</pre></h3>
<h1>Description</h1>
<p>The DbEnv.log_file method maps
<a href="../api_java/lsn_class.html">DbLsn</a> objects
to file names,
returning the name of the file containing the record named by <b>lsn</b>.
<p>The <b>len</b> argument is the length of the <b>namep</b> buffer in bytes.
If <b>namep</b> is too short to hold the file name, DbEnv.log_file will
return ENOMEM.
(Log file names are normally quite short, on the order of 10 characters.)
<p>This mapping of
<a href="../api_java/lsn_class.html">DbLsn</a> objects
to files is needed for database administration. For example, a
transaction manager typically records the earliest
<a href="../api_java/lsn_class.html">DbLsn</a>
needed for restart, and the database administrator may want to archive
log files to tape when they contain only
<a href="../api_java/lsn_class.html">DbLsn</a>
entries before the earliest one needed for restart.
<p>The DbEnv.log_file method throws an exception that encapsulates a non-zero error value on
failure.
<h1>Errors</h1>
<p>The DbEnv.log_file method may fail and throw an exception encapsulating a non-zero error for the following conditions:
<p><dl compact>
<p><dt>ENOMEM<dd>The supplied buffer was too small to hold the log file name.
</dl>
<p>The DbEnv.log_file 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_file 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>