jetbrains.exodus.entitystore

Interface EntityStore

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

PersistentEntityStore

public interface EntityStore
extends java.io.Closeable

EntityStore describes abstract named transactional Entity Store.

See Also:

StoreTransaction, PersistentEntityStore

Method Summary

Modifier and Type	Method and Description
@NotNull StoreTransaction	beginExclusiveTransaction() Starts new exclusive transaction which can be used to read and write data.
@NotNull StoreTransaction	beginReadonlyTransaction() Starts new transaction which can be used to only read data.
@NotNull StoreTransaction	beginTransaction() Starts new transaction which can be used to read and write data.
void	close() Closes the EntityStore.
@Nullable StoreTransaction	getCurrentTransaction()
@NotNull java.lang.String	getLocation() Returns location (path) of the EntityStore's database files on storage device.
@NotNull java.lang.String	getName() Returns unique human readable name of the (@code EntityStore}.

Method Detail

getName

@NotNull
@NotNull java.lang.String getName()

Returns unique human readable name of the (@code EntityStore}.

Returns:

name of the (@code EntityStore}

getLocation

@NotNull
@NotNull java.lang.String getLocation()

Returns location (path) of the EntityStore's database files on storage device. This location as well as getName() value is unique.

Returns:

location of the EntityStore's database files

beginTransaction

@NotNull
@NotNull StoreTransaction beginTransaction()

Starts new transaction which can be used to read and write data.

Returns:

new StoreTransaction instance

See Also:

StoreTransaction

beginExclusiveTransaction

@NotNull
@NotNull StoreTransaction beginExclusiveTransaction()

Starts new exclusive transaction which can be used to read and write data. For given exclusive transaction, it is guaranteed that no other transaction (except read-only ones) can be started on the EntityStore before this one finishes.

Returns:

new StoreTransaction instance

See Also:

StoreTransaction

beginReadonlyTransaction

@NotNull
@NotNull StoreTransaction beginReadonlyTransaction()

Starts new transaction which can be used to only read data.

Returns:

new StoreTransaction instance

See Also:

StoreTransaction, StoreTransaction.isReadonly()

getCurrentTransaction

@Nullable
@Nullable StoreTransaction getCurrentTransaction()

Returns:

transaction instance or null if no transaction is started in current thread

See Also:

StoreTransaction

close

void close()

Closes the EntityStore.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable