Berkeley DB: Db.truncate
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++

# Db.truncate |

`

###

    import com.sleepycat.db.*;

    public int truncate(DbTxn txnid, int flags)
        throws DbException;

# Description

The Db.truncate interface empties the database, discarding all records it contains. The number of records discarded from the database is returned.

If the operation is to be transaction-protected (other than by specifying the Db.DB_AUTO_COMMIT flag), the txnid parameter is a transaction handle returned from DbEnv.txn_begin; otherwise, null.

The flags value must be set to 0 or the following value:

Db.DB_AUTO_COMMIT
  Enclose the Db.truncate call within a transaction. If the call succeeds, changes made by the operation will be recoverable. If the call fails, the operation will have made no changes.

The Db.truncate method throws an exception that encapsulates a non-zero error value on failure.

# Errors

The Db.truncate method may fail and throw an exception encapsulating a non-zero error for the following conditions:

The Db.truncate 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.truncate method may fail and throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

Db

# See Also

Databases and Related Methods`

Copyright Sleepycat Software