Berkeley DB: DB->close
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btr ee,hash,hashing,transaction,transactions,locking,logging,access method,access me thods,java,C,C++

# DB->close

`

###

    #include <db.h>

    int
    DB->close(DB *db, u_int32_t flags);

# Description

The DB->close function flushes any cached database information to disk, closes any open cursors, frees any allocated resources, and closes any underlying files. Since key/data pairs are cached in memory, failing to sync the file with the DB->close or DB->sync function may result in inconsistent or lost information.

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

DB_NOSYNC
  Do not flush cached information to disk.

  The DB_NOSYNC flag is a dangerous option. It should only be set if the application is doing logging (with transactions) so that the database is recoverable after a system or application crash, or if the database is always generated from scratch after any system or application crash.

  It is important to understand that flushing cached information to disk only minimizes the window of opportunity for corrupted data. While unlikely, it is possible for database corruption to happen if a system or application crash occurs while writing data to the database. To ensure that database corruption never occurs, applications must either: use transactions and logging with automatic recovery, use logging and application-specific recovery, or edit a copy of the database, and, once all applications using the database have successfully called DB->close, atomically replace the original database with the updated copy.

When multiple threads are using the Berkeley DB handle concurrently, only a single thread may call the DB->close function.

Once DB->close has been called, regardless of its return, the Berkeley DB handle may not be used again.

The DB->close function returns the value of errno on failure, and 0 on success.

# Errors

If a fatal error occurs in Berkeley DB, the DB->close function may fail and return DB_RUNRECOVERY, at which point all subsequent database calls will also return DB_RUNRECOVERY.

The DB->close function may fail and return errno for any of the errors specified for the following Berkeley DB and C library functions: DB->sync, DBcursor->c_close(3), dbc->c_am_destroy(3), dbm_close, dbp->am_close(3), fflush(3), fprintf(3), free(3), log_unregister, memp_close, memp_fclose, memp_fsync, memset(3), vfprintf(3), and vsnprintf(3).

# See Also

db_appexit, db_appinit, db_version, DB->close, DB->cursor, DB->del, DB->fd, DB->get, DB->join, db_open, DB->put, DB->stat, DB->sync, DBcursor->c_close, DBcursor->c_del, DBcursor->c_get and DBcursor->c_put.`