Viewing file:  db_rename.html (4.88 KB) -rw-r--r--
Select action/file-type:
 (+) | (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
Berkeley DB: DB->rename
DB->rename
|
 |
#include <db.h>
int
DB->rename(DB *db, const char *file,
const char *database, const char *newname, u_int32_t flags);
Description: DB->rename
The DB->rename method renames the database specified by the
file and database parameters to newname. If no
database is specified, the underlying file represented by
file is renamed, incidentally renaming all of the databases 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 may fail.
The DB->rename method should not be called if the rename is intended
to be transactionally safe; the DB_ENV->dbrename method should be used
instead.
The DB->rename method may not be called after calling the
DB->open method on any DB handle. If the DB->open method
has already been called on a DB handle, close the existing
handle and create a new one before calling DB->rename.
The DB handle may not be accessed again after DB->rename is
called, regardless of its return.
The DB->rename method
returns a non-zero error value on failure
and 0 on success.
Parameters
- database
- The database parameter is the database to be renamed.
- file
- The file parameter is the physical file which contains the
database(s) to be renamed.
On Windows, the file argument will be interpreted as a UTF-8
string, which is equivalent to ASCII for Latin characters.
- flags
- The flags parameter is currently unused, and must be set to 0.
- newname
- The newname parameter is the new name of the database or file.
Environment Variables
If the database was opened within a database environment, 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 DB_ENV->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 return one of the following non-zero errors:
- EINVAL
- If DB->rename called after DB->open was called; or if an
invalid flag value or parameter was specified.
- ENOENT
- The file or directory does not exist.
Class
DB
See Also
Databases and Related Methods
Copyright (c) 1996-2004 Sleepycat Software, Inc. - All rights reserved.
|