Berkeley DB: Db::rename
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::rename |

`

###

    #include <db_cxx.h>

    int
    Db::rename(const char *file,
        const char *database, const char *newname, u_int32_t flags);

# Description

The Db::rename method renames the database specified by the file and database arguments to newname. If no database is specified, the underlying file represented by file is renamed, incidentally renaming all databases that it contained.

Applications should not rename databases that are currently in use. If an underlying file is being renamed and logging is currently enabled in the database environment, no database in the file may be open when the Db::rename method is called. In particular, some architectures do not permit renaming files with open handles. On these architectures, attempts to rename databases that are currently in use by any thread of control in the system will fail.

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

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

The Db::rename 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.

# Environment Variables

DB_HOME
  If a dbenv argument to db_create was specified, the environment variable DB_HOME may be used as the path of the database environment home.

  Db::rename is affected by any database directory specified using the DbEnv::set_data_dir method, or by setting the "set_data_dir" string in the environment's DB_CONFIG file.

# Errors

The Db::rename method may fail and throw an exception or return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

  A database in the file is currently open.

  Called after Db::open was called.

If the file or directory does not exist, the Db::rename method will fail and and either return ENOENT or throw a FileNotFoundException exception.

The Db::rename method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. If a catastrophic error has occurred, the Db::rename method may fail and either return DB_RUNRECOVERY or 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