2
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
<!--All rights reserved.-->
4
<!--See the file LICENSE for redistribution information.-->
7
<title>Berkeley DB: DB->truncate</title>
8
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
12
<a name="2"><!--meow--></a>
13
<table width="100%"><tr valign=top>
15
<h1>DB->truncate</h1>
18
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
26
DB->truncate(DB *db,
27
DB_TXN *txnid, u_int32_t *countp, u_int32_t flags);
30
<p>The DB->truncate interface empties the database, discarding all
32
The number of records discarded from the database is returned in
34
<p>If the operation is to be transaction-protected (other than by specifying
35
the DB_AUTO_COMMIT flag), the <b>txnid</b> parameter is a
36
transaction handle returned from <a href="../api_c/txn_begin.html">DB_ENV->txn_begin</a>; otherwise, NULL.
37
<p>The <b>flags</b> value must be set to 0 or
40
<p><dt><a name="DB_AUTO_COMMIT">DB_AUTO_COMMIT</a><dd>Enclose the DB->truncate call within a transaction. If the call succeeds,
41
changes made by the operation will be recoverable. If the call fails,
42
the operation will have made no changes.
44
<p>The DB->truncate method returns a non-zero error value on failure and 0 on success.
46
<p>The DB->truncate method may fail and return a non-zero error for the following conditions:
48
<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock.
50
<p>The DB->truncate method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
51
If a catastrophic error has occurred, the DB->truncate method may fail and
52
return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>,
53
in which case all subsequent Berkeley DB calls will fail in the same way.
55
<a href="../api_c/db_class.html">DB</a>
57
<a href="../api_c/db_list.html">Databases and Related Methods</a>
59
<table width="100%"><tr><td><br></td><td align=right>
60
<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
62
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>