-Environment (Oracle - Berkeley DB Java API) -

java.lang.Object
+
- com.sleepycat.db.Environment
+

+
+
+
```
public class Environment
+extends java.lang.Object
```
+
A database environment. Environments include support for some or all of caching, locking, logging and transactions.
To open an existing environment with default attributes the application @@ -132,7 +130,7 @@ customize the configuration class. For example: Environment newlyCreatedEnv = new Environment(home, envConfig);
-Environment handles are free-threaded unless EnvironmentConfig.setThreaded is called to disable this before the environment is opened. +Environment handles are free-threaded unless EnvironmentConfig.setThreaded is called to disable this before the environment is opened.
An environment handle is an Environment instance. More than one Environment instance may be created for the same physical directory, @@ -141,786 +139,749 @@ be open at one time for a given environment.
The Environment handle should not be closed while any other handle remains open that is using it as a reference (for example, -Database or Transaction. Once Environment.close +Database or Transaction. Once Environment.close is called, this object may not be accessed again, regardless of -whether or not it throws an exception. -
- -
-
- -
+whether or not it throws an exception.
+

- - - - - - - - - - -

-Field Summary
-`static int`	`EID_MASTER` - - - A special identifier for eid in - `Environment.openChannel` - to create channel to send messages only to the master site.

- +

+ + +
Field Summary
+ + + + + + + + + + +
Fields
Modifier and Type Field and Description
static int EID_MASTER +
A special identifier for eid in + Environment.openChannel + to create channel to send messages only to the master site.
+
+

Fields
Modifier and Type	Field and Description
`static int`	`EID_MASTER` + A special identifier for eid in + `Environment.openChannel` + to create channel to send messages only to the master site. +

- - - - - - - - - -

-Constructor Summary
`Environment(File home, - EnvironmentConfig config)` - - - Create a database environment handle.

- +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
Environment(java.io.File home, + EnvironmentConfig config) +
Create a database environment handle.
+
+

Constructors
Constructor and Description
`Environment(java.io.File home, + EnvironmentConfig config)` + Create a database environment handle. +

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

-Method Summary

- void backup(String target, - BackupOptions opt) - -
- Perform a hot back up of the open environment.

- void backupDatabase(String dbfile, - String target, - boolean exclusiveCreate) - -
- Perform a hot back up of a single database file contained within the environment.

- Transaction beginCDSGroup() - -
- Allocate a locker ID in an environment configured for Berkeley DB - Concurrent Data Store applications.

- Transaction beginTransaction(Transaction parent, - TransactionConfig config) - -
- Create a new transaction in the database environment.

- void checkpoint(CheckpointConfig config) - -
- Synchronously checkpoint the database environment.

- void close() - -
- Close the database environment, freeing any allocated resources and - closing any underlying subsystems.

- void closeForceSync() - -
- Close the database environment, freeing any allocated resources and - closing any underlying subsystems.

- int createLockerID() - -
- Allocate a locker ID.

- int detectDeadlocks(LockDetectMode mode) - -
- Run one iteration of the deadlock detector.

- void electReplicationMaster(int nsites, - int nvotes) - -
- Hold an election for the master of a replication group.

- void flushReplication() - -
- Internal method: re-push the last log record to all clients, in case they've - lost messages and don't know it.

- void freeLockerID(int id) - -
- Free a locker ID.

- File[] getArchiveDatabases() - -
- Return the database files that need to be archived in order to recover the - database from catastrophic failure.

- File[] getArchiveLogFiles(boolean includeInUse) - -
- Return an array of log files.

- CacheFileStats[] getCacheFileStats(StatsConfig config) - -
- Return statistics for individual files in the cache.

- CacheStats getCacheStats(StatsConfig config) - -
- Returns the memory pool (that is, the buffer cache) subsystem statistics.

- EnvironmentConfig getConfig() - -
- Return this object's configuration.

- File getHome() - -
- Return the database environment home directory.

- Lock getLock(int locker, - boolean noWait, - DatabaseEntry object, - LockRequestMode mode) - -
- Acquire a lock from the lock table returning information about it in the Lock parameter.

- int getLockerPriority(int id) - -
- Return the deadlock priority for the given locker.

- LockStats getLockStats(StatsConfig config) - -
- Return the database environment's locking statistics.

- String getLogFileName(LogSequenceNumber lsn) - -
- Return the name of the log file that contains the log record - specified by a LogSequenceNumber object.

- LogStats getLogStats(StatsConfig config) - -
- Return the database environment's logging statistics.

- MutexStats getMutexStats(StatsConfig config) - -
- Return the database environment's mutex statistics.

- boolean getReplicationConfig(ReplicationConfig config) - -
- Get the configuration of the replication subsystem.

- ReplicationManagerSite getReplicationManagerLocalSite() - -
- Return a handle for the local replication site.

- ReplicationManagerSite getReplicationManagerSite(int eid) - -
- Return a site known to the replication manager by its eid.

- ReplicationManagerSite getReplicationManagerSite(String host, - long port) - -
- Return a site in the replication manager by its host and port.

- ReplicationManagerSiteInfo[] getReplicationManagerSiteList() - -
- Return an array of all the sites known to the replication manager.

- ReplicationManagerStats getReplicationManagerStats(StatsConfig config) - -
- Return the database environment's replication manager statistics.

- int getReplicationNumSites() - -
- Get the number of sites in a replication group.

- ReplicationStats getReplicationStats(StatsConfig config) - -
- Return the database environment's replication statistics.

- int getReplicationTimeout(ReplicationTimeoutType type) - -
- Gets the timeout applied to the specified timeout type.

- TransactionStats getTransactionStats(StatsConfig config) - -
- Return the database environment's transactional statistics.

-static int getVersionFamily() - -
- Return the release's Oracle family number.

-static String getVersionFullString() - -
- Return the full release version information, suitable for display.

-static int getVersionMajor() - -
- Return the release major number.

-static int getVersionMinor() - -
- Return the release minor number.

-static int getVersionPatch() - -
- Return the release patch number.

-static int getVersionRelease() - -
- Return the release's Oracle release number.

-static String getVersionString() - -
- Return the release version information, suitable for display.

- TransactionStatus isTransactionApplied(byte[] token, - int maxwait) - -
- Return whether the transaction referred to by the commit token "token" has -been applied at the local replication environment.

- void lockVector(int locker, - boolean noWait, - LockRequest[] list) - -
- Atomically obtain and release one or more locks from the lock table.

- void logFlush(LogSequenceNumber lsn) - -
- Flush log records to stable storage.

- void logPrint(Transaction txn, - String message) - -
- Append an informational message to the Berkeley DB database environment log files.

- LogSequenceNumber logPut(DatabaseEntry data, - boolean flush) - -
- Append a record to the log.

- int logVerify(LogVerifyConfig config) - -
- Verify integrity of the log records of an environment and write both error and - normal messages to the environment's error report destination.

- ReplicationChannel openChannel(int eid) - -
- Create a channel.

- Database openDatabase(Transaction txn, - String fileName, - String databaseName, - DatabaseConfig config) - -
- Open a database.

- LogCursor openLogCursor() - -
- Return a log cursor.

- SecondaryDatabase openSecondaryDatabase(Transaction txn, - String fileName, - String databaseName, - Database primaryDatabase, - SecondaryConfig config) - -
- Open a database.

- void panic(boolean onoff) - -
- Set the panic state for the database environment.

- ReplicationStatus processReplicationMessage(DatabaseEntry control, - DatabaseEntry rec, - int envid) - -
- Process an incoming replication message sent by a member of the - replication group to the local database environment.

- void putLock(Lock lock) - -
- Release a lock.

- PreparedTransaction[]

recover(int count,
-        boolean continued)

- -
- Environment recovery restores transactions that were prepared, but not yet +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Methods
Modifier and Type	Method and Description
`void`	`backup(java.lang.String target, + BackupOptions opt)` + Perform a hot back up of the open environment. +
`void`	`backupDatabase(java.lang.String dbfile, + java.lang.String target, + boolean exclusiveCreate)` + Perform a hot back up of a single database file contained within the environment. +
`Transaction`	`beginCDSGroup()` + Allocate a locker ID in an environment configured for Berkeley DB + Concurrent Data Store applications. +
`Transaction`	`beginTransaction(Transaction parent, + TransactionConfig config)` + Create a new transaction in the database environment. +
`void`	`checkpoint(CheckpointConfig config)` + Synchronously checkpoint the database environment. +
`void`	`close()` + Close the database environment, freeing any allocated resources and + closing any underlying subsystems. +
`void`	`closeForceSync()` + Close the database environment, freeing any allocated resources and + closing any underlying subsystems. +
`void`	`closeForceSyncAndForceSyncEnv()` + Close the database environment, freeing any allocated resources and + closing any underlying subsystems. +
`void`	`closeForceSyncEnv()` + Close the database environment, freeing any allocated resources and + closing any underlying subsystems. +
`int`	`createLockerID()` + Allocate a locker ID. +
`int`	`detectDeadlocks(LockDetectMode mode)` + Run one iteration of the deadlock detector. +
`void`	`electReplicationMaster(int nsites, + int nvotes)` + Hold an election for the master of a replication group. +
`void`	`flushReplication()` + Internal method: re-push the last log record to all clients, in case they've + lost messages and don't know it. +
`void`	`freeLockerID(int id)` + Free a locker ID. +
`java.io.File[]`	`getArchiveDatabases()` + Return the database files that need to be archived in order to recover the + database from catastrophic failure. +
`java.io.File[]`	`getArchiveLogFiles(boolean includeInUse)` + Return an array of log files. +
`CacheFileStats[]`	`getCacheFileStats(StatsConfig config)` + Return statistics for individual files in the cache. +
`CacheStats`	`getCacheStats(StatsConfig config)` + Returns the memory pool (that is, the buffer cache) subsystem statistics. +
`EnvironmentConfig`	`getConfig()` + Return this object's configuration. +
`java.io.File`	`getHome()` + Return the database environment home directory. +
`Lock`	`getLock(int locker, + boolean noWait, + DatabaseEntry object, + LockRequestMode mode)` + Acquire a lock from the lock table returning information about it in the Lock parameter. +
`int`	`getLockerPriority(int id)` + Return the deadlock priority for the given locker. +
`LockStats`	`getLockStats(StatsConfig config)` + Return the database environment's locking statistics. +
`java.lang.String`	`getLogFileName(LogSequenceNumber lsn)` + Return the name of the log file that contains the log record + specified by a LogSequenceNumber object. +
`LogStats`	`getLogStats(StatsConfig config)` + Return the database environment's logging statistics. +
`MutexStats`	`getMutexStats(StatsConfig config)` + Return the database environment's mutex statistics. +
`boolean`	`getReplicationConfig(ReplicationConfig config)` + Get the configuration of the replication subsystem. +
`ReplicationManagerSite`	`getReplicationManagerLocalSite()` + Return a handle for the local replication site. +
`ReplicationManagerSite`	`getReplicationManagerSite(int eid)` + Return a site known to the replication manager by its eid. +
`ReplicationManagerSite`	`getReplicationManagerSite(java.lang.String host, + long port)` + Return a site in the replication manager by its host and port. +
`ReplicationManagerSiteInfo[]`	`getReplicationManagerSiteList()` + Return an array of all the sites known to the replication manager. +
`ReplicationManagerStats`	`getReplicationManagerStats(StatsConfig config)` + Return the database environment's replication manager statistics. +
`int`	`getReplicationNumSites()` + Get the number of sites in a replication group. +
`ReplicationStats`	`getReplicationStats(StatsConfig config)` + Return the database environment's replication statistics. +
`int`	`getReplicationTimeout(ReplicationTimeoutType type)` + Gets the timeout applied to the specified timeout type. +
`TransactionStats`	`getTransactionStats(StatsConfig config)` + Return the database environment's transactional statistics. +
`static int`	`getVersionFamily()` + Return the release's Oracle family number. +
`static java.lang.String`	`getVersionFullString()` + Return the full release version information, suitable for display. +
`static int`	`getVersionMajor()` + Return the release major number. +
`static int`	`getVersionMinor()` + Return the release minor number. +
`static int`	`getVersionPatch()` + Return the release patch number. +
`static int`	`getVersionRelease()` + Return the release's Oracle release number. +
`static java.lang.String`	`getVersionString()` + Return the release version information, suitable for display. +
`TransactionStatus`	`isTransactionApplied(byte[] token, + int maxwait)` + Return whether the transaction referred to by the commit token "token" has +been applied at the local replication environment. +
`void`	`lockVector(int locker, + boolean noWait, + LockRequest[] list)` + Atomically obtain and release one or more locks from the lock table. +
`void`	`logFlush(LogSequenceNumber lsn)` + Flush log records to stable storage. +
`void`	`logPrint(Transaction txn, + java.lang.String message)` + Append an informational message to the Berkeley DB database environment log files. +
`LogSequenceNumber`	`logPut(DatabaseEntry data, + boolean flush)` + Append a record to the log. +
`int`	`logVerify(LogVerifyConfig config)` + Verify integrity of the log records of an environment and write both error and + normal messages to the environment's error report destination. +
`ReplicationChannel`	`openChannel(int eid)` + Create a channel. +
`Database`	`openDatabase(Transaction txn, + java.lang.String fileName, + java.lang.String databaseName, + DatabaseConfig config)` + Open a database. +
`LogCursor`	`openLogCursor()` + Return a log cursor. +
`SecondaryDatabase`	`openSecondaryDatabase(Transaction txn, + java.lang.String fileName, + java.lang.String databaseName, + Database primaryDatabase, + SecondaryConfig config)` + Open a database. +
`void`	`panic(boolean onoff)` + Set the panic state for the database environment. +
`int`	`printLockStats(StatsConfig config)` + Print the locking subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). +
`int`	`printLogStats(StatsConfig config)` + Print the logging subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). +
`int`	`printMempStats(StatsConfig config)` + Print the cache subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). +
`int`	`printMutexStats(StatsConfig config)` + Print the mutex subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). +
`int`	`printReplicationManagerStats(StatsConfig config)` + Print the Replication Manager subsystem statistical information to a + specified output channel (see the setMsgfile() method for more + information), or passed to an application callback function (see the + setMsgcall() method for more information). +
`int`	`printReplicationStats(StatsConfig config)` + Print the replication subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). +
`int`	`printStats(StatsConfig config)` + Print environment statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). +
`int`	`printTransactionStats(StatsConfig config)` + Print the transaction subsystem statistical information to a specified + output channel (see the setMsgfile() method for more information), or + passed to an application callback function (see the setMsgcall() method + for more information). +
`ReplicationStatus`	`processReplicationMessage(DatabaseEntry control, + DatabaseEntry rec, + int envid)` + Process an incoming replication message sent by a member of the + replication group to the local database environment. +
`void`	`putLock(Lock lock)` + Release a lock. +
`PreparedTransaction[]`	`recover(int count, + boolean continued)` + Environment recovery restores transactions that were prepared, but not yet resolved at the time of the system shut down or crash, to their state prior - to the shut down or crash, including any locks previously held.
-`static void`	`remove(File home, - boolean force, - EnvironmentConfig config)` - - - Destroy a database environment.
- `void`	`removeDatabase(Transaction txn, - String fileName, - String databaseName)` - - - -Remove the database specified by the fileName and databaseName parameters.
- `void`	`removeOldLogFiles()` - - - Remove log files that are no longer needed.
- `void`	`renameDatabase(Transaction txn, - String fileName, - String databaseName, - String newName)` - - - -Rename a database.
- `void`	`replicationManagerStart(int nthreads, - ReplicationManagerStartPolicy policy)` - - - Starts the replication manager.
- `void`	`resetFileID(String filename, - boolean encrypted)` - - - Allows database files to be copied, and then the copy used in the same - database environment as the original.
- `void`	`resetLogSequenceNumber(String filename, - boolean encrypted)` - - - Allows database files to be moved from one transactional database - environment to another.
- `void`	`setConfig(EnvironmentConfig config)` - - - Change the settings in an existing environment handle.
- `void`	`setLockerPriority(int id, - int priority)` - - - Assign a deadlock priority to a locker.
- `void`	`setReplicationConfig(ReplicationConfig config, - boolean onoff)` - - - Configure the replication subsystem.
- `void`	`setReplicationManagerMessageDispatch(ReplicationManagerMessageDispatch dispatch, - int flags)` - - - Set the message dispatch function.
- `void`	`setReplicationTimeout(ReplicationTimeoutType type, - int replicationTimeout)` - - - Sets the timeout applied to the specified timeout type.
- `void`	`startReplication(DatabaseEntry cdata, - boolean master)` - - - Configure the database environment as a client or master in a group - of replicated database environments.
- `void`	`syncCache(LogSequenceNumber logSequenceNumber)` - - - Ensure that all modified pages in the cache are flushed to their backing files.
- `void`	`syncReplication()` - - - Forces master synchronization to begin for this client.
- `int`	`trickleCacheWrite(int percent)` - - - Ensure that a specified percent of the pages in the shared memory - pool are clean, by writing dirty pages to their backing files.

- - - - - - - - -

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- -

- + to the shut down or crash, including any locks previously held. +

static void

remove(java.io.File home,
+      boolean force,
+      EnvironmentConfig config)

Destroy a database environment.

void

removeDatabase(Transaction txn,
+              java.lang.String fileName,
+              java.lang.String databaseName)

+Remove the database specified by the fileName and databaseName parameters.

void

removeOldLogFiles() +

Remove log files that are no longer needed.

void

renameDatabase(Transaction txn,
+              java.lang.String fileName,
+              java.lang.String databaseName,
+              java.lang.String newName)

+Rename a database.

void

replicationManagerStart(int nthreads,
+                       ReplicationManagerStartPolicy policy)

Starts the replication manager.

void

resetFileID(java.lang.String filename,
+           boolean encrypted)

Allows database files to be copied, and then the copy used in the same + database environment as the original.

void

resetLogSequenceNumber(java.lang.String filename,
+                      boolean encrypted)

Allows database files to be moved from one transactional database + environment to another.

void

setBlobThreshold(int value) +

Set the blob threshold size.

void

setConfig(EnvironmentConfig config) +

Change the settings in an existing environment handle.

void

setLockerPriority(int id,
+                 int priority)

Assign a deadlock priority to a locker.

void

setMsgfile(java.io.File file) +

Sets the path of a file to store statistical information.

void

setReplicationConfig(ReplicationConfig config,
+                    boolean onoff)

Configure the replication subsystem.

void

setReplicationManagerMessageDispatch(ReplicationManagerMessageDispatch dispatch,
+                                    int flags)

Set the message dispatch function.

void

setReplicationTimeout(ReplicationTimeoutType type,
+                     int replicationTimeout)

Sets the timeout applied to the specified timeout type.

void

startReplication(DatabaseEntry cdata,
+                boolean master)

Configure the database environment as a client or master in a group + of replicated database environments.

void

syncCache(LogSequenceNumber logSequenceNumber) +

Ensure that all modified pages in the cache are flushed to their backing files.

void

syncReplication() +

Forces master synchronization to begin for this client.

int

trickleCacheWrite(int percent) +

Ensure that a specified percent of the pages in the shared memory + pool are clean, by writing dirty pages to their backing files.

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ + +

- - - - - - -
-Field Detail
- -
-EID_MASTER
-
```
-public static final int EID_MASTER
```
-
-
A special identifier for eid in - Environment.openChannel - to create channel to send messages only to the master site. -
-
-
See Also:
Constant Field Values
-
- +
- + + +
  Field Detail
  + + + +
  - +
    EID_MASTER
    +
```
public static final int EID_MASTER
```
    +
    A special identifier for eid in + Environment.openChannel + to create channel to send messages only to the master site.
    +
    See Also:
    Constant Field Values
    +
  +
- - - - - - -
-Constructor Detail
- -
-Environment
-
```
-public Environment(File home,
-                   EnvironmentConfig config)
-            throws DatabaseException,
-                   FileNotFoundException
```
-
-
Create a database environment handle. -
-
-
-
Parameters:
home - The database environment's home directory. +
+
+ + +
Constructor Detail
+ + + +
+
+
Environment
+
public Environment(java.io.File home, + EnvironmentConfig config) + throws DatabaseException, + java.io.FileNotFoundException
+
Create a database environment handle. +
+
Parameters:
home - The database environment's home directory. The environment variable DB_HOME may be used as the path of the database home. For more information on envHome and filename resolution in general, see File Naming. -
config - The database environment attributes. If null, default attributes are used. -
-
-
Throws: -
IllegalArgumentException - if an invalid parameter was specified. -
-
-
DatabaseException - if a failure occurs. -
FileNotFoundException
-
- +
config - The database environment attributes. If null, default attributes are used. +
+
+
Throws:
+
java.lang.IllegalArgumentException - if an invalid parameter was specified. +
+
+
DatabaseException - if a failure occurs.
+
java.io.FileNotFoundException
+

+ + - - - - - - -

-Method Detail

- -

-close

-public void close()
-           throws DatabaseException

Close the database environment, freeing any allocated resources and +

+ + +
Method Detail
+ + + +
- +
  close
  +
```
public void close()
+           throws DatabaseException
```
  +
  Close the database environment, freeing any allocated resources and closing any underlying subsystems.
  When you call this method, all open database and cursor handles are closed automatically, and should not be reused.
  - The Environment handle should not be closed while any other + The Environment handle should not be closed while any other handle that refers to it is not yet closed; for example, database environment handles must not be closed while transactions in the environment have not yet been committed or aborted. Specifically, this includes -Transaction, and LogCursor +Transaction, and LogCursor handles.
  In multiple threads of control, each thread of control opens a database environment and the database handles within it. When you close each database handle using this method, by default, the database is not synchronized. To synchronize all open databases ensure that the last environment @@ -950,49 +911,77 @@ public void close() method.
  After this method has been called, regardless of its return, the - Environment handle may not be accessed again. -
  -
  -
  -
  - -
  Throws: -
  DatabaseException - if a failure occurs.
  -
  -

- -

-closeForceSync

-public void closeForceSync()
-                    throws DatabaseException

Close the database environment, freeing any allocated resources and + Environment handle may not be accessed again. +

Throws:: DatabaseException - if a failure occurs.

+ + + + + +

+
closeForceSync
+
```
public void closeForceSync()
+                    throws DatabaseException
```
+
Close the database environment, freeing any allocated resources and + closing any underlying subsystems. +
+ This function is similar to Environment.close(), except that + each open database is synchronized as it is closed.
+
Throws:
+
DatabaseException
+

+ + + +

+
closeForceSyncEnv
+
```
public void closeForceSyncEnv()
+                       throws DatabaseException
```
+
Close the database environment, freeing any allocated resources and + closing any underlying subsystems. +
+ This function is similar to Environment.close(), except that + all memory mapped environment regions are synchronized as the + environment is closed.
+
Throws:
+
DatabaseException
+

+ + + +

+
closeForceSyncAndForceSyncEnv
+
```
public void closeForceSyncAndForceSyncEnv()
+                                   throws DatabaseException
```
+
Close the database environment, freeing any allocated resources and closing any underlying subsystems.
- This function has verify similar - behavior as Environment.close(), except the following: - When each open database handle is closed, the database is synchronized. -
-
- -
Throws: -
DatabaseException
-
- -
- -
-remove
-
```
-public static void remove(File home,
-                          boolean force,
-                          EnvironmentConfig config)
-                   throws DatabaseException,
-                          FileNotFoundException
```
-
-
Destroy a database environment. + This function is similar to Environment.close(), except that + it has the effect of both closeForceSync() and closeForceSyncEnv().
+
Throws:
+
DatabaseException
+

+ + + +

+
remove
+
```
public static void remove(java.io.File home,
+          boolean force,
+          EnvironmentConfig config)
+                   throws DatabaseException,
+                          java.io.FileNotFoundException
```
+
Destroy a database environment.
If the environment is not in use, the environment regions, including any backing files, are removed. Any log or database files and the @@ -1033,80 +1022,73 @@ public static void remove(Environment handle may not be + Environment handle may not be accessed again. -
-
-
-
Parameters:
home - The database environment to be removed. +
+
Parameters:
home - The database environment to be removed. On Windows platforms, this argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters. -
force - The environment is removed, regardless of any processes that may +
force - The environment is removed, regardless of any processes that may still using it, and no locks are acquired during this process. (Generally, the force argument is specified only when applications were unable to shut down cleanly, and there is a risk that an application may have died holding a Berkeley DB mutex or lock.
-
-
Throws: -
DatabaseException - if a failure occurs. -
FileNotFoundException
- - -
- -
-setConfig
-
```
-public void setConfig(EnvironmentConfig config)
-               throws DatabaseException
```
-
-
Change the settings in an existing environment handle. -
-
-
-
Parameters:
config - The database environment attributes. If null, default attributes are used. -
-
-
Throws: -
IllegalArgumentException - if an invalid parameter was specified. -
-
DatabaseException - if a failure occurs.
-
-
-
- -
-getConfig
-
```
-public EnvironmentConfig getConfig()
-                            throws DatabaseException
```
-
-
Return this object's configuration. -
-
-
- -
Returns:
This object's configuration. -
-
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-openDatabase
-
```
-public Database openDatabase(Transaction txn,
-                             String fileName,
-                             String databaseName,
-                             DatabaseConfig config)
-                      throws DatabaseException,
-                             FileNotFoundException
```
-
-
Open a database. +
+
Throws:
+
DatabaseException - if a failure occurs.
+
java.io.FileNotFoundException
+

+ + + +

+
setConfig
+
```
public void setConfig(EnvironmentConfig config)
+               throws DatabaseException
```
+
Change the settings in an existing environment handle. +
+
Parameters:
config - The database environment attributes. If null, default attributes are used. +
+
+
Throws:
+
java.lang.IllegalArgumentException - if an invalid parameter was specified. +
+
DatabaseException - if a failure occurs.
+

+ + + +

+
getConfig
+
```
public EnvironmentConfig getConfig()
+                            throws DatabaseException
```
+
Return this object's configuration. +
+
Returns:
This object's configuration. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
openDatabase
+
```
public Database openDatabase(Transaction txn,
+                    java.lang.String fileName,
+                    java.lang.String databaseName,
+                    DatabaseConfig config)
+                      throws DatabaseException,
+                             java.io.FileNotFoundException
```
+
Open a database.
The database is represented by the file and database parameters.
@@ -1119,7 +1101,7 @@ record number. The Recno format supports fixed- or variable-length records, accessed sequentially or by logical record number, and optionally backed by a flat text file.
-Storage and retrieval are based on key/data pairs; see DatabaseEntry +Storage and retrieval are based on key/data pairs; see DatabaseEntry for more information.
Opening a database is a relatively expensive operation, and maintaining @@ -1132,45 +1114,43 @@ null. Note that in-memory databases can only ever be shared by sharing the single database handle that created them, in circumstances where doing so is safe. The environment variable TMPDIR may be used as a directory in which to create temporary backing files. -
-
-
-
Parameters:
txn - For a transactional database, an explicit transaction may be specified, or null +
+
Parameters:
txn - For a transactional database, an explicit transaction may be specified, or null may be specified to use auto-commit. For a non-transactional database, null must be specified. Note that transactionally protected operations on a Database handle require that the Database handle itself be transactionally protected during its open, either with a non-null transaction handle, or by calling -DatabaseConfig.setTransactional on the configuration object. -
fileName - The name of an underlying file that will be used to back the database. +DatabaseConfig.setTransactional on the configuration object. +
fileName - The name of an underlying file that will be used to back the database. On Windows platforms, this argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters. -
databaseName - An optional parameter that allows applications to have multiple +
databaseName - An optional parameter that allows applications to have multiple databases in a single file. Although no databaseName parameter needs to be specified, it is an error to attempt to open a second database in a physical file that was not initially created using a databaseName parameter. Further, the databaseName parameter is not supported by the Queue format. -
config - The database open attributes. If null, default attributes are used. -
Throws: -
DatabaseException -
FileNotFoundException
- - -
- -
-openSecondaryDatabase
-
```
-public SecondaryDatabase openSecondaryDatabase(Transaction txn,
-                                               String fileName,
-                                               String databaseName,
-                                               Database primaryDatabase,
-                                               SecondaryConfig config)
-                                        throws DatabaseException,
-                                               FileNotFoundException
```
-
-
Open a database. +
config - The database open attributes. If null, default attributes are used.
+
Throws:
+
DatabaseException
+
java.io.FileNotFoundException
+

+ + + +

+
openSecondaryDatabase
+
```
public SecondaryDatabase openSecondaryDatabase(Transaction txn,
+                                      java.lang.String fileName,
+                                      java.lang.String databaseName,
+                                      Database primaryDatabase,
+                                      SecondaryConfig config)
+                                        throws DatabaseException,
+                                               java.io.FileNotFoundException
```
+
Open a database.
The database is represented by the file and database parameters.
@@ -1183,7 +1163,7 @@ record number. The Recno format supports fixed- or variable-length records, accessed sequentially or by logical record number, and optionally backed by a flat text file.
-Storage and retrieval are based on key/data pairs; see DatabaseEntry +Storage and retrieval are based on key/data pairs; see DatabaseEntry for more information.
Opening a database is a relatively expensive operation, and maintaining @@ -1196,49 +1176,47 @@ null. Note that in-memory databases can only ever be shared by sharing the single database handle that created them, in circumstances where doing so is safe. The environment variable TMPDIR may be used as a directory in which to create temporary backing files. -
-
-
-
Parameters:
txn - For a transactional database, an explicit transaction may be specified, or null +
+
Parameters:
txn - For a transactional database, an explicit transaction may be specified, or null may be specified to use auto-commit. For a non-transactional database, null must be specified. Note that transactionally protected operations on a Database handle require that the Database handle itself be transactionally protected during its open, either with a non-null transaction handle, or by calling -DatabaseConfig.setTransactional on the configuration object. -
fileName - The name of an underlying file that will be used to back the database. +DatabaseConfig.setTransactional on the configuration object. +
fileName - The name of an underlying file that will be used to back the database. On Windows platforms, this argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters. -
databaseName - An optional parameter that allows applications to have multiple +
databaseName - An optional parameter that allows applications to have multiple databases in a single file. Although no databaseName parameter needs to be specified, it is an error to attempt to open a second database in a physical file that was not initially created using a databaseName parameter. Further, the databaseName parameter is not supported by the Queue format. -
primaryDatabase - a database handle for the primary database that is to be indexed. -
config - The secondary database open attributes. If null, default attributes are used. -
Throws: -
DatabaseException -
FileNotFoundException
- - -
- -
-removeDatabase
-
```
-public void removeDatabase(Transaction txn,
-                           String fileName,
-                           String databaseName)
-                    throws DatabaseException,
-                           FileNotFoundException
```
-
-
+
primaryDatabase - a database handle for the primary database that is to be indexed. +
config - The secondary database open attributes. If null, default attributes are used.
+
Throws:
+
DatabaseException
+
java.io.FileNotFoundException
+

+ + + +

+
removeDatabase
+
```
public void removeDatabase(Transaction txn,
+                  java.lang.String fileName,
+                  java.lang.String databaseName)
+                    throws DatabaseException,
+                           java.io.FileNotFoundException
```
+
Remove the database specified by the fileName and databaseName parameters.
If no database is specified, the underlying file specified is removed, incidentally removing all of the databases it contained.
-Applications should never remove databases with open Database +Applications should never remove databases with open Database handles, or in the case of removing a file, when any database in the file has an open handle. For example, some architectures do not permit the removal of files with open system handles. On these architectures, @@ -1250,50 +1228,48 @@ environment variable DB_HOME may be used as the path of the database environment home.
This method is affected by any database directory specified with -EnvironmentConfig.addDataDir, or by setting the "set_data_dir" +EnvironmentConfig.addDataDir, or by setting the "set_data_dir" string in the database environment's DB_CONFIG file.
-The Database handle may not be accessed +The Database handle may not be accessed again after this method is called, regardless of this method's success or failure. -
-
-
-
Parameters:
txn - If the operation is part of an application-specified transaction, the txn +
+
Parameters:
txn - If the operation is part of an application-specified transaction, the txn parameter is a Transaction object returned from the -Environment.beginTransaction method; if the operation is part of a Berkeley DB +Environment.beginTransaction method; if the operation is part of a Berkeley DB Concurrent Data Store group, the txn parameter is a Transaction object returned -from the Environment.beginCDSGroup method; otherwise null. +from the Environment.beginCDSGroup method; otherwise null. For a transactional database, an explicit transaction may be specified, or null may be specified to use auto-commit. For a non-transactional database, null must be specified. -
fileName - The physical file which contains the database to be removed. +
fileName - The physical file which contains the database to be removed. On Windows platforms, this argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters. -
databaseName - The database to be removed. -
+
databaseName - The database to be removed.
-
Throws: -
DeadlockException - if the operation was selected to resolve a +
+
Throws:
+
DeadlockException - if the operation was selected to resolve a deadlock. -
-
DatabaseException - if a failure occurs. -
FileNotFoundException
- - -
- -
-renameDatabase
-
```
-public void renameDatabase(Transaction txn,
-                           String fileName,
-                           String databaseName,
-                           String newName)
-                    throws DatabaseException,
-                           FileNotFoundException
```
-
-
+
+
DatabaseException - if a failure occurs.
+
java.io.FileNotFoundException
+

+ + + +

+
renameDatabase
+
```
public void renameDatabase(Transaction txn,
+                  java.lang.String fileName,
+                  java.lang.String databaseName,
+                  java.lang.String newName)
+                    throws DatabaseException,
+                           java.io.FileNotFoundException
```
+
Rename a database.
If no database name is specified, the underlying file specified is @@ -1312,252 +1288,230 @@ environment variable DB_HOME may be used as the path of the database environment home.
This method is affected by any database directory specified with -EnvironmentConfig.addDataDir, or by setting the "set_data_dir" +EnvironmentConfig.addDataDir, or by setting the "set_data_dir" string in the database environment's DB_CONFIG file.
-The Database handle may not be accessed +The Database handle may not be accessed again after this method is called, regardless of this method's success or failure. -
-
-
-
Parameters:
txn - If the operation is part of an application-specified transaction, the txn +
+
Parameters:
txn - If the operation is part of an application-specified transaction, the txn parameter is a Transaction object returned from the -Environment.beginTransaction method; if the operation is part of a Berkeley DB +Environment.beginTransaction method; if the operation is part of a Berkeley DB Concurrent Data Store group, the txn parameter is a Transaction object returned -from the Environment.beginCDSGroup method; otherwise null. +from the Environment.beginCDSGroup method; otherwise null. For a transactional database, an explicit transaction may be specified, or null may be specified to use auto-commit. For a non-transactional database, null must be specified. -
fileName - The physical file which contains the database to be renamed. +
fileName - The physical file which contains the database to be renamed. On Windows platforms, this argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters. -
databaseName - The database to be renamed. -
newName - The new name of the database or file. -
+
databaseName - The database to be renamed. +
newName - The new name of the database or file.
-
Throws: -
DeadlockException - if the operation was selected to resolve a +
+
Throws:
+
DeadlockException - if the operation was selected to resolve a deadlock. -
-
DatabaseException - if a failure occurs. -
FileNotFoundException
- - -
- -
-getHome
-
```
-public File getHome()
-             throws DatabaseException
```
-
-
Return the database environment home directory. This directory is normally - identified in the Environment constructor. -
-
-
- -
Returns:
The database environment home directory. -
Throws: -
DatabaseException
-
-
-
- -
-trickleCacheWrite
-
```
-public int trickleCacheWrite(int percent)
-                      throws DatabaseException
```
-
-
Ensure that a specified percent of the pages in the shared memory +
+
DatabaseException - if a failure occurs.
+
java.io.FileNotFoundException
+

+ + + +

+
getHome
+
```
public java.io.File getHome()
+                     throws DatabaseException
```
+
Return the database environment home directory. This directory is normally + identified in the Environment constructor. +
+
Returns:
The database environment home directory.
+
Throws:
+
DatabaseException
+

+ + + +

+
trickleCacheWrite
+
```
public int trickleCacheWrite(int percent)
+                      throws DatabaseException
```
+
Ensure that a specified percent of the pages in the shared memory pool are clean, by writing dirty pages to their backing files.
The purpose of this method is to enable a memory pool manager to ensure that a page is always available for reading in new information without having to wait for a write. -
-
-
-
Parameters:
percent - The percent of the pages in the cache that should be clean. -
-
Returns:
The number of pages that were written to reach the specified +
+
Parameters:
percent - The percent of the pages in the cache that should be clean. +
+
Returns:
The number of pages that were written to reach the specified percentage.
-
-
Throws: -
DatabaseException - if a failure occurs.
- - -
- -
-detectDeadlocks
-
```
-public int detectDeadlocks(LockDetectMode mode)
-                    throws DatabaseException
```
-
-
Run one iteration of the deadlock detector. +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
detectDeadlocks
+
```
public int detectDeadlocks(LockDetectMode mode)
+                    throws DatabaseException
```
+
Run one iteration of the deadlock detector.
The deadlock detector traverses the lock table and marks one of the participating lock requesters for rejection in each deadlock it finds. -
-
-
-
Parameters:
mode - Which lock request(s) to reject. -
-
Returns:
The number of lock requests that were rejected. -
-
-
Throws: -
DatabaseException - if a failure occurs.
-
- -
- -
-getLock
-
```
-public Lock getLock(int locker,
-                    boolean noWait,
-                    DatabaseEntry object,
-                    LockRequestMode mode)
-             throws DatabaseException
```
-
-
Acquire a lock from the lock table returning information about it in the Lock parameter. -
-
-
-
Parameters:
locker - An unsigned 32-bit integer quantity representing the entity +
+
Parameters:
mode - Which lock request(s) to reject. +
+
Returns:
The number of lock requests that were rejected. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
getLock
+
```
public Lock getLock(int locker,
+           boolean noWait,
+           DatabaseEntry object,
+           LockRequestMode mode)
+             throws DatabaseException
```
+
Acquire a lock from the lock table returning information about it in the Lock parameter. +
+
Parameters:
locker - An unsigned 32-bit integer quantity representing the entity requesting the lock. -
mode - The lock mode. -
noWait - If a lock cannot be granted because the requested lock conflicts - with an existing lock, throw a LockNotGrantedException +
mode - The lock mode. +
noWait - If a lock cannot be granted because the requested lock conflicts + with an existing lock, throw a LockNotGrantedException immediately instead of waiting for the lock to become available. -
object - An untyped byte string that specifies the object to be locked. +
object - An untyped byte string that specifies the object to be locked. Applications using the locking subsystem directly while also doing locking via the Berkeley DB access methods must take care not to inadvertently lock objects that happen to be equal to the unique file IDs used to lock files.
-
-
Throws: -
DatabaseException - if a failure occurs.
- - -
- -
-putLock
-
```
-public void putLock(Lock lock)
-             throws DatabaseException
```
-
-
Release a lock. -
-
-
-
Parameters:
lock - The lock to be released. -
-
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-createLockerID
-
```
-public int createLockerID()
-                   throws DatabaseException
```
-
-
Allocate a locker ID. +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
putLock
+
```
public void putLock(Lock lock)
+             throws DatabaseException
```
+
Release a lock. +
+
Parameters:
lock - The lock to be released. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
createLockerID
+
```
public int createLockerID()
+                   throws DatabaseException
```
+
Allocate a locker ID.
The locker ID is guaranteed to be unique for the database environment.
- Call Environment.freeLockerID to return the locker ID to + Call Environment.freeLockerID to return the locker ID to the environment when it is no longer needed. -
-
-
- -
Returns:
A locker ID. -
Throws: -
DatabaseException
-
- -
- -
-freeLockerID
-
```
-public void freeLockerID(int id)
-                  throws DatabaseException
```
-
-
Free a locker ID. -
-
-
-
Parameters:
id - The locker id to be freed. -
-
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-getLockerPriority
-
```
-public int getLockerPriority(int id)
-                      throws DatabaseException
```
-
-
Return the deadlock priority for the given locker. -
-
-
-
Parameters:
id - The locker id -
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-setLockerPriority
-
```
-public void setLockerPriority(int id,
-                              int priority)
-                       throws DatabaseException
```
-
-
Assign a deadlock priority to a locker. This value is used when resolving deadlocks. The deadlock resolution algorithm will reject a +
+
Returns:
A locker ID.
+
Throws:
+
DatabaseException
+

+ + + +

+
freeLockerID
+
```
public void freeLockerID(int id)
+                  throws DatabaseException
```
+
Free a locker ID. +
+
Parameters:
id - The locker id to be freed. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
getLockerPriority
+
```
public int getLockerPriority(int id)
+                      throws DatabaseException
```
+
Return the deadlock priority for the given locker. +
+
Parameters:
id - The locker id +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
setLockerPriority
+
```
public void setLockerPriority(int id,
+                     int priority)
+                       throws DatabaseException
```
+
Assign a deadlock priority to a locker. This value is used when resolving deadlocks. The deadlock resolution algorithm will reject a lock request from a locker with a lower priority before a request from a locker with a higher priority. By default, all lockers are created with a priority of 100. -
-
-
-
Parameters:
id - The locker id to configure
priority - The priority to assign to the locker. -
-
Throws: -
DatabaseException - if a failure occurs
-
- -
- -
-lockVector
-
```
-public void lockVector(int locker,
-                       boolean noWait,
-                       LockRequest[] list)
-                throws DatabaseException
```
-
-
Atomically obtain and release one or more locks from the lock table. +
+
Parameters:
id - The locker id to configure
priority - The priority to assign to the locker. +
+
Throws:
+
DatabaseException - if a failure occurs
+

+ + + +

+
lockVector
+
```
public void lockVector(int locker,
+              boolean noWait,
+              LockRequest[] list)
+                throws DatabaseException
```
+
Atomically obtain and release one or more locks from the lock table. This method is intended to support acquisition or trading of multiple locks under one lock table semaphore, as is needed for lock coupling or in multigranularity locking for lock escalation. @@ -1566,53 +1520,48 @@ public void lockVector(int locker, be released cannot be released, the operations before the failing operation are guaranteed to have completed successfully, and the method throws an exception. -
-
-
-
Parameters:
noWait - If a lock cannot be granted because the requested lock conflicts - with an existing lock, throw a LockNotGrantedException +
+
Parameters:
noWait - If a lock cannot be granted because the requested lock conflicts + with an existing lock, throw a LockNotGrantedException immediately instead of waiting for the lock to become available. The index of the request that was not granted will be returned by - LockNotGrantedException.getIndex. -
locker - An unsigned 32-bit integer quantity representing the entity + LockNotGrantedException.getIndex. +
locker - An unsigned 32-bit integer quantity representing the entity requesting the lock. -
list - An array of LockRequest objects, listing the requested lock +
list - An array of LockRequest objects, listing the requested lock operations.
-
-
Throws: -
DatabaseException - if a failure occurs.
- - -
- -
-openLogCursor
-
```
-public LogCursor openLogCursor()
-                        throws DatabaseException
```
-
-
Return a log cursor. -
-
-
- -
Returns:
A log cursor. -
-
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-getLogFileName
-
```
-public String getLogFileName(LogSequenceNumber lsn)
-                      throws DatabaseException
```
-
-
Return the name of the log file that contains the log record +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
openLogCursor
+
```
public LogCursor openLogCursor()
+                        throws DatabaseException
```
+
Return a log cursor. +
+
Returns:
A log cursor. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
getLogFileName
+
```
public java.lang.String getLogFileName(LogSequenceNumber lsn)
+                                throws DatabaseException
```
+
Return the name of the log file that contains the log record specified by a LogSequenceNumber object.
This mapping of LogSequenceNumber objects to files is needed for @@ -1621,55 +1570,51 @@ public Parameters:
lsn - The LogSequenceNumber object for which a filename is wanted. +
+
Returns:
The name of the log file that contains the log record specified by a LogSequenceNumber object.
-
-
Throws: -
IllegalArgumentException - if an invalid parameter was specified. -
-
DatabaseException - if a failure occurs. -
- -
- -
-logVerify
-
```
-public int logVerify(LogVerifyConfig config)
```
-
-
Verify integrity of the log records of an environment and write both error and +
+
Throws:
+
java.lang.IllegalArgumentException - if an invalid parameter was specified. +
+
DatabaseException - if a failure occurs.
+

+ + + +

+
logVerify
+
```
public int logVerify(LogVerifyConfig config)
```
+
Verify integrity of the log records of an environment and write both error and normal messages to the environment's error report destination. This method does not perform the locking function, even in Berkeley DB environments that are configured with a locking subsystem. Because this function does not access any database files, you can call it even when the environment has other threads of control attached and running -
-
-
-
Parameters:
config - The LogVerifyConfig object which contains configurations for the log +
+
Parameters:
config - The LogVerifyConfig object which contains configurations for the log verification. -
-
Returns:
If the verification succeeds, return 0; otherwise non-zero. +
+
Returns:
If the verification succeeds, return 0; otherwise non-zero. Error, warning and report messages are written to the environment's - error report destination.
- - -
- -
-startReplication
-
```
-public void startReplication(DatabaseEntry cdata,
-                             boolean master)
-                      throws DatabaseException
```
-
-
Configure the database environment as a client or master in a group + error report destination.
+

+ + + +

+
startReplication
+
```
public void startReplication(DatabaseEntry cdata,
+                    boolean master)
+                      throws DatabaseException
```
+
Configure the database environment as a client or master in a group of replicated database environments. This method is not called by most replication applications. It should only be called by Base API applications implementing their own network transport layer, explicitly holding replication group elections and @@ -1687,31 +1632,29 @@ public void startReplication(EnvironmentConfig.setReplicationTransport. -
-
-
-
Parameters:
cdata - An opaque data item that is sent over the communication infrastructure + EnvironmentConfig.setReplicationTransport. +
+
Parameters:
cdata - An opaque data item that is sent over the communication infrastructure when the client or master comes online. If no such information is useful, cdata should be null. -
master - Configure the environment as a replication master. If false, the +
master - Configure the environment as a replication master. If false, the environment will be configured as as a replication client.
-
-
Throws: -
DatabaseException - if a failure occurs.
- - -
- -
-electReplicationMaster
-
```
-public void electReplicationMaster(int nsites,
-                                   int nvotes)
-                            throws DatabaseException
```
-
-
Hold an election for the master of a replication group. This method is not called +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
electReplicationMaster
+
```
public void electReplicationMaster(int nsites,
+                          int nvotes)
+                            throws DatabaseException
```
+
Hold an election for the master of a replication group. This method is not called by most replication applications. It should only be called by Base API applications implementing their own network transport layer, explicitly holding replication group elections and handling replication messages outside of the Replication Manager framework. @@ -1758,10 +1701,8 @@ when choosing a new master after a current master fails. This allows the group t When choosing a master from among a group of client sites all restarting at the same time, it makes more sense to set nsites to the total number of sites in the group, since there is no known missing site. Furthermore, in order to ensure the best choice from among sites that may take longer to boot than the local site, setting nvotes also to this same total number of sites will guarantee that every site in the group is considered. Alternatively, using the special timeout for full elections allows full participation on restart but allows election of a master if one site does not reboot and rejoin the group in a reasonable amount of time. (See the Elections section in the Berkeley DB Programmer's Reference Guide for more information.)
Setting nsites to lower values can increase the speed of an election, but can also result in election failure, and is usually not recommended. -
-
-
-
Parameters:
nsites - The number of environments that the application believes are in the +
+
Parameters:
nsites - The number of environments that the application believes are in the replication group. This number is used by Berkeley DB to avoid having two masters active simultaneously, even in the case of a network partition. During an election, a new master cannot be @@ -1770,87 +1711,82 @@ Setting nsites to lower values can increase the speed of an election, but can al with more than half the environments will elect a new master and continue, while the environments communicating with fewer than half the other environments will fail to find a new master. -
nvotes - The number of votes required by the application to successfully +
nvotes - The number of votes required by the application to successfully elect a new master. It must be a positive integer, no greater than nsites, or 0 if the election should use a simple majority of the nsites value as the requirement. A warning is given if half or fewer votes are required to win an election as that can potentially lead to multiple masters in the face of a network partition.
-
-
Throws: -
DatabaseException - if a failure occurs.
- - -
- -
-flushReplication
-
```
-public void flushReplication()
-                      throws DatabaseException
```
-
-
Internal method: re-push the last log record to all clients, in case they've +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

flushReplication

public void flushReplication()
+                      throws DatabaseException

Internal method: re-push the last log record to all clients, in case they've lost messages and don't know it.

This method may not be called before the database environment is opened.

Throws: -: DatabaseException - if a failure occurs.

- -

-processReplicationMessage

-public ReplicationStatus processReplicationMessage(DatabaseEntry control,
-                                                   DatabaseEntry rec,
-                                                   int envid)
-                                            throws DatabaseException

Process an incoming replication message sent by a member of the +

Throws:: DatabaseException - if a failure occurs.

+ + + +

+
processReplicationMessage
+
```
public ReplicationStatus processReplicationMessage(DatabaseEntry control,
+                                          DatabaseEntry rec,
+                                          int envid)
+                                            throws DatabaseException
```
+
Process an incoming replication message sent by a member of the replication group to the local database environment. This method is not called by most replication applications. It should only be called by Base API applications implementing their own network transport layer, explicitly holding replication group elections and handling replication messages outside of the Replication Manager framework.
For implementation reasons, all incoming replication messages must - be processed using the same Environment handle. It is not + be processed using the same Environment handle. It is not required that a single thread of control process all messages, only that all threads of control processing messages use the same handle.
Before calling this method, the enclosing database environment must already have been opened and must already have been configured to send replication messages. -
-
-
-
Parameters:
control - A copy of the control parameter specified by Berkeley DB on the +
+
Parameters:
control - A copy of the control parameter specified by Berkeley DB on the sending environment. -
envid - The local identifier that corresponds to the environment that sent +
envid - The local identifier that corresponds to the environment that sent the message to be processed. -
rec - A copy of the rec parameter specified by Berkeley DB on the sending +
rec - A copy of the rec parameter specified by Berkeley DB on the sending environment. -
-
Returns:
A ReplicationStatus object. -
Throws: -
DatabaseException
- - -
- -
-setReplicationConfig
-
```
-public void setReplicationConfig(ReplicationConfig config,
-                                 boolean onoff)
-                          throws DatabaseException
```
-
-
Configure the replication subsystem. +
+
Returns:
A ReplicationStatus object.
+
Throws:
+
DatabaseException
+

+ + + +

+
setReplicationConfig
+
```
public void setReplicationConfig(ReplicationConfig config,
+                        boolean onoff)
+                          throws DatabaseException
```
+
Configure the replication subsystem.
The database environment's replication subsystem may also be set using the environment's DB_CONFIG file. The syntax of the entry in that file is a single line @@ -1861,64 +1797,56 @@ opened, it will silently overrule configuration done before that time.
This method configures a database environment, including all threads of control accessing the database environment, not only the operations -performed using a specified Environment handle. +performed using a specified Environment handle.
This method may be called at any time during the life of the application. -
-
-
-
Parameters:
config - A replication feature to be configured.
onoff - If true, the feature is enabled, otherwise it is disabled. -
Throws: -
DatabaseException
-
- -
- -
-getReplicationConfig
-
```
-public boolean getReplicationConfig(ReplicationConfig config)
-                             throws DatabaseException
```
-
-
Get the configuration of the replication subsystem. - This method may be called at any time during the life of the application. -
-
- -
Returns:
Whether the specified feature is enabled or disabled. -
Throws: -
DatabaseException
-
-
-
- -
-getReplicationNumSites
-
```
-public int getReplicationNumSites()
-                           throws DatabaseException
```
-
-
Get the number of sites in a replication group. +
+
Parameters:
config - A replication feature to be configured.
onoff - If true, the feature is enabled, otherwise it is disabled.
+
Throws:
+
DatabaseException
+

+ + + +

+
getReplicationConfig
+
```
public boolean getReplicationConfig(ReplicationConfig config)
+                             throws DatabaseException
```
+
Get the configuration of the replication subsystem. + This method may be called at any time during the life of the application.
+
Returns:
Whether the specified feature is enabled or disabled.
+
Throws:
+
DatabaseException
+

+ + + +

+
getReplicationNumSites
+
```
public int getReplicationNumSites()
+                           throws DatabaseException
```
+
Get the number of sites in a replication group. Applications using the replication manager API may only call this method - after replication has been started. -
-
- -
Returns:
The number of sites in the replication group -
Throws: -
DatabaseException - if a failure occurs
-
- -
- -
-setReplicationTimeout
-
```
-public void setReplicationTimeout(ReplicationTimeoutType type,
-                                  int replicationTimeout)
-                           throws DatabaseException
```
-
-
Sets the timeout applied to the specified timeout type. + after replication has been started.
+
Returns:
The number of sites in the replication group
+
Throws:
+
DatabaseException - if a failure occurs
+

+ + + +

+
setReplicationTimeout
+
```
public void setReplicationTimeout(ReplicationTimeoutType type,
+                         int replicationTimeout)
+                           throws DatabaseException
```
+
Sets the timeout applied to the specified timeout type. This method may be called at any time during the life of the application.
The database environment's replication subsystem may also be configured @@ -1926,46 +1854,42 @@ public void setReplicationTimeout( -
-
Parameters:
type - The type of timeout to set. -
replicationTimeout - The time in microseconds of the desired timeout. -
Throws: -
DatabaseException
-
- -
- -
-getReplicationTimeout
-
```
-public int getReplicationTimeout(ReplicationTimeoutType type)
-                          throws DatabaseException
```
-
-
Gets the timeout applied to the specified timeout type. -
-
-
Parameters:
type - The type of timeout to retrieve. -
-
Returns:
The timeout applied to the specified timout type, in microseconds. -
-
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-syncReplication
-
```
-public void syncReplication()
-                     throws DatabaseException
```
-
-
Forces master synchronization to begin for this client. This method is the other - half of setting ReplicationConfig.DELAYCLIENT with - setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean). + it will silently overrule configuration done before that time.
+
Parameters:
type - The type of timeout to set. +
replicationTimeout - The time in microseconds of the desired timeout.
+
Throws:
+
DatabaseException
+

+ + + +

+
getReplicationTimeout
+
```
public int getReplicationTimeout(ReplicationTimeoutType type)
+                          throws DatabaseException
```
+
Gets the timeout applied to the specified timeout type.
+
Parameters:
type - The type of timeout to retrieve. +
+
Returns:
The timeout applied to the specified timout type, in microseconds. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
syncReplication
+
```
public void syncReplication()
+                     throws DatabaseException
```
+
Forces master synchronization to begin for this client. This method is the other + half of setting ReplicationConfig.DELAYCLIENT with + setReplicationConfig(com.sleepycat.db.ReplicationConfig, boolean).
When a new master is elected and the application has configured delayed synchronization, the application must choose when to perform @@ -1977,24 +1901,21 @@ public void syncReplication() Before calling this method, the enclosing database environment must already have been opened and must already have been configured to send replication messages.
-
-
-
- -
Throws: -
DatabaseException - if a failure occurs.
-
- -
- -
-replicationManagerStart
-
```
-public void replicationManagerStart(int nthreads,
-                                    ReplicationManagerStartPolicy policy)
-                             throws DatabaseException
```
-
-
Starts the replication manager. +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
replicationManagerStart
+
```
public void replicationManagerStart(int nthreads,
+                           ReplicationManagerStartPolicy policy)
+                             throws DatabaseException
```
+
Starts the replication manager.
The replication manager is implemented inside the Berkeley DB library, it is designed to manage a replication group. This includes network @@ -2005,322 +1926,461 @@ public void replicationManagerStart(int nthreads, please see the "Replication Manager Getting Started Guide" included in the Berkeley DB documentation.
- This method may not be called before the database environment is opened. -
-
-
Parameters:
nthreads - Specify the number of threads of control created and dedicated to + This method may not be called before the database environment is opened.
+
Parameters:
nthreads - Specify the number of threads of control created and dedicated to processing replication messages. In addition to these message processing threads, the replication manager creates and manages a few of its own threads of control. -
policy - The policy defines the startup characteristics of a replication group. - See ReplicationManagerStartPolicy for more information. -
Throws: -
DatabaseException
- - -
- -
-getReplicationManagerLocalSite
-
```
-public ReplicationManagerSite getReplicationManagerLocalSite()
-                                                      throws DatabaseException
```
-
-
Return a handle for the local replication site. -
-
- -
Throws: -
DatabaseException
-
-
-
- -
-getReplicationManagerSiteList
-
```
-public ReplicationManagerSiteInfo[] getReplicationManagerSiteList()
-                                                           throws DatabaseException
```
-
-
Return an array of all the sites known to the replication manager. +
policy - The policy defines the startup characteristics of a replication group. + See ReplicationManagerStartPolicy for more information.
+
Throws:
+
DatabaseException
+

+ + + +

getReplicationManagerLocalSite

public ReplicationManagerSite getReplicationManagerLocalSite()
+                                                      throws DatabaseException

Return a handle for the local replication site.

Throws:: DatabaseException

+ + + +

+
getReplicationManagerSiteList
+
```
public ReplicationManagerSiteInfo[] getReplicationManagerSiteList()
+                                                           throws DatabaseException
```
+
Return an array of all the sites known to the replication manager. This method may only be called after replication has been started - using the replicationManagerStart method. -
-
- -
Throws: -
DatabaseException
-
- -
- -
-getReplicationManagerSite
-
```
-public ReplicationManagerSite getReplicationManagerSite(int eid)
-                                                 throws DatabaseException
```
-
-
Return a site known to the replication manager by its eid. -
-
-
-
Parameters:
eid - -
Throws: -
DatabaseException
-
-
-
- -
-getReplicationManagerSite
-
```
-public ReplicationManagerSite getReplicationManagerSite(String host,
-                                                        long port)
-                                                 throws DatabaseException
```
-
-
Return a site in the replication manager by its host and port. -
-
-
-
Parameters:
host -
port - -
Throws: -
DatabaseException
-
-
-
- -
-openChannel
-
```
-public ReplicationChannel openChannel(int eid)
-                               throws DatabaseException
```
-
-
Create a channel. -
-
-
-
Parameters:
eid - -
Throws: -
DatabaseException
-
-
-
- -
-setReplicationManagerMessageDispatch
-
```
-public void setReplicationManagerMessageDispatch(ReplicationManagerMessageDispatch dispatch,
-                                                 int flags)
-                                          throws DatabaseException
```
-
-
Set the message dispatch function. -
-
-
-
Parameters:
dispatch - Application-specific function used to handle messages sent over Replication - Manager message channels.
flags - This flag is DB_REPMGR_NEED_RESPONSE if the message requires a response. - Otherwise, it is 0. -
Throws: -
DatabaseException
-
-
-
- -
-getCacheStats
-
```
-public CacheStats getCacheStats(StatsConfig config)
-                         throws DatabaseException
```
-
-
Returns the memory pool (that is, the buffer cache) subsystem statistics. -
-
-
- -
Returns:
the memory pool (that is, the buffer cache) subsystem statistics. -
Throws: -
DatabaseException
-
-
-
- -
-getCacheFileStats
-
```
-public CacheFileStats[] getCacheFileStats(StatsConfig config)
-                                   throws DatabaseException
```
-
-
Return statistics for individual files in the cache. -
-
-
- -
Returns:
statistics for individual files in the cache. -
Throws: -
DatabaseException
-
-
-
- -
-getLogStats
-
```
-public LogStats getLogStats(StatsConfig config)
-                     throws DatabaseException
```
-
-
Return the database environment's logging statistics. -
-
-
-
Parameters:
config - The statistics attributes. If null, default attributes are used. -
-
Returns:
The database environment's logging statistics. -
-
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-getReplicationStats
-
```
-public ReplicationStats getReplicationStats(StatsConfig config)
-                                     throws DatabaseException
```
-
-
Return the database environment's replication statistics. -
-
-
-
Parameters:
config - The statistics attributes. If null, default attributes are used. -
-
Returns:
The database environment's replication statistics. -
-
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-getReplicationManagerStats
-
```
-public ReplicationManagerStats getReplicationManagerStats(StatsConfig config)
-                                                   throws DatabaseException
```
-
-
Return the database environment's replication manager statistics. -
-
-
-
Parameters:
config - The statistics attributes. If null, default attributes are used. -
-
Returns:
The database environment's replication manager statistics. -
-
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-getLockStats
-
```
-public LockStats getLockStats(StatsConfig config)
-                       throws DatabaseException
```
-
-
Return the database environment's locking statistics. -
-
-
-
Parameters:
config - The locking statistics attributes. If null, default attributes are used. -
-
Returns:
The database environment's locking statistics. -
-
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-getMutexStats
-
```
-public MutexStats getMutexStats(StatsConfig config)
-                         throws DatabaseException
```
-
-
Return the database environment's mutex statistics. -
-
-
-
Parameters:
config - The statistics attributes. If null, default attributes are used. -
-
Returns:
The database environment's mutex statistics. -
-
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-getTransactionStats
-
```
-public TransactionStats getTransactionStats(StatsConfig config)
-                                     throws DatabaseException
```
-
-
Return the database environment's transactional statistics. -
-
-
-
Parameters:
config - The transactional statistics attributes. If null, default attributes are used. -
-
Returns:
The database environment's transactional statistics. -
-
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-beginCDSGroup
-
```
-public Transaction beginCDSGroup()
-                          throws DatabaseException
```
-
-
Allocate a locker ID in an environment configured for Berkeley DB - Concurrent Data Store applications. Returns a Transaction object - that uniquely identifies the locker ID. Calling the Transaction.commit() method will discard the allocated locker ID. + using the replicationManagerStart method.
+
Throws:
+
DatabaseException
+

+ + + +

getReplicationManagerSite

public ReplicationManagerSite getReplicationManagerSite(int eid)
+                                                 throws DatabaseException

Return a site known to the replication manager by its eid. +

Parameters:: eid -
Throws:: DatabaseException

+ + + +

getReplicationManagerSite

public ReplicationManagerSite getReplicationManagerSite(java.lang.String host,
+                                               long port)
+                                                 throws DatabaseException

Return a site in the replication manager by its host and port. +

Parameters:: host -; port -
Throws:: DatabaseException

+ + + +

openChannel

public ReplicationChannel openChannel(int eid)
+                               throws DatabaseException

Create a channel. +

Parameters:: eid -
Throws:: DatabaseException

+ + + +

+
setReplicationManagerMessageDispatch
+
```
public void setReplicationManagerMessageDispatch(ReplicationManagerMessageDispatch dispatch,
+                                        int flags)
+                                          throws DatabaseException
```
+
Set the message dispatch function. +
+
Parameters:
dispatch - Application-specific function used to handle messages sent over Replication + Manager message channels.
flags - This flag is DB_REPMGR_NEED_RESPONSE if the message requires a response. + Otherwise, it is 0.
+
Throws:
+
DatabaseException
+

+ + + +

+
getCacheStats
+
```
public CacheStats getCacheStats(StatsConfig config)
+                         throws DatabaseException
```
+
Returns the memory pool (that is, the buffer cache) subsystem statistics. +
+
Returns:
the memory pool (that is, the buffer cache) subsystem statistics.
+
Throws:
+
DatabaseException
+

+ + + +

+
getCacheFileStats
+
```
public CacheFileStats[] getCacheFileStats(StatsConfig config)
+                                   throws DatabaseException
```
+
Return statistics for individual files in the cache. +
+
Returns:
statistics for individual files in the cache.
+
Throws:
+
DatabaseException
+

+ + + +

+
getLogStats
+
```
public LogStats getLogStats(StatsConfig config)
+                     throws DatabaseException
```
+
Return the database environment's logging statistics. +
+
Parameters:
config - The statistics attributes. If null, default attributes are used. +
+
Returns:
The database environment's logging statistics. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
getReplicationStats
+
```
public ReplicationStats getReplicationStats(StatsConfig config)
+                                     throws DatabaseException
```
+
Return the database environment's replication statistics. +
+
Parameters:
config - The statistics attributes. If null, default attributes are used. +
+
Returns:
The database environment's replication statistics. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
getReplicationManagerStats
+
```
public ReplicationManagerStats getReplicationManagerStats(StatsConfig config)
+                                                   throws DatabaseException
```
+
Return the database environment's replication manager statistics. +
+
Parameters:
config - The statistics attributes. If null, default attributes are used. +
+
Returns:
The database environment's replication manager statistics. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
getLockStats
+
```
public LockStats getLockStats(StatsConfig config)
+                       throws DatabaseException
```
+
Return the database environment's locking statistics. +
+
Parameters:
config - The locking statistics attributes. If null, default attributes are used. +
+
Returns:
The database environment's locking statistics. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
getMutexStats
+
```
public MutexStats getMutexStats(StatsConfig config)
+                         throws DatabaseException
```
+
Return the database environment's mutex statistics. +
+
Parameters:
config - The statistics attributes. If null, default attributes are used. +
+
Returns:
The database environment's mutex statistics. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
getTransactionStats
+
```
public TransactionStats getTransactionStats(StatsConfig config)
+                                     throws DatabaseException
```
+
Return the database environment's transactional statistics. +
+
Parameters:
config - The transactional statistics attributes. If null, default attributes are used. +
+
Returns:
The database environment's transactional statistics. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
printMempStats
+
```
public int printMempStats(StatsConfig config)
+                   throws DatabaseException
```
+
Print the cache subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). +
+
Parameters:
config - The statistics attributes. If null, default attributes are used. +
+
Returns:
A non-zero error value on failure and 0 on success. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
printLogStats
+
```
public int printLogStats(StatsConfig config)
+                  throws DatabaseException
```
+
Print the logging subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). +
+
Parameters:
config - The statistics attributes. If null, default attributes are used. +
+
Returns:
A non-zero error value on failure and 0 on success. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
printReplicationStats
+
```
public int printReplicationStats(StatsConfig config)
+                          throws DatabaseException
```
+
Print the replication subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). +
+
Parameters:
config - The statistics attributes. If null, default attributes are used. +
+
Returns:
A non-zero error value on failure and 0 on success. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
printReplicationManagerStats
+
```
public int printReplicationManagerStats(StatsConfig config)
+                                 throws DatabaseException
```
+
Print the Replication Manager subsystem statistical information to a + specified output channel (see the setMsgfile() method for more + information), or passed to an application callback function (see the + setMsgcall() method for more information). +
+
Parameters:
config - The statistics attributes. If null, default attributes are used. +
+
Returns:
A non-zero error value on failure and 0 on success. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
printLockStats
+
```
public int printLockStats(StatsConfig config)
+                   throws DatabaseException
```
+
Print the locking subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). +
+
Parameters:
config - The statistics attributes. If null, default attributes are used. +
+
Returns:
A non-zero error value on failure and 0 on success. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
printMutexStats
+
```
public int printMutexStats(StatsConfig config)
+                    throws DatabaseException
```
+
Print the mutex subsystem statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). +
+
Parameters:
config - The statistics attributes. If null, default attributes are used. +
+
Returns:
A non-zero error value on failure and 0 on success. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
printStats
+
```
public int printStats(StatsConfig config)
+               throws DatabaseException
```
+
Print environment statistical information to a specified output + channel (see the setMsgfile() method for more information), or passed to an + application callback function (see the setMsgcall() method for more + information). +
+
Parameters:
config - The statistics attributes. If null, default attributes are used. +
+
Returns:
A non-zero error value on failure and 0 on success. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
printTransactionStats
+
```
public int printTransactionStats(StatsConfig config)
+                          throws DatabaseException
```
+
Print the transaction subsystem statistical information to a specified + output channel (see the setMsgfile() method for more information), or + passed to an application callback function (see the setMsgcall() method + for more information). +
+
Parameters:
config - The statistics attributes. If null, default attributes are used. +
+
Returns:
A non-zero error value on failure and 0 on success. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
beginCDSGroup
+
```
public Transaction beginCDSGroup()
+                          throws DatabaseException
```
+
Allocate a locker ID in an environment configured for Berkeley DB + Concurrent Data Store applications. Returns a Transaction object + that uniquely identifies the locker ID. Calling the Transaction.commit() method will discard the allocated locker ID.
See Berkeley DB Concurrent Data Store applications for more information about when this is required. This method may be called at any time during the life of the application. -
-
-
- -
Returns:
A transaction handle that wraps a CDS locker ID. -
Throws: -
DatabaseException
-
- -
- -
-beginTransaction
-
```
-public Transaction beginTransaction(Transaction parent,
-                                    TransactionConfig config)
-                             throws DatabaseException
```
-
-
Create a new transaction in the database environment. +
+
Returns:
A transaction handle that wraps a CDS locker ID.
+
Throws:
+
DatabaseException
+

+ + + +

+
beginTransaction
+
```
public Transaction beginTransaction(Transaction parent,
+                           TransactionConfig config)
+                             throws DatabaseException
```
+
Create a new transaction in the database environment.
Transactions may only span threads if they do so serially; that is, each transaction must be active in only a single thread of control @@ -2334,81 +2394,73 @@ public Environment.beginTransaction, - Transaction.abort and Transaction.commit -- + except for Environment.beginTransaction, + Transaction.abort and Transaction.commit -- while it has active child transactions (child transactions that have not yet been committed or aborted). -
-
-
-
Parameters:
parent - If the parent parameter is non-null, the new transaction will be a +
+
Parameters:
parent - If the parent parameter is non-null, the new transaction will be a nested transaction, with the transaction indicated by parent as its parent. Transactions may be nested to any level. In the presence of distributed transactions and two-phase commit, only the parental transaction, that is a transaction without a parent specified, - should be passed as an parameter to Transaction.prepare. -
config - The transaction attributes. If null, default attributes are used. -
-
Returns:
The newly created transaction's handle. -
-
Throws: -
DatabaseException - if a failure occurs.
- - -
- -
-checkpoint
-
```
-public void checkpoint(CheckpointConfig config)
-                throws DatabaseException
```
-
-
Synchronously checkpoint the database environment. -
-
-
-
-
Parameters:
config - The checkpoint attributes. If null, default attributes are used. -
-
Throws: -
DatabaseException - if a failure occurs.
-
-
-
- -
-logFlush
-
```
-public void logFlush(LogSequenceNumber lsn)
-              throws DatabaseException
```
-
-
Flush log records to stable storage. -
-
-
-
Parameters:
lsn - All log records with LogSequenceNumber values less than or equal to + should be passed as an parameter to Transaction.prepare. +
config - The transaction attributes. If null, default attributes are used. +
+
Returns:
The newly created transaction's handle. +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
checkpoint
+
```
public void checkpoint(CheckpointConfig config)
+                throws DatabaseException
```
+
Synchronously checkpoint the database environment. +
+
+
Parameters:
config - The checkpoint attributes. If null, default attributes are used. +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
logFlush
+
```
public void logFlush(LogSequenceNumber lsn)
+              throws DatabaseException
```
+
Flush log records to stable storage. +
+
Parameters:
lsn - All log records with LogSequenceNumber values less than or equal to the lsn parameter are written to stable storage. If lsn is null, all records in the log are flushed.
-
-
Throws: -
DatabaseException - if a failure occurs.
- - -
- -
-logPut
-
```
-public LogSequenceNumber logPut(DatabaseEntry data,
-                                boolean flush)
-                         throws DatabaseException
```
-
-
Append a record to the log. -
-
-
-
Parameters:
data - The record to append to the log. +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
logPut
+
```
public LogSequenceNumber logPut(DatabaseEntry data,
+                       boolean flush)
+                         throws DatabaseException
```
+
Append a record to the log. +
+
Parameters:
data - The record to append to the log.
The caller is responsible for providing any necessary structure to data. (For example, in a write-ahead logging protocol, the @@ -2418,64 +2470,62 @@ public -
Returns:
The LogSequenceNumber of the put record. -
-
-
Throws: -
DatabaseException - if a failure occurs.
- - -
- -
-logPrint
-
```
-public void logPrint(Transaction txn,
-                     String message)
-              throws DatabaseException
```
-
-
Append an informational message to the Berkeley DB database environment log files. +
+
Returns:
The LogSequenceNumber of the put record. +
+
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
logPrint
+
```
public void logPrint(Transaction txn,
+            java.lang.String message)
+              throws DatabaseException
```
+
Append an informational message to the Berkeley DB database environment log files.
This method allows applications to include information in the database environment log files, for later review using the db_printlog utility. This method is intended for debugging and performance tuning. -
-
-
-
Parameters:
txn - If the logged message refers to an application-specified transaction, +
+
Parameters:
txn - If the logged message refers to an application-specified transaction, the txn parameter is a transaction handle, otherwise null.
-
-
Throws: -
DatabaseException - if a failure occurs.
- - -
- -
-getArchiveLogFiles
-
```
-public File[] getArchiveLogFiles(boolean includeInUse)
-                          throws DatabaseException
```
-
-
Return an array of log files. +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
getArchiveLogFiles
+
```
public java.io.File[] getArchiveLogFiles(boolean includeInUse)
+                                  throws DatabaseException
```
+
Return an array of log files.
When Replication Manager is in use, log archiving is performed in a replication group-aware manner such that the log file status of other sites in the group is considered to determine if a log file is in use.
Log cursor handles (returned by the - openLogCursor() method may + openLogCursor() method may have open file descriptors for log files in the database environment. Also, the Berkeley DB interfaces to the database environment logging subsystem (for - example, logPut and - Transaction.abort may allocate log + example, logPut and + Transaction.abort may allocate log cursors and have open file descriptors for log files as well. On operating systems where filesystem related system calls (for example, rename and unlink on Windows/NT) can fail if a process has an open file descriptor for the @@ -2490,29 +2540,27 @@ public db_archive for more information on database archival procedures. -
-
-
-
Parameters:
includeInUse - if true, all log files, regardless of whether or not they +
+
Parameters:
includeInUse - if true, all log files, regardless of whether or not they are in use, are returned. Otherwise, the log files that are no longer in use (for example, that are no longer involved in active transactions), and that may safely be archived for catastrophic recovery and then removed from the system. -
-
Returns:
An array of log files -
Throws: -
DatabaseException
- - -
- -
-getArchiveDatabases
-
```
-public File[] getArchiveDatabases()
-                           throws DatabaseException
```
-
-
Return the database files that need to be archived in order to recover the +
+
Returns:
An array of log files
+
Throws:
+
DatabaseException
+

+ + + +

+
getArchiveDatabases
+
```
public java.io.File[] getArchiveDatabases()
+                                   throws DatabaseException
```
+
Return the database files that need to be archived in order to recover the database from catastrophic failure. If any of the database files have not been accessed during the lifetime of the current log files, they will not be returned. It is also possible that some of the files referred to by the log @@ -2525,24 +2573,21 @@ public db_archive for more information on database archival procedures. -
-
-
- -
Returns:
An array of database files -
Throws: -
DatabaseException
-
- -
- -
-removeOldLogFiles
-
```
-public void removeOldLogFiles()
-                       throws DatabaseException
```
-
-
Remove log files that are no longer needed. +
+
Returns:
An array of database files
+
Throws:
+
DatabaseException
+

+ + + +

+
removeOldLogFiles
+
```
public void removeOldLogFiles()
+                       throws DatabaseException
```
+
Remove log files that are no longer needed.
Automatic log file removal is likely to make catastrophic recovery impossible. @@ -2551,24 +2596,21 @@ public void removeOldLogFiles() replication group-aware manner such that the log file status of other sites in the group is considered to determine if a log file is in use.
-
-
-
- -
Throws: -
DatabaseException - if a failure occurs.
-
- -
- -
-recover
-
```
-public PreparedTransaction[] recover(int count,
-                                     boolean continued)
-                              throws DatabaseException
```
-
-
Environment recovery restores transactions that were prepared, but not yet +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
recover
+
```
public PreparedTransaction[] recover(int count,
+                            boolean continued)
+                              throws DatabaseException
```
+
Environment recovery restores transactions that were prepared, but not yet resolved at the time of the system shut down or crash, to their state prior to the shut down or crash, including any locks previously held. This method returns a list of those prepared transactions. @@ -2578,31 +2620,28 @@ public Transaction.commit() or - Transaction.abort() each returned + Transaction.commit() or + Transaction.abort() each returned transaction. Callers must call - Transaction.discard() to discard + Transaction.discard() to discard each transaction they do not resolve. -
-
-
- -
Returns:
a list of transactions - that must be resolved by the application (committed, aborted or discarded). -
Throws: -
DatabaseException
-
- -
- -
-resetFileID
-
```
-public void resetFileID(String filename,
-                        boolean encrypted)
-                 throws DatabaseException
```
-
-
Allows database files to be copied, and then the copy used in the same +
+
Returns:
a list of transactions + that must be resolved by the application (committed, aborted or discarded).
+
Throws:
+
DatabaseException
+

+ + + +

+
resetFileID
+
```
public void resetFileID(java.lang.String filename,
+               boolean encrypted)
+                 throws DatabaseException
```
+
Allows database files to be copied, and then the copy used in the same database environment as the original.
All databases contain an ID string used to identify the database in the @@ -2615,25 +2654,23 @@ public void resetFileID(DatabaseException - if a failure occurs. - - -
- -
-resetLogSequenceNumber
-
```
-public void resetLogSequenceNumber(String filename,
-                                   boolean encrypted)
-                            throws DatabaseException
```
-
-
Allows database files to be moved from one transactional database +
+
Parameters:
filename - The name of the physical file in which the LSNs are to be cleared.
encrypted - Whether the file contains encrypted databases. +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
resetLogSequenceNumber
+
```
public void resetLogSequenceNumber(java.lang.String filename,
+                          boolean encrypted)
+                            throws DatabaseException
```
+
Allows database files to be moved from one transactional database environment to another.
Database pages in transactional database environments contain references @@ -2653,52 +2690,48 @@ public void resetLogSequenceNumber(DatabaseException - if a failure occurs. - - -
- -
-panic
-
```
-public void panic(boolean onoff)
-           throws DatabaseException
```
-
-
Set the panic state for the database environment. +
+
Parameters:
filename - The name of the physical file in which the LSNs are to be cleared.
encrypted - Whether the file contains encrypted databases. +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
panic
+
```
public void panic(boolean onoff)
+           throws DatabaseException
```
+
Set the panic state for the database environment. Database environments in a panic state normally refuse all attempts to call library functions, throwing a - RunRecoveryException. + RunRecoveryException.
This method configures a database environment, including all threads of control accessing the database environment, not only the operations performed using a specified - Environment handle. + Environment handle.
This method may be called at any time during the life of the application. -
-
-
-
Parameters:
onoff - If true, set the panic state for the database environment. -
Throws: -
DatabaseException
-
- -
- -
-backup
-
```
-public void backup(String target,
-                   BackupOptions opt)
-            throws DatabaseException
```
-
-
Perform a hot back up of the open environment. +
+
Parameters:
onoff - If true, set the panic state for the database environment.
+
Throws:
+
DatabaseException
+

+ + + +

+
backup
+
```
public void backup(java.lang.String target,
+          BackupOptions opt)
+            throws DatabaseException
```
+
Perform a hot back up of the open environment.
All files used by the environment are backed up, so long as the normal rules for file placement are followed. For information on how files @@ -2710,7 +2743,7 @@ public void backup(BackupOptions.setSingleDir + use the BackupOptions.setSingleDir method.
This method provides the same functionality as the @@ -2719,336 +2752,349 @@ public void backup(Environment.checkpoint + Environment.checkpoint method. For more information on checkpoints, see the Checkpoint section in the Berkeley DB Reference Guide.
To back up a single database file within the environment, use the - Environment.backupDatabase + Environment.backupDatabase method.
In addition to the configuration options available using the - BackupOptions + BackupOptions class, additional tuning modifications can be made using the - EnvironmentConfig.setBackupReadCount, - EnvironmentConfig.setBackupReadSleep, - EnvironmentConfig.setBackupSize, and - EnvironmentConfig.setBackupWriteDirect + EnvironmentConfig.setBackupReadCount, + EnvironmentConfig.setBackupReadSleep, + EnvironmentConfig.setBackupSize, and + EnvironmentConfig.setBackupWriteDirect methods. Alternatively, you can write your own custom hot back up facility using the - BackupHandler interface. + BackupHandler interface.
This method may only be called after the environment has been opened. -
-
-
-
Parameters:
target - Identifies the directory in which the back up will be placed. Any +
+
Parameters:
target - Identifies the directory in which the back up will be placed. Any subdirectories required to contain the back up must be placed relative to this directory. Note that if a - BackupHandler is configured for the + BackupHandler is configured for the environment, then the value specified to this parameter is passed on to the - BackupHandler.open + BackupHandler.open method. If this parameter is null, then the target must be specified to the - BackupHandler.open + BackupHandler.open method.
This directory, and any required subdirectories, will be created for you if you specify true for the - BackupOptions.setAllowCreate + BackupOptions.setAllowCreate method. Otherwise, if the target does not exist, this method throws a - DatabaseException exception. -
opt - The BackupOptions instance used to + DatabaseException exception. +
opt - The BackupOptions instance used to configure the hot back up. -
-
Throws: -
DatabaseException - if a failure occurs at any point during the back up.
- - -
- -
-backupDatabase
-
```
-public void backupDatabase(String dbfile,
-                           String target,
-                           boolean exclusiveCreate)
-                    throws DatabaseException
```
-
-
Perform a hot back up of a single database file contained within the environment. +
+
Throws:
+
DatabaseException - if a failure occurs at any point during the back up.
+

+ + + +

+
backupDatabase
+
```
public void backupDatabase(java.lang.String dbfile,
+                  java.lang.String target,
+                  boolean exclusiveCreate)
+                    throws DatabaseException
```
+
Perform a hot back up of a single database file contained within the environment.
To back up the entire environment, use the - Environment.backup + Environment.backup method.
You can make some tuning modifications to the backup process using the - EnvironmentConfig.setBackupReadCount, - EnvironmentConfig.setBackupReadSleep, - EnvironmentConfig.setBackupSize, and - EnvironmentConfig.setBackupWriteDirect + EnvironmentConfig.setBackupReadCount, + EnvironmentConfig.setBackupReadSleep, + EnvironmentConfig.setBackupSize, and + EnvironmentConfig.setBackupWriteDirect methods. Alternatively, you can write your own custom hot back up facility using the - BackupHandler interface. + BackupHandler interface.
This method may only be called after the environment has been opened. -
-
-
-
Parameters:
dbfile - The database file that you want to back up. -
target - Identifies the directory in which the back up will be placed. +
+
Parameters:
dbfile - The database file that you want to back up. +
target - Identifies the directory in which the back up will be placed. The target must exist; otherwise this method throws a - DatabaseException exception. + DatabaseException exception. Note that if a - BackupHandler is configured for the + BackupHandler is configured for the environment, then the value specified to this parameter is passed on to the - BackupHandler.open + BackupHandler.open method. If this parameter is null, then the target must be specified to the - BackupHandler.open + BackupHandler.open method. -
exclusiveCreate - If true, then if the target file exists, this method throws a - DatabaseException exception. -
-
Throws: -
DatabaseException - if a failure occurs at any point during the back up.
- - -
- -
-getVersionString
-
```
-public static String getVersionString()
```
-
-
Return the release version information, suitable for display. +
exclusiveCreate - If true, then if the target file exists, this method throws a + DatabaseException exception. +
+
Throws:
+
DatabaseException - if a failure occurs at any point during the back up.
+

+ + + +

+
getVersionString
+
```
public static java.lang.String getVersionString()
```
+
Return the release version information, suitable for display.
This method may be called at any time during the life of the application. -
-
-
- -
Returns:
The release version information, suitable for display.
-
- -
- -
-getVersionFullString
-
```
-public static String getVersionFullString()
```
-
-
Return the full release version information, suitable for display. +
+
Returns:
The release version information, suitable for display.
+

+ + + +

+
getVersionFullString
+
```
public static java.lang.String getVersionFullString()
```
+
Return the full release version information, suitable for display.
This method may be called at any time during the life of the application. -
-
-
- -
Returns:
The full release version information, suitable for display.
-
- -
- -
-getVersionFamily
-
```
-public static int getVersionFamily()
```
-
-
Return the release's Oracle family number. +
+
Returns:
The full release version information, suitable for display.
+

+ + + +

+
getVersionFamily
+
```
public static int getVersionFamily()
```
+
Return the release's Oracle family number.
This method may be called at any time during the life of the application. -
-
-
- -
Returns:
The release's Oracle family number.
-
- -
- -
-getVersionRelease
-
```
-public static int getVersionRelease()
```
-
-
Return the release's Oracle release number. +
+
Returns:
The release's Oracle family number.
+

+ + + +

+
getVersionRelease
+
```
public static int getVersionRelease()
```
+
Return the release's Oracle release number.
This method may be called at any time during the life of the application. -
-
-
- -
Returns:
The release's Oracle release number.
-
- -
- -
-getVersionMajor
-
```
-public static int getVersionMajor()
```
-
-
Return the release major number. +
+
Returns:
The release's Oracle release number.
+

+ + + +

+
getVersionMajor
+
```
public static int getVersionMajor()
```
+
Return the release major number.
This method may be called at any time during the life of the application. -
-
-
- -
Returns:
The release major number.
-
- -
- -
-syncCache
-
```
-public void syncCache(LogSequenceNumber logSequenceNumber)
-               throws DatabaseException
```
-
-
Ensure that all modified pages in the cache are flushed to their backing files. +
+
Returns:
The release major number.
+

+ + + +

+
syncCache
+
```
public void syncCache(LogSequenceNumber logSequenceNumber)
+               throws DatabaseException
```
+
Ensure that all modified pages in the cache are flushed to their backing files.
Pages in the cache that cannot be immediately written back to disk (for example pages that are currently in use by another thread of control) are waited for and written to disk as soon as it is possible to do so. -
-
-
-
Parameters:
logSequenceNumber - The purpose of the logSequenceNumber parameter is to enable a transaction +
+
Parameters:
logSequenceNumber - The purpose of the logSequenceNumber parameter is to enable a transaction manager to ensure, as part of a checkpoint, that all pages modified by a certain time have been written to disk.
All modified pages with a log sequence number less than the logSequenceNumber parameter are written to disk. If logSequenceNumber is null, all modified -pages in the cache are written to disk. -
Throws: -
DatabaseException
- - -
- -
-isTransactionApplied
-
```
-public TransactionStatus isTransactionApplied(byte[] token,
-                                              int maxwait)
-                                       throws DatabaseException
```
-
-
Return whether the transaction referred to by the commit token "token" has +pages in the cache are written to disk.
+
Throws:
+
DatabaseException
+

+ + + +

+
isTransactionApplied
+
```
public TransactionStatus isTransactionApplied(byte[] token,
+                                     int maxwait)
+                                       throws DatabaseException
```
+
Return whether the transaction referred to by the commit token "token" has been applied at the local replication environment.
This method may not be called before the database environment is opened. -
-
-
-
Parameters:
maxwait - The maximum time to wait for the transaction to arrive by replication, +
+
Parameters:
maxwait - The maximum time to wait for the transaction to arrive by replication, expressed in microseconds. To check the status of the transaction without waiting, the timeout may be specified as 0. -
-
Returns:
TransactionStatus indicating the status of the applicaton of the transaction. -
Throws: -
DatabaseException
- - -
- -
-getVersionMinor
-
```
-public static int getVersionMinor()
```
-
-
Return the release minor number. +
+
Returns:
TransactionStatus indicating the status of the applicaton of the transaction.
+
Throws:
+
DatabaseException
+

+ + + +

+
getVersionMinor
+
```
public static int getVersionMinor()
```
+
Return the release minor number.
This method may be called at any time during the life of the application. -
-
-
- -
Returns:
The release minor number.
-
- -
- -
-getVersionPatch
-
```
-public static int getVersionPatch()
```
-
-
Return the release patch number. +
+
Returns:
The release minor number.
+

+ + + +

+
getVersionPatch
+
```
public static int getVersionPatch()
```
+
Return the release patch number.
This method may be called at any time during the life of the application. -
-
-
- -
Returns:
The release patch number.
-
- +
+
Returns:
The release patch number.
+

+ + + +

+
setBlobThreshold
+
```
public void setBlobThreshold(int value)
+                      throws DatabaseException
```
+
Set the blob threshold size. +
+
Parameters:
value - The blob threshold size. +
+ Any data item that is equal to or larger in size than the + threshold value will automatically be stored as a blob file. +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + +

+
setMsgfile
+
```
public void setMsgfile(java.io.File file)
+                throws DatabaseException
```
+
Sets the path of a file to store statistical information. +
+
Parameters:
file - The path of a file to store statistical information. +
+
Throws:
+
DatabaseException - if a failure occurs.
+

+ + + + +

- -com.sleepycat.db - -Class Environment

Class Environment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

-EID_MASTER

Field Detail

EID_MASTER

-Environment

Constructor Detail

Environment

-close

Method Detail

close

-closeForceSync

closeForceSync

closeForceSyncEnv

closeForceSyncAndForceSyncEnv

-remove

remove

-setConfig

-getConfig

-openDatabase

setConfig

getConfig

openDatabase

-openSecondaryDatabase

openSecondaryDatabase

-removeDatabase

removeDatabase

-renameDatabase

renameDatabase

-getHome

-trickleCacheWrite

getHome

trickleCacheWrite

-detectDeadlocks

detectDeadlocks

-getLock

getLock

-putLock

-createLockerID

putLock

createLockerID

-freeLockerID

-getLockerPriority

-setLockerPriority

freeLockerID

getLockerPriority

setLockerPriority

-lockVector

lockVector

-openLogCursor

-getLogFileName

openLogCursor

getLogFileName

-logVerify

logVerify

-startReplication

startReplication

-electReplicationMaster

electReplicationMaster

-flushReplication

flushReplication

-processReplicationMessage

processReplicationMessage

-setReplicationConfig

setReplicationConfig

-getReplicationConfig

-getReplicationNumSites

getReplicationConfig

getReplicationNumSites

-setReplicationTimeout

setReplicationTimeout

-getReplicationTimeout

-syncReplication

getReplicationTimeout

syncReplication

-replicationManagerStart

- -com.sleepycat.db -
-Class Environment