com.sleepycat.persist.impl

Class Store

java.lang.Object

com.sleepycat.persist.impl.Store

public class Store
extends Object

Base implementation for EntityStore and RawStore. The methods here correspond directly to those in EntityStore; see EntityStore documentation for details.

Author:

Mark Hayes

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Store.SyncHook For unit testing.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	expectFlush
static String	NAME_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
Store(Environment env, String storeName, StoreConfig config, boolean rawAccess)

Method Summary

Modifier and Type	Method and Description
boolean	attemptRefresh() Attempts to refresh metadata and returns whether a refresh occurred.
void	close()
void	closeClass(Class entityClass)
EvolveStats	evolve(EvolveConfig config)
StoreConfig	getConfig()
Environment	getEnvironment()
EntityModel	getModel()
Mutations	getMutations()
DatabaseConfig	getPrimaryConfig(Class entityClass)
<PK,E> PrimaryIndex<PK,E>	getPrimaryIndex(Class<PK> primaryKeyClass, String primaryKeyClassName, Class<E> entityClass, String entityClassName) A getPrimaryIndex with extra parameters for opening a raw store.
SecondaryConfig	getSecondaryConfig(Class entityClass, String keyName)
<SK,PK,E1,E2 extends E1> SecondaryIndex<SK,PK,E2>	getSecondaryIndex(PrimaryIndex<PK,E1> primaryIndex, Class<E2> entityClass, String entityClassName, Class<SK> keyClass, String keyClassName, String keyName) A getSecondaryIndex with extra parameters for opening a raw store.
Sequence	getSequence(String name)
SequenceConfig	getSequenceConfig(String name)
String	getStoreName()
static Set<String>	getStoreNames(Environment env)
boolean	isReplicaUpgradeMode() For unit testing.
String[]	parseDbName(String wholeName) Parses a whole DB name and returns an array of 2 strings where element 0 is the file name (always null for JE, always non-null for DB core) and element 1 is the logical DB name (always non-null for JE, may be null for DB core).
static String[]	parseDbName(String wholeName, DatabaseNamer namer) Allows passing a namer to a static method for testing.
void	setPrimaryConfig(Class entityClass, DatabaseConfig config)
void	setSecondaryConfig(Class entityClass, String keyName, SecondaryConfig config)
void	setSequenceConfig(String name, SequenceConfig config)
static void	setSyncHook(Store.SyncHook hook) For unit testing.
void	sync()
void	truncateClass(Class entityClass)
void	truncateClass(Transaction txn, Class entityClass)

Methods inherited from class java.lang.Object

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

Field Detail

NAME_SEPARATOR

public static final String NAME_SEPARATOR

See Also:

Constant Field Values

expectFlush

public static boolean expectFlush

Constructor Detail

Store

public Store(Environment env,
             String storeName,
             StoreConfig config,
             boolean rawAccess)
      throws StoreExistsException,
             StoreNotFoundException,
             IncompatibleClassException,
             DatabaseException

Throws:

StoreExistsException

StoreNotFoundException

IncompatibleClassException

DatabaseException

Method Detail

getEnvironment

public Environment getEnvironment()

getConfig

public StoreConfig getConfig()

getStoreName

public String getStoreName()

getStoreNames

public static Set<String> getStoreNames(Environment env)
                                 throws DatabaseException

Throws:

DatabaseException

isReplicaUpgradeMode

public boolean isReplicaUpgradeMode()

For unit testing.

getModel

public EntityModel getModel()

getMutations

public Mutations getMutations()

getPrimaryIndex

public <PK,E> PrimaryIndex<PK,E> getPrimaryIndex(Class<PK> primaryKeyClass,
                                                 String primaryKeyClassName,
                                                 Class<E> entityClass,
                                                 String entityClassName)
                                          throws DatabaseException,
                                                 IndexNotAvailableException

A getPrimaryIndex with extra parameters for opening a raw store. primaryKeyClass and entityClass are used for generic typing; for a raw store, these should always be Object.class and RawObject.class. primaryKeyClassName is used for consistency checking and should be null for a raw store only. entityClassName is used to identify the store and may not be null.

Throws:

DatabaseException

IndexNotAvailableException

getSecondaryIndex

public <SK,PK,E1,E2 extends E1> SecondaryIndex<SK,PK,E2> getSecondaryIndex(PrimaryIndex<PK,E1> primaryIndex,
                                                                           Class<E2> entityClass,
                                                                           String entityClassName,
                                                                           Class<SK> keyClass,
                                                                           String keyClassName,
                                                                           String keyName)
                                                                    throws DatabaseException,
                                                                           IndexNotAvailableException

A getSecondaryIndex with extra parameters for opening a raw store. keyClassName is used for consistency checking and should be null for a raw store only.

Throws:

DatabaseException

IndexNotAvailableException

sync

public void sync()
          throws DatabaseException

Throws:

DatabaseException

truncateClass

public void truncateClass(Class entityClass)
                   throws DatabaseException

Throws:

DatabaseException

truncateClass

public void truncateClass(Transaction txn,
                          Class entityClass)
                   throws DatabaseException

Throws:

DatabaseException

closeClass

public void closeClass(Class entityClass)
                throws DatabaseException

Throws:

DatabaseException

close

public void close()
           throws DatabaseException

Throws:

DatabaseException

getSequence

public Sequence getSequence(String name)
                     throws DatabaseException

Throws:

DatabaseException

getSequenceConfig

public SequenceConfig getSequenceConfig(String name)

setSequenceConfig

public void setSequenceConfig(String name,
                              SequenceConfig config)

getPrimaryConfig

public DatabaseConfig getPrimaryConfig(Class entityClass)

setPrimaryConfig

public void setPrimaryConfig(Class entityClass,
                             DatabaseConfig config)

getSecondaryConfig

public SecondaryConfig getSecondaryConfig(Class entityClass,
                                          String keyName)

setSecondaryConfig

public void setSecondaryConfig(Class entityClass,
                               String keyName,
                               SecondaryConfig config)

parseDbName

public String[] parseDbName(String wholeName)

Parses a whole DB name and returns an array of 2 strings where element 0 is the file name (always null for JE, always non-null for DB core) and element 1 is the logical DB name (always non-null for JE, may be null for DB core).

parseDbName

public static String[] parseDbName(String wholeName,
                                   DatabaseNamer namer)

Allows passing a namer to a static method for testing.

evolve

public EvolveStats evolve(EvolveConfig config)
                   throws DatabaseException

Throws:

DatabaseException

setSyncHook

public static void setSyncHook(Store.SyncHook hook)

For unit testing.

attemptRefresh

public boolean attemptRefresh()

Attempts to refresh metadata and returns whether a refresh occurred. May be called when we expect that updated metadata may be available on disk, and if so could be used to satisfy the user's request. For example, if an index is requested and not available, we can try a refresh and the check for the index again.