jetbrains.exodus.entitystore

Interface PersistentEntityStore

All Superinterfaces:

java.lang.AutoCloseable, Backupable, java.io.Closeable, EntityStore

public interface PersistentEntityStore
extends EntityStore, Backupable

PersistentEntityStore is an EntityStore operating above Environment instance. PersistentEntityStore uses BlobVault to store blobs that have size greater than PersistentEntityStoreConfig.getMaxInPlaceBlobSize() value which is by default equal to 10000. Default BlobVault stores blobs as separate files in the blobs subdirectory of PersistentEntityStore's location (EntityStore.getLocation()). PersistentEntityStore's location is equal to underlying Environment's location. So on storage device, the database for PersistentEntityStore consists of underlying Environment's database files plus the blobs subdirectory.

See Also:

EntityStore, Environment, BlobVault

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all the data in the PersistentEntityStore.
<T> T	computeInExclusiveTransaction(@NotNull StoreTransactionalComputable<T> computable) Computes and returns a value by calling specified computable in a new exclusive transaction.
<T> T	computeInReadonlyTransaction(@NotNull StoreTransactionalComputable<T> computable) Computes and returns a value by calling specified computable in a new read-only transaction.
<T> T	computeInTransaction(@NotNull StoreTransactionalComputable<T> computable) Computes and returns a value by calling specified computable in a new transaction.
void	executeInExclusiveTransaction(@NotNull StoreTransactionalExecutable executable) Executes specified executable in a new exclusive transaction.
void	executeInReadonlyTransaction(@NotNull StoreTransactionalExecutable executable) Executes specified executable in a new read-only transaction.
void	executeInTransaction(@NotNull StoreTransactionalExecutable executable) Executes specified executable in a new transaction.
@NotNull jetbrains.exodus.core.execution.MultiThreadDelegatingJobProcessor	getAsyncProcessor() Job processor used by the PersistentEntityStore for background caching activities.
@NotNull BlobVault	getBlobVault()
@NotNull PersistentEntityStoreConfig	getConfig() Returns PersistentEntityStoreConfig instance used during creation of the PersistentEntityStore.
Entity	getEntity(@NotNull EntityId id) Returns Entity by specified EntityId.
@NotNull java.lang.String	getEntityType(int entityTypeId) Returns entity type of specified entity type id.
int	getEntityTypeId(@NotNull java.lang.String entityType) Returns integer id of specified entity type.
@NotNull Environment	getEnvironment()
@NotNull Statistics	getStatistics()
long	getUsableSpace()
void	registerCustomPropertyType(@NotNull StoreTransaction txn, @NotNull java.lang.Class<? extends java.lang.Comparable> clazz, @NotNull ComparableBinding binding) Registers custom property type extending Comparable.
void	renameEntityType(@NotNull java.lang.String oldEntityTypeName, @NotNull java.lang.String newEntityTypeName) Renames entity type.

Methods inherited from interface jetbrains.exodus.entitystore.EntityStore

beginExclusiveTransaction, beginReadonlyTransaction, beginTransaction, close, getCurrentTransaction, getLocation, getName

Methods inherited from interface jetbrains.exodus.backup.Backupable

getBackupStrategy

Method Detail

getEnvironment

@NotNull
@NotNull Environment getEnvironment()

Returns:

underlying Environment instance

clear

void clear()

Clears all the data in the PersistentEntityStore. It is safe to clear PersistentEntityStore with lots of parallel transactions. Make sure all InputStream instances got from the blob vault are closed.

executeInTransaction

void executeInTransaction(@NotNull
                          @NotNull StoreTransactionalExecutable executable)

Executes specified executable in a new transaction. If transaction cannot be flushed after StoreTransactionalExecutable.execute(StoreTransaction) is called, the executable is executed once more until the transaction is finally flushed.

Parameters:

executable - transactional executable

See Also:

StoreTransactionalExecutable

executeInExclusiveTransaction

void executeInExclusiveTransaction(@NotNull
                                   @NotNull StoreTransactionalExecutable executable)

Executes specified executable in a new exclusive transaction. Exclusive transaction guarantees that no one other transaction can even start before this one is finished, so the executable is executed once.

Parameters:

executable - transactional executable

See Also:

StoreTransactionalExecutable

executeInReadonlyTransaction

void executeInReadonlyTransaction(@NotNull
                                  @NotNull StoreTransactionalExecutable executable)

Executes specified executable in a new read-only transaction. StoreTransactionalExecutable.execute(StoreTransaction) is called once since the transaction is read-only, and it is never flushed.

Parameters:

executable - transactional executable

See Also:

StoreTransactionalExecutable, StoreTransaction.isReadonly()

computeInTransaction

<T> T computeInTransaction(@NotNull
                           @NotNull StoreTransactionalComputable<T> computable)

Computes and returns a value by calling specified computable in a new transaction. If transaction cannot be flushed after StoreTransactionalComputable.compute(StoreTransaction) is called, the computable is computed once more until the transaction is finally flushed.

Parameters:

computable - transactional computable

See Also:

StoreTransactionalComputable

computeInExclusiveTransaction

<T> T computeInExclusiveTransaction(@NotNull
                                    @NotNull StoreTransactionalComputable<T> computable)

Computes and returns a value by calling specified computable in a new exclusive transaction. Exclusive transaction guarantees that no one other transaction can even start before this one is finished, so the computable is computed once.

Parameters:

computable - transactional computable

See Also:

StoreTransactionalComputable

computeInReadonlyTransaction

<T> T computeInReadonlyTransaction(@NotNull
                                   @NotNull StoreTransactionalComputable<T> computable)

Computes and returns a value by calling specified computable in a new read-only transaction. StoreTransactionalComputable.compute(StoreTransaction) is called once since the transaction is read-only, and it is never flushed.

Parameters:

computable - transactional computable

See Also:

StoreTransactionalComputable, StoreTransaction.isReadonly()

getBlobVault

@NotNull
@NotNull BlobVault getBlobVault()

Returns:

BlobVault which is used for managing blobs

registerCustomPropertyType

void registerCustomPropertyType(@NotNull
                                @NotNull StoreTransaction txn,
                                @NotNull
                                @NotNull java.lang.Class<? extends java.lang.Comparable> clazz,
                                @NotNull
                                @NotNull ComparableBinding binding)

Registers custom property type extending Comparable. Values of specified clazz can be passed then to Entity.setProperty(String, Comparable). ComparableBinding describes the way property values are serialized/deserialized to/from raw presentation as ByteIterable instances.

Parameters:

txn - StoreTransaction instance

clazz - class of property values extending Comparable

binding - ComparableBinding

See Also:

Entity.setProperty(String, Comparable), ComparableBinding, ByteIterable

getEntity

Entity getEntity(@NotNull
                 @NotNull EntityId id)

Returns Entity by specified EntityId.

Parameters:

id - entity id

Returns:

Entity instance

Throws:

EntityRemovedInDatabaseException - entity by specified if doesn't exist in the database

See Also:

Entity.getId()

getEntityTypeId

int getEntityTypeId(@NotNull
                    @NotNull java.lang.String entityType)

Returns integer id of specified entity type.

Parameters:

entityType - entity type

Returns:

integer id of entity type

See Also:

EntityId.getTypeId()

getEntityType

@NotNull
@NotNull java.lang.String getEntityType(int entityTypeId)

Returns entity type of specified entity type id.

Parameters:

entityTypeId - entity type id

Returns:

entity type of specified entity type id

See Also:

EntityId.getTypeId()

renameEntityType

void renameEntityType(@NotNull
                      @NotNull java.lang.String oldEntityTypeName,
                      @NotNull
                      @NotNull java.lang.String newEntityTypeName)

Renames entity type. StoreTransaction should started in current thread.

Parameters:

oldEntityTypeName - old entity type name

newEntityTypeName - new entity type name

getUsableSpace

long getUsableSpace()

Returns:

The number of available bytes on the partition where the database is located

getConfig

@NotNull
@NotNull PersistentEntityStoreConfig getConfig()

Returns PersistentEntityStoreConfig instance used during creation of the PersistentEntityStore. If no config was specified and no setting was mutated, then returned config has the same settings as PersistentEntityStoreConfig.DEFAULT.

Returns:

PersistentEntityStoreConfig instance

getAsyncProcessor

@NotNull
@NotNull jetbrains.exodus.core.execution.MultiThreadDelegatingJobProcessor getAsyncProcessor()

Job processor used by the PersistentEntityStore for background caching activities. Allows to indirectly estimate load of the PersistentEntityStore. E.g., if it has numerous pending caching jobs (say, thousands) then most likely caching doesn't work well and the PersistentEntityStore looks overloaded.

Returns:

job processor used for background caching activities

getStatistics

@NotNull
@NotNull Statistics getStatistics()

Returns:

statistics of this PersistentEntityStore instance

See Also:

PersistentEntityStoreConfig.GATHER_STATISTICS