com.sleepycat.je

Class DbInternal

java.lang.Object

com.sleepycat.je.DbInternal

public class DbInternal
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbInternal.Search Search mode used with the internal search and searchBoth methods.

Field Summary

Fields

Modifier and Type	Field and Description
static OperationResult	DEFAULT_RESULT

Constructor Summary

Constructors

Constructor and Description
DbInternal()

Method Summary

Modifier and Type	Method and Description
static boolean	advanceCursor(Cursor cursor, DatabaseEntry key, DatabaseEntry data) Proxy to Cursor.advanceCursor()
static Transaction	beginInternalTransaction(Environment env, TransactionConfig config)
static void	checkImmutablePropsForEquality(EnvironmentMutableConfig config, Properties handleConfigProps) Proxy to EnvironmentMutableConfig.checkImmutablePropsForEquality()
static EnvironmentImpl	checkOpen(Environment env) Proxy to Environment.checkOpen
static void	clearEnvImpl(Environment env) Proxy to Environment.clearEnvImpl
static EnvironmentMutableConfig	cloneMutableConfig(EnvironmentMutableConfig config) Proxy to EnvironmentMutableConfig.cloneMutableConfig()
static void	closeInternalHandle(Environment env) Proxy to Environment.closeInternalHandle
static void	copyMutablePropsTo(EnvironmentMutableConfig config, EnvironmentMutableConfig toConfig) Proxy to EnvironmentMutableConfig.copyMutablePropsTo()
static OperationResult	deleteInternal(Cursor cursor, ReplicationContext repContext) Proxy to Cursor.deleteInternal()
static OperationResult	deleteWithRepContext(Cursor cursor, ReplicationContext repContext) Proxy to Cursor.deleteWithRepContext()
static void	disableParameterValidation(EnvironmentMutableConfig config) Proxy to EnvironmentMutableConfig.validateParams.
static void	excludeFromOpStats(Cursor cursor) Proxy to Cursor.excludeFromOpStats
static boolean	getCheckpointUP(EnvironmentConfig config) Proxy to EnvironmentConfig.getCheckpointUP()
static SecondaryIntegrityException	getCorruptedCause(Database db)
static boolean	getCreateEP(EnvironmentConfig config) Proxy to EnvironmentConfig.getCreateEP()
static boolean	getCreateUP(EnvironmentConfig config) Proxy to EnvironmentConfig.getCreateUP()
static CursorImpl	getCursorImpl(Cursor cursor) Proxy to Cursor.getCursorImpl()
static DatabaseImpl	getDbImpl(Database db) Proxy to Database.getDbImpl()
static TransactionConfig	getDefaultTxnConfig(Environment env) Proxy to Environment.getDefaultTxnConfig()
static DiskOrderedCursorImpl	getDiskOrderedCursorImpl(DiskOrderedCursor cursor)
static Environment	getEnvironment(Transaction txn) Proxy to Transaction.getEnvironment()
static EnvironmentImpl	getEnvironmentImpl(Environment env) Proxy to Environment.getMaybeNullEnvImpl.
static Locker	getLocker(Transaction txn) Proxy to Transaction.getLocker()
static EnvironmentImpl	getNonNullEnvImpl(Environment env) Proxy to Environment.getNonNullEnvImpl This method is called to access the underlying EnvironmentImpl when an env is expected to be open, to guard against NPE when the env has been closed.
static SecondaryConfig	getPrivateSecondaryConfig(SecondaryDatabase secDb) Proxy to SecondaryDatabase.getPrivateSecondaryConfig
static Properties	getProps(EnvironmentMutableConfig config) Proxy to EnvironmentMutableConfig.getProps
static ReadOptions	getReadOptions(LockMode lockMode)
static SecondaryAssociation	getSecondaryAssociation(Database db) Proxy to SecondaryDatabase.getSecondaryAssociation
static Cursor[]	getSortedCursors(JoinCursor cursor) Proxy to JoinCursor.getSortedCursors()
static Txn	getTxn(Transaction transaction)
static boolean	getTxnReadCommitted(EnvironmentConfig config) Proxy to EnvironmentConfig.setTxnReadCommitted()
static void	invalidate(Database db) Proxy to Database.invalidate()
static boolean	isCorrupted(Database db)
static Cursor	makeCursor(DatabaseImpl databaseImpl, Locker locker, CursorConfig cursorConfig) Create a Cursor for internal use from a DatabaseImpl.
static Cursor	makeCursor(DatabaseImpl databaseImpl, Locker locker, CursorConfig cursorConfig, boolean retainNonTxnLocks) Create a Cursor for internal use from a DatabaseImpl, specifying retainNonTxnLocks.
static Cursor	makeCursor(Database dbHandle, Locker locker, CursorConfig cursorConfig) Create a Cursor from a DatabaseHandle.
static Cursor	makeCursor(Database dbHandle, Locker locker, CursorConfig cursorConfig, boolean retainNonTxnLocks)
static ExceptionEvent	makeExceptionEvent(Exception e, String n)
static OperationResult	makeResult(int expiration, boolean expirationInHours)
static OperationResult	makeResult(long time)
static OperationResult	makeUpdateResult(int expiration, boolean expirationInHours)
static OperationResult	position(Cursor cursor, DatabaseEntry key, DatabaseEntry data, LockMode lockMode, boolean first) Proxy to Cursor.position().
static OperationResult	putForReplay(Cursor cursor, DatabaseEntry key, DatabaseEntry data, LN ln, int expiration, boolean expirationInHours, PutMode putMode, ReplicationContext repContext) Proxy to Cursor.putForReplay()
static OperationResult	putWithRepContext(Cursor cursor, DatabaseEntry key, DatabaseEntry data, PutMode putMode, ReplicationContext repContext) Proxy to Cursor.putWithRepContext()
static boolean	readPrimaryAfterGet(Cursor cursor, Database priDb, DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode, boolean secDirtyRead, boolean lockPrimaryOnly, boolean allowNoData, Locker locker, SecondaryDatabase secDb, SecondaryAssociation secAssoc) Proxy to Cursor.readPrimaryAfterGet
static OperationResult	retrieveNext(Cursor cursor, DatabaseEntry key, DatabaseEntry data, LockMode lockMode, GetMode getMode) Proxy to Cursor.retrieveNext().
static OperationStatus	search(Cursor cursor, DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbInternal.Search searchMode, LockMode lockMode) Deprecated. use new-style API below instead.
static OperationResult	search(Cursor cursor, DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbInternal.Search searchMode, ReadOptions options) Finds the key according to the Search param.
static OperationResult	search(Cursor cursor, DatabaseEntry key, DatabaseEntry data, LockMode lockMode, CacheMode cacheMode, SearchMode searchMode, boolean countOpStat) Proxy to Cursor.search().
static OperationStatus	searchBoth(Cursor cursor, DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbInternal.Search searchMode, LockMode lockMode) Deprecated. use new-style API below instead.
static OperationResult	searchBoth(Cursor cursor, DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbInternal.Search searchMode, ReadOptions options) Searches with the dups for the given key and finds the dup matching the pKey value, according to the Search param.
static OperationResult	searchForReplay(Cursor cursor, DatabaseEntry key, DatabaseEntry data, LockMode lockMode, SearchMode searchMode) Proxy to Cursor.searchForReplay().
static void	setCheckpointUP(EnvironmentConfig config, boolean checkpointUP) Proxy to EnvironmentConfig.setCheckpointUP()
static void	setCreateEP(EnvironmentConfig config, boolean val) Proxy to EnvironmentConfig.setCreateEP()
static void	setCreateUP(EnvironmentConfig config, boolean val) Proxy to EnvironmentConfig.setCreateUP()
static void	setLoadPropertyFile(EnvironmentConfig config, boolean loadProperties) Proxy to EnvironmentConfig.setLoadPropertyFile()
static void	setNonCloning(Cursor cursor, boolean nonSticky) Deprecated. use CursorConfig.setNonSticky(boolean) instead.
static void	setPreempted(Database db, String dbName, String msg) Proxy to Database.setPreempted()
static void	setTxnReadCommitted(EnvironmentConfig config, boolean txnReadCommitted) Proxy to EnvironmentConfig.setTxnReadCommitted()
static void	setUseExistingConfig(DatabaseConfig config, boolean useExistingConfig) Proxy to DatabaseConfig.setUseExistingConfig()
static void	validate(DatabaseConfig config1, DatabaseConfig config2) Proxy to DatabaseConfig.validate(DatabaseConfig()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_RESULT

public static OperationResult DEFAULT_RESULT

Constructor Detail

DbInternal

public DbInternal()

Method Detail

invalidate

public static void invalidate(Database db)

Proxy to Database.invalidate()

setPreempted

public static void setPreempted(Database db,
                                String dbName,
                                String msg)

Proxy to Database.setPreempted()

getEnvironmentImpl

public static EnvironmentImpl getEnvironmentImpl(Environment env)

Proxy to Environment.getMaybeNullEnvImpl. This method does not check whether the returned envImpl is valid. WARNING: This method will be phased out over time and normally getNonNullEnvImpl should be called instead.

Returns:

the non-null underlying EnvironmentImpl, or null if the env has been closed.

getNonNullEnvImpl

public static EnvironmentImpl getNonNullEnvImpl(Environment env)

Proxy to Environment.getNonNullEnvImpl This method is called to access the underlying EnvironmentImpl when an env is expected to be open, to guard against NPE when the env has been closed. This method does not check whether the env is valid.

Returns:

the non-null, underlying EnvironmentImpl.

Throws:

IllegalStateException - if the env has been closed.

clearEnvImpl

public static void clearEnvImpl(Environment env)

Proxy to Environment.clearEnvImpl

checkOpen

public static EnvironmentImpl checkOpen(Environment env)

Proxy to Environment.checkOpen

closeInternalHandle

public static void closeInternalHandle(Environment env)

Proxy to Environment.closeInternalHandle

getSecondaryAssociation

public static SecondaryAssociation getSecondaryAssociation(Database db)

Proxy to SecondaryDatabase.getSecondaryAssociation

getPrivateSecondaryConfig

public static SecondaryConfig getPrivateSecondaryConfig(SecondaryDatabase secDb)

Proxy to SecondaryDatabase.getPrivateSecondaryConfig

excludeFromOpStats

public static void excludeFromOpStats(Cursor cursor)

Proxy to Cursor.excludeFromOpStats

readPrimaryAfterGet

public static boolean readPrimaryAfterGet(Cursor cursor,
                                          Database priDb,
                                          DatabaseEntry key,
                                          DatabaseEntry pKey,
                                          DatabaseEntry data,
                                          LockMode lockMode,
                                          boolean secDirtyRead,
                                          boolean lockPrimaryOnly,
                                          boolean allowNoData,
                                          Locker locker,
                                          SecondaryDatabase secDb,
                                          SecondaryAssociation secAssoc)

Proxy to Cursor.readPrimaryAfterGet

position

public static OperationResult position(Cursor cursor,
                                       DatabaseEntry key,
                                       DatabaseEntry data,
                                       LockMode lockMode,
                                       boolean first)

Proxy to Cursor.position().

search

public static OperationResult search(Cursor cursor,
                                     DatabaseEntry key,
                                     DatabaseEntry data,
                                     LockMode lockMode,
                                     CacheMode cacheMode,
                                     SearchMode searchMode,
                                     boolean countOpStat)

Proxy to Cursor.search().

searchForReplay

public static OperationResult searchForReplay(Cursor cursor,
                                              DatabaseEntry key,
                                              DatabaseEntry data,
                                              LockMode lockMode,
                                              SearchMode searchMode)

Proxy to Cursor.searchForReplay().

retrieveNext

public static OperationResult retrieveNext(Cursor cursor,
                                           DatabaseEntry key,
                                           DatabaseEntry data,
                                           LockMode lockMode,
                                           GetMode getMode)
                                    throws DatabaseException

Proxy to Cursor.retrieveNext().

Throws:

DatabaseException

advanceCursor

public static boolean advanceCursor(Cursor cursor,
                                    DatabaseEntry key,
                                    DatabaseEntry data)

Proxy to Cursor.advanceCursor()

deleteInternal

public static OperationResult deleteInternal(Cursor cursor,
                                             ReplicationContext repContext)

Proxy to Cursor.deleteInternal()

deleteWithRepContext

public static OperationResult deleteWithRepContext(Cursor cursor,
                                                   ReplicationContext repContext)

Proxy to Cursor.deleteWithRepContext()

putForReplay

public static OperationResult putForReplay(Cursor cursor,
                                           DatabaseEntry key,
                                           DatabaseEntry data,
                                           LN ln,
                                           int expiration,
                                           boolean expirationInHours,
                                           PutMode putMode,
                                           ReplicationContext repContext)

Proxy to Cursor.putForReplay()

putWithRepContext

public static OperationResult putWithRepContext(Cursor cursor,
                                                DatabaseEntry key,
                                                DatabaseEntry data,
                                                PutMode putMode,
                                                ReplicationContext repContext)

Proxy to Cursor.putWithRepContext()

search

public static OperationStatus search(Cursor cursor,
                                     DatabaseEntry key,
                                     DatabaseEntry pKey,
                                     DatabaseEntry data,
                                     DbInternal.Search searchMode,
                                     LockMode lockMode)

Deprecated. use new-style API below instead.

search

public static OperationResult search(Cursor cursor,
                                     DatabaseEntry key,
                                     DatabaseEntry pKey,
                                     DatabaseEntry data,
                                     DbInternal.Search searchMode,
                                     ReadOptions options)

Finds the key according to the Search param. If dups are configured, GT and GTE will land on the first dup for the matching key, while LT and LTE will land on the last dup for the matching key. search() and searchBoth() in this class may eventually be exposed as public JE Cursor methods, but this isn't practical now for the following reasons: + The API design needs more thought. Perhaps Search.EQ should be added. Perhaps existing Cursor methods should be deprecated. + This implementation moves the cursor multiple times and does not release locks on the intermediate records. + This could be implemented more efficiently using lower level cursor code. For example, an LTE search would actually more efficient than the existing GTE search (getSearchKeyRange and getSearchBothRange). These methods are used by KVStore.

searchBoth

public static OperationStatus searchBoth(Cursor cursor,
                                         DatabaseEntry key,
                                         DatabaseEntry pKey,
                                         DatabaseEntry data,
                                         DbInternal.Search searchMode,
                                         LockMode lockMode)

Deprecated. use new-style API below instead.

searchBoth

public static OperationResult searchBoth(Cursor cursor,
                                         DatabaseEntry key,
                                         DatabaseEntry pKey,
                                         DatabaseEntry data,
                                         DbInternal.Search searchMode,
                                         ReadOptions options)

Searches with the dups for the given key and finds the dup matching the pKey value, according to the Search param. See search() for more discussion.

getCursorImpl

public static CursorImpl getCursorImpl(Cursor cursor)

Proxy to Cursor.getCursorImpl()

makeCursor

public static Cursor makeCursor(DatabaseImpl databaseImpl,
                                Locker locker,
                                CursorConfig cursorConfig)

Create a Cursor for internal use from a DatabaseImpl. The retainNonTxnLocks param is true.

makeCursor

public static Cursor makeCursor(DatabaseImpl databaseImpl,
                                Locker locker,
                                CursorConfig cursorConfig,
                                boolean retainNonTxnLocks)

Create a Cursor for internal use from a DatabaseImpl, specifying retainNonTxnLocks.

makeCursor

public static Cursor makeCursor(Database dbHandle,
                                Locker locker,
                                CursorConfig cursorConfig)

Create a Cursor from a DatabaseHandle.

makeCursor

public static Cursor makeCursor(Database dbHandle,
                                Locker locker,
                                CursorConfig cursorConfig,
                                boolean retainNonTxnLocks)

setNonCloning

public static void setNonCloning(Cursor cursor,
                                 boolean nonSticky)

Deprecated. use CursorConfig.setNonSticky(boolean) instead.

isCorrupted

public static boolean isCorrupted(Database db)

getCorruptedCause

public static SecondaryIntegrityException getCorruptedCause(Database db)

getDbImpl

public static DatabaseImpl getDbImpl(Database db)

Proxy to Database.getDbImpl()

getSortedCursors

public static Cursor[] getSortedCursors(JoinCursor cursor)

Proxy to JoinCursor.getSortedCursors()

setLoadPropertyFile

public static void setLoadPropertyFile(EnvironmentConfig config,
                                       boolean loadProperties)

Proxy to EnvironmentConfig.setLoadPropertyFile()

setCreateUP

public static void setCreateUP(EnvironmentConfig config,
                               boolean val)

Proxy to EnvironmentConfig.setCreateUP()

getCreateUP

public static boolean getCreateUP(EnvironmentConfig config)

Proxy to EnvironmentConfig.getCreateUP()

setCreateEP

public static void setCreateEP(EnvironmentConfig config,
                               boolean val)

Proxy to EnvironmentConfig.setCreateEP()

getCreateEP

public static boolean getCreateEP(EnvironmentConfig config)

Proxy to EnvironmentConfig.getCreateEP()

setCheckpointUP

public static void setCheckpointUP(EnvironmentConfig config,
                                   boolean checkpointUP)

Proxy to EnvironmentConfig.setCheckpointUP()

getCheckpointUP

public static boolean getCheckpointUP(EnvironmentConfig config)

Proxy to EnvironmentConfig.getCheckpointUP()

setTxnReadCommitted

public static void setTxnReadCommitted(EnvironmentConfig config,
                                       boolean txnReadCommitted)

Proxy to EnvironmentConfig.setTxnReadCommitted()

getTxnReadCommitted

public static boolean getTxnReadCommitted(EnvironmentConfig config)

Proxy to EnvironmentConfig.setTxnReadCommitted()

cloneMutableConfig

public static EnvironmentMutableConfig cloneMutableConfig(EnvironmentMutableConfig config)

Proxy to EnvironmentMutableConfig.cloneMutableConfig()

checkImmutablePropsForEquality

public static void checkImmutablePropsForEquality(EnvironmentMutableConfig config,
                                                  Properties handleConfigProps)
                                           throws IllegalArgumentException

Proxy to EnvironmentMutableConfig.checkImmutablePropsForEquality()

Throws:

IllegalArgumentException

copyMutablePropsTo

public static void copyMutablePropsTo(EnvironmentMutableConfig config,
                                      EnvironmentMutableConfig toConfig)

Proxy to EnvironmentMutableConfig.copyMutablePropsTo()

disableParameterValidation

public static void disableParameterValidation(EnvironmentMutableConfig config)

Proxy to EnvironmentMutableConfig.validateParams.

getProps

public static Properties getProps(EnvironmentMutableConfig config)

Proxy to EnvironmentMutableConfig.getProps

setUseExistingConfig

public static void setUseExistingConfig(DatabaseConfig config,
                                        boolean useExistingConfig)

Proxy to DatabaseConfig.setUseExistingConfig()

validate

public static void validate(DatabaseConfig config1,
                            DatabaseConfig config2)
                     throws DatabaseException

Proxy to DatabaseConfig.validate(DatabaseConfig()

Throws:

DatabaseException

getLocker

public static Locker getLocker(Transaction txn)
                        throws DatabaseException

Proxy to Transaction.getLocker()

Throws:

DatabaseException

getEnvironment

public static Environment getEnvironment(Transaction txn)
                                  throws DatabaseException

Proxy to Transaction.getEnvironment()

Throws:

DatabaseException

getDefaultTxnConfig

public static TransactionConfig getDefaultTxnConfig(Environment env)

Proxy to Environment.getDefaultTxnConfig()

beginInternalTransaction

public static Transaction beginInternalTransaction(Environment env,
                                                   TransactionConfig config)

makeExceptionEvent

public static ExceptionEvent makeExceptionEvent(Exception e,
                                                String n)

getTxn

public static Txn getTxn(Transaction transaction)

getDiskOrderedCursorImpl

public static DiskOrderedCursorImpl getDiskOrderedCursorImpl(DiskOrderedCursor cursor)

makeResult

public static OperationResult makeResult(long time)

makeResult

public static OperationResult makeResult(int expiration,
                                         boolean expirationInHours)

makeUpdateResult

public static OperationResult makeUpdateResult(int expiration,
                                               boolean expirationInHours)

getReadOptions

public static ReadOptions getReadOptions(LockMode lockMode)