1<!--$Id: db_truncate.so,v 11.6 2004/12/16 19:13:05 bostic Exp $-->
2<!--$Id: m4.tcl,v 11.28 2004/12/16 19:13:05 bostic Exp $-->
3<!--Copyright (c) 1997,2008 Oracle.  All rights reserved.-->
4<!--See the file LICENSE for redistribution information.-->
5<html>
6<head>
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,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
10</head>
11<body bgcolor=white>
12<table width="100%"><tr valign=top>
13<td>
14<b><i>db</i> <b>truncate</b></b>
15</td>
16<td align=right>
17<a href="../api_tcl/api_tcl.html"><img src="../images/api.gif" alt="API"></a>
18<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
19</tr></table>
20<hr size=1 noshade>
21<tt>
22<b><pre>db truncate
23	[-txn txnid]
24</pre></b>
25<b>Description(db truncate)</b>
26<p>Empties the database, discarding all records it contains.</p>
27<p>The options are as follows:</p>
28<br>
29<b>-txn txnid</b><ul compact><li>If the operation is part of an application-specified transaction, the
30<b>txnid</b> parameter is a transaction handle returned from
31<i>env</i> <b>txn</b>.  If no transaction handle is specified, but the
32operation occurs in a transactional
33database,
34the operation will be implicitly transaction protected.</ul>
35<br>
36<p>The <i>db</i> <b>truncate</b> command returns the number of records discarded
37from the database on success.</p>
38<p>In the case of error, a Tcl error is thrown.</p>
39</tt>
40<table width="100%"><tr><td><br></td><td align=right>
41<a href="../api_tcl/api_tcl.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
42</td></tr></table>
43<p><font size=1>Copyright (c) 1996,2008 Oracle.  All rights reserved.</font>
44</body>
45</html>
46