mirror of
https://github.com/MariaDB/server.git
synced 2025-02-01 03:21:53 +01:00
104 lines
5.2 KiB
HTML
104 lines
5.2 KiB
HTML
<!--$Id: db_remove.so,v 10.20 2000/10/25 15:24:44 dda Exp $-->
|
|
<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.-->
|
|
<!--All rights reserved.-->
|
|
<html>
|
|
<head>
|
|
<title>Berkeley DB: Db.remove</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.remove</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.*;
|
|
import java.io.FileNotFoundException;
|
|
<p>
|
|
public void remove(String file, String database, int flags)
|
|
throws DbException, FileNotFoundException;
|
|
</pre></h3>
|
|
<h1>Description</h1>
|
|
<p>The Db.remove interface removes the database specified by the
|
|
<b>file</b> and <b>database</b> arguments. If no <b>database</b> is
|
|
specified, the physical file represented by <b>file</b> is removed,
|
|
incidentally removing all databases that it contained.
|
|
<p>If a physical file is being removed and logging is currently enabled in
|
|
the database environment, no database in the file may be open when the
|
|
Db.remove method is called. Otherwise, no reference count of database
|
|
use is maintained by Berkeley DB. Applications should not remove databases that
|
|
are currently in use. In particular, some architectures do not permit
|
|
the removal of files with open handles. On these architectures, attempts
|
|
to remove databases that are currently in use will fail.
|
|
<p>The <b>flags</b> parameter is currently unused, and must be set to 0.
|
|
<p>Once Db.remove has been called, regardless of its return, the
|
|
<a href="../api_java/db_class.html">Db</a> handle may not be accessed again.
|
|
<p>The Db.remove method throws an exception that encapsulates a non-zero error value on
|
|
failure.
|
|
<h1>Environment Variables</h1>
|
|
<p><dl compact>
|
|
<p><dt>DB_HOME<dd>If the <b>dbenv</b> argument to <a href="../api_c/db_create.html">db_create</a> was initialized using
|
|
<a href="../api_java/env_open.html">DbEnv.open</a> the environment variable <b>DB_HOME</b> may be used
|
|
as the path of the database environment home. Specifically, Db.remove
|
|
is affected by the configuration value DB_DATA_DIR.
|
|
</dl>
|
|
<h1>Errors</h1>
|
|
<p>The Db.remove method may fail and throw an exception encapsulating a non-zero error for the following conditions:
|
|
<p><dl compact>
|
|
<p><dt>EINVAL<dd>A database in the file is currently open.
|
|
</dl>
|
|
<p>If the file or directory does not exist, the Db.remove method will
|
|
fail and
|
|
throw a FileNotFoundException exception.
|
|
<p>The Db.remove 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.remove 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/db_class.html">Db</a>
|
|
<h1>See Also</h1>
|
|
<a href="../api_java/db_close.html">Db.close</a>,
|
|
<a href="../api_java/db_cursor.html">Db.cursor</a>,
|
|
<a href="../api_java/db_del.html">Db.del</a>,
|
|
<a href="../api_java/db_fd.html">Db.fd</a>,
|
|
<a href="../api_java/db_get.html">Db.get</a>,
|
|
<a href="../api_java/db_get_byteswapped.html">Db.get_byteswapped</a>,
|
|
<a href="../api_java/db_get_type.html">Db.get_type</a>,
|
|
<a href="../api_java/db_join.html">Db.join</a>,
|
|
<a href="../api_java/db_key_range.html">Db.key_range</a>,
|
|
<a href="../api_java/db_open.html">Db.open</a>,
|
|
<a href="../api_java/db_put.html">Db.put</a>,
|
|
<a href="../api_java/db_remove.html">Db.remove</a>,
|
|
<a href="../api_java/db_set_bt_minkey.html">Db.set_bt_minkey</a>,
|
|
<a href="../api_java/db_set_cachesize.html">Db.set_cachesize</a>,
|
|
<a href="../api_java/db_set_errcall.html">Db.set_errcall</a>,
|
|
<a href="../api_java/db_set_errpfx.html">Db.set_errpfx</a>,
|
|
<a href="../api_java/db_set_flags.html">Db.set_flags</a>,
|
|
<a href="../api_java/db_set_h_ffactor.html">Db.set_h_ffactor</a>,
|
|
<a href="../api_java/db_set_h_nelem.html">Db.set_h_nelem</a>,
|
|
<a href="../api_java/db_set_lorder.html">Db.set_lorder</a>,
|
|
<a href="../api_java/db_set_pagesize.html">Db.set_pagesize</a>,
|
|
<a href="../api_java/db_set_q_extentsize.html">Db.set_q_extentsize</a>,
|
|
<a href="../api_java/db_set_re_delim.html">Db.set_re_delim</a>,
|
|
<a href="../api_java/db_set_re_len.html">Db.set_re_len</a>,
|
|
<a href="../api_java/db_set_re_pad.html">Db.set_re_pad</a>,
|
|
<a href="../api_java/db_set_re_source.html">Db.set_re_source</a>,
|
|
<a href="../api_java/db_stat.html">Db.stat</a>,
|
|
<a href="../api_java/db_sync.html">Db.sync</a>,
|
|
<a href="../api_java/db_upgrade.html">Db.upgrade</a>
|
|
and
|
|
<a href="../api_java/db_verify.html">Db.verify</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>
|