db_set_re_len.html [plain text]
<!--$Id: db_set_re_len.html,v 1.1 2003/02/15 04:55:50 zarzycki Exp $-->
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: Db.set_re_len</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 width="100%"><tr valign=top>
<td>
<h1>Db.set_re_len</h1>
</td>
<td align=right>
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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 void set_re_len(int re_len)
throws DbException;
</pre></h3>
<h1>Description</h1>
<p>For the Queue access method, specify that the records are of length
<b>re_len</b>. For the Queue access method, the record length must be
enough smaller than the database's page size that at least one record
plus the database page's metadata information can fit on each database
page.
<p>For the Recno access method, specify that the records are fixed-length,
not byte-delimited, and are of length <b>re_len</b>.
<p>Any records added to the database that are less than <b>re_len</b> bytes
long are automatically padded (see <a href="../api_java/db_set_re_pad.html">Db.set_re_pad</a> for more
information).
<p>Any attempt to insert records into the database that are greater than
<b>re_len</b> bytes long will cause the call to fail immediately and
return an error.
<p>The Db.set_re_len method configures a database, not only operations performed
using the specified <a href="../api_java/db_class.html">Db</a> handle.
<p>The Db.set_re_len interface may not be called after the <a href="../api_java/db_open.html">Db.open</a>
interface is called.
If the database already exists when
<a href="../api_java/db_open.html">Db.open</a> is called, the information specified to Db.set_re_len will
be ignored.
<p>The Db.set_re_len method throws an exception that encapsulates a non-zero error value on
failure.
<h1>Errors</h1>
<p>The Db.set_re_len 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>Called after <a href="../api_java/db_open.html">Db.open</a> was called.
</dl>
<p>The Db.set_re_len 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 Db.set_re_len 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.
<h1>Class</h1>
<a href="../api_java/db_class.html">Db</a>
<h1>See Also</h1>
<a href="../api_java/db_list.html">Databases and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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>