← Back to branch summary

~ubuntu-branches/ubuntu/edgy/rpm/edgy

« back to all changes in this revision

Viewing changes to db/docs/api_java/db_truncate.html

  • Committer: Bazaar Package Importer
  • Author(s): Joey Hess
  • Date: 2002-01-22 20:56:57 UTC
  • Revision ID: james.westby@ubuntu.com-20020122205657-l74j50mr9z8ofcl5
Tags: upstream-4.0.3
Import upstream version 4.0.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
db/docs/api_java/db_truncate.html
 
1
<!--$Id: db_truncate.so,v 1.8 2001/06/19 18:18:05 bostic Exp $-->
 
2
<!--Copyright 1997-2001 by Sleepycat Software, Inc.-->
 
3
<!--All rights reserved.-->
 
4
<html>
 
5
<head>
 
6
<title>Berkeley DB: Db.truncate</title>
 
7
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
 
8
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
 
9
</head>
 
10
<body bgcolor=white>
 
11
<a name="2"><!--meow--></a>
 
12
<table width="100%"><tr valign=top>
 
13
<td>
 
14
<h1>Db.truncate</h1>
 
15
</td>
 
16
<td align=right>
 
17
<a href="../api_java/java_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
 
18
</td></tr></table>
 
19
<hr size=1 noshade>
 
20
<tt>
 
21
<h3><pre>
 
22
import com.sleepycat.db.*;
 
23
<p>
 
24
public int truncate(DbTxn txnid, int flags)
 
25
        throws DbException;
 
26
</pre></h3>
 
27
<h1>Description</h1>
 
28
<p>The Db.truncate interface empties the database, discarding all
 
29
records it contains.
 
30
The number of records discarded from the database is returned.
 
31
<p>If the operation is to be transaction-protected, the <b>txnid</b>
 
32
parameter is a transaction handle returned from <a href="../api_java/txn_begin.html">DbEnv.txn_begin</a>;
 
33
otherwise, null.
 
34
<p>The <b>flags</b> parameter is currently unused, and must be set to 0.
 
35
<p>The Db.truncate method throws an exception that encapsulates a non-zero error value on
 
36
failure.
 
37
<h1>Errors</h1>
 
38
<p>The Db.truncate method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
 
39
If a catastrophic error has occurred, the Db.truncate method may fail and throw
 
40
a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>, in which case all subsequent Berkeley DB calls
 
41
will fail in the same way.
 
42
<h1>Class</h1>
 
43
<a href="../api_java/db_class.html">Db</a>
 
44
<h1>See Also</h1>
 
45
<a href="../api_java/db_associate.html">Db.associate</a>,
 
46
<a href="../api_java/db_close.html">Db.close</a>,
 
47
<a href="../api_java/db_cursor.html">Db.cursor</a>,
 
48
<a href="../api_java/db_del.html">Db.del</a>,
 
49
<a href="../api_java/db_fd.html">Db.fd</a>,
 
50
<a href="../api_java/db_get.html">Db.get</a>,
 
51
<a href="../api_java/db_get.html">Db.pget</a>,
 
52
<a href="../api_java/db_get_byteswapped.html">Db.get_byteswapped</a>,
 
53
<a href="../api_java/db_get_type.html">Db.get_type</a>,
 
54
<a href="../api_java/db_join.html">Db.join</a>,
 
55
<a href="../api_java/db_key_range.html">Db.key_range</a>,
 
56
<a href="../api_java/db_open.html">Db.open</a>,
 
57
<a href="../api_java/db_put.html">Db.put</a>,
 
58
<a href="../api_java/db_remove.html">Db.remove</a>,
 
59
<a href="../api_java/db_rename.html">Db.rename</a>,
 
60
<a href="../api_java/db_set_append_recno.html">Db.set_append_recno</a>,
 
61
<a href="../api_java/db_set_bt_minkey.html">Db.set_bt_minkey</a>,
 
62
<a href="../api_java/db_set_cachesize.html">Db.set_cachesize</a>,
 
63
<a href="../api_java/db_set_errcall.html">Db.set_errcall</a>,
 
64
<a href="../api_java/db_set_errpfx.html">Db.set_errpfx</a>,
 
65
<a href="../api_java/db_set_feedback.html">Db.set_feedback</a>,
 
66
<a href="../api_java/db_set_flags.html">Db.set_flags</a>,
 
67
<a href="../api_java/db_set_h_ffactor.html">Db.set_h_ffactor</a>,
 
68
<a href="../api_java/db_set_h_nelem.html">Db.set_h_nelem</a>,
 
69
<a href="../api_java/db_set_lorder.html">Db.set_lorder</a>,
 
70
<a href="../api_java/db_set_pagesize.html">Db.set_pagesize</a>,
 
71
<a href="../api_java/db_set_q_extentsize.html">Db.set_q_extentsize</a>,
 
72
<a href="../api_java/db_set_re_delim.html">Db.set_re_delim</a>,
 
73
<a href="../api_java/db_set_re_len.html">Db.set_re_len</a>,
 
74
<a href="../api_java/db_set_re_pad.html">Db.set_re_pad</a>,
 
75
<a href="../api_java/db_set_re_source.html">Db.set_re_source</a>,
 
76
<a href="../api_java/db_stat.html">Db.stat</a>,
 
77
<a href="../api_java/db_sync.html">Db.sync</a>,
 
78
<a href="../api_java/db_truncate.html">Db.truncate</a>,
 
79
<a href="../api_java/db_upgrade.html">Db.upgrade</a>,
 
80
and
 
81
<a href="../api_java/db_verify.html">Db.verify</a>.
 
82
</tt>
 
83
<table width="100%"><tr><td><br></td><td align=right>
 
84
<a href="../api_java/java_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
 
85
</td></tr></table>
 
86
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
 
87
</body>
 
88
</html>