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 |

`

###

    import com.sleepycat.db.*;
    import java.io.FileNotFoundException;

    public void rename(String file, String database, String newname, int flags)
    	throws DbException, FileNotFoundException;

# Description

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

After Db.rename has been called, regardless of its return, the Db handle may not be accessed again.

The Db.rename method throws an exception that encapsulates a non-zero error value on failure.

# 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.rename is affected by the configuration value DB_DATA_DIR.

# Errors

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

EINVAL
  A database in the file is currently open.

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

The Db.rename method may fail and throw an exception 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 throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

# Class

Db

# See Also

Db.associate, Db.close, Db.cursor, Db.del, Db.fd, Db.get, Db.pget, Db.get_byteswapped, Db.get_type, Db.join, Db.key_range, Db.open, Db.put, Db.remove, Db.rename, Db.set_append_recno, Db.set_bt_minkey, Db.set_cachesize, Db.set_errcall, Db.set_errpfx, Db.set_feedback, Db.set_flags, Db.set_h_ffactor, Db.set_h_nelem, Db.set_lorder, Db.set_pagesize, Db.set_q_extentsize, Db.set_re_delim, Db.set_re_len, Db.set_re_pad, Db.set_re_source, Db.stat, Db.sync, Db.truncate, Db.upgrade, and Db.verify.`

Copyright Sleepycat Software