Berkeley DB: DB->remove
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->remove |

`

###

    #include <db.h>

    int
    DB->remove(DB *db,
    	const char *file, const char *database, u_int32_t flags);

# Description

The DB->remove interface removes the database specified by the file and database arguments. If no database is specified, the physical file represented by file is removed, incidentally removing all databases that it contained.

If a physical file is being removed and logging is currently enabled in the database environment, no database in the file may be open when the DB->remove function is called. Otherwise, no reference count of database use is maintained by Berkeley DB. Applications should not remove databases that are currently in use. In particular, some architectures do not permit the removal of files with open handles. On these architectures, attempts to remove databases that are currently in use will fail.

The flags parameter is currently unused, and must be set to 0.

Once DB->remove has been called, regardless of its return, the DB handle may not be accessed again.

The DB->remove function returns a non-zero error value on failure and 0 on success.

# Environment Variables

DB_HOME
  If the dbenv argument to db_create was initialized using DBENV->open the environment variable DB_HOME may be used as the path of the database environment home. Specifically, DB->remove is affected by the configuration value DB_DATA_DIR.

# Errors

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

EINVAL
  A database in the file is currently open.

The DB->remove function 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->remove function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

# See Also

db_create, DB->close, DB->cursor, DB->del, DB->err, DB->fd, DB->get, DB->get_byteswapped, DB->get_type, DB->join, DB->key_range, DB->open, DB->put, DB->remove, DB->set_bt_compare, DB->set_bt_minkey, DB->set_bt_prefix, DB->set_cachesize, DB->set_dup_compare, DB->set_errcall, DB->set_errfile, DB->set_errpfx, DB->set_flags, DB->set_h_ffactor, DB->set_h_hash, DB->set_h_nelem, DB->set_lorder, DB->set_malloc, DB->set_pagesize, DB->set_paniccall, DB->set_q_extentsize, DB->set_realloc, DB->set_re_delim, DB->set_re_len, DB->set_re_pad, DB->set_re_source, DB->stat, DB->sync, DB->upgrade and DB->verify.`

Copyright Sleepycat Software