#include <db.h>

int
DB->truncate(DB *db,
    DB_TXN *txnid, u_int32_t *countp, u_int32_t flags);

Description

The DB->truncate interface empties the database, discarding all records it contains. The number of records discarded from the database is returned in countp.

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

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

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 returns a non-zero error value on failure and 0 on success.

Errors

The DB->truncate method may fail and return a non-zero error for the following conditions:

DB_LOCK_DEADLOCK

The operation was selected to resolve a deadlock.

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. If a catastrophic error has occurred, the DB->truncate method may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

Class

See Also