#include <db_cxx.h>

int
DbSequence::remove(u_int32_t flags);

Description: DbSequence::remove

The DbSequence::remove method removes the sequence from the database. This method should not be called if there are other open handles on this sequence.

The DbSequence handle may not be accessed again after DbSequence::remove is called, regardless of its return.

The DbSequence::remove method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, and returns 0 on success.

Parameters

flags

The flags parameter must be set to 0 or by bitwise inclusively OR'ing together one or more of the following values:

DB_AUTO_COMMIT

The remove will be enclosed in a transaction and will be recoverable.

DB_TXN_NOSYNC

If a DB_AUTO_COMMIT triggers a transaction, do not synchronously flush the log.

txnid

If the operation is to be transaction-protected, the txnid parameter is a transaction handle returned from DbEnv::txn_begin; otherwise, NULL.

Errors

The DbSequence::remove method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:

EINVAL

An invalid flag value or parameter was specified.

Class

See Also