Class LmdbStore

java.lang.Object

org.eclipse.rdf4j.sail.helpers.AbstractSail

org.eclipse.rdf4j.sail.helpers.AbstractNotifyingSail

org.eclipse.rdf4j.sail.lmdb.LmdbStore

All Implemented Interfaces:

FederatedServiceResolverClient, NotifyingSail, Sail

@Experimental
public class LmdbStore
extends AbstractNotifyingSail
implements FederatedServiceResolverClient

A SAIL implementation using LMDB for storing and querying its data.

Field Summary

Fields inherited from class AbstractSail

connectionTimeOut, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_ITERATION_SYNC_THRESHOLD, initializationLock

Modifier and Type	Field	Description
protected long	connectionTimeOut	Connection timeout on shutdown (in ms).
protected static final long	DEFAULT_CONNECTION_TIMEOUT	Default connection timeout on shutdown: 20,000 milliseconds (20 seconds).
protected static final long	DEFAULT_ITERATION_SYNC_THRESHOLD	default value for the Iteration item sync threshold
protected final ReentrantReadWriteLock	initializationLock	Lock used to synchronize the initialization state of a sail.

Constructor Summary

Constructors

Constructor	Description
LmdbStore()	Creates a new LmdbStore with default settings.
LmdbStore(File dataDir)	Creates a new LmdbStore with default settings.
LmdbStore(File dataDir, LmdbStoreConfig config)
LmdbStore(LmdbStoreConfig config)	Creates a new LmdbStore.

Method Summary

Modifier and Type	Method	Description
Supplier<CollectionFactory>	getCollectionFactory()	Gets a CollectionFactory that may be optimized for this store and may or may not use disk or other resources.
protected NotifyingSailConnection	getConnectionInternal()	Returns a store-specific SailConnection object.
EvaluationStrategyFactory	getEvaluationStrategyFactory()
FederatedServiceResolver	getFederatedServiceResolver()	Gets the FederatedServiceResolver used by this client.
boolean	getPageCardinalityEstimator()
protected Lock	getTransactionLock(IsolationLevel level)	This call will block when IsolationLevels.NONE is provided when there are active transactions with a higher isolation and block when a higher isolation is provided when there are active transactions with IsolationLevels.NONE isolation.
ValueFactory	getValueFactory()	Gets a ValueFactory object that can be used to create IRI-, blank node-, literal- and statement objects.
protected void	initializeInternal()	Initializes this LmdbStore.
boolean	isWritable()	Checks whether this Sail object is writable, i.e. if the data contained in this Sail object can be changed.
void	setDataDir(File dataDir)	Sets the data directory for the Sail.
void	setEvaluationStrategyFactory(EvaluationStrategyFactory factory)	Sets the EvaluationStrategy to use.
void	setFederatedServiceResolver(FederatedServiceResolver resolver)	Overrides the FederatedServiceResolver used by this instance, but the given resolver is not shutDown when this instance is.
void	shutDown()	Shuts down the Sail, giving it the opportunity to synchronize any stale data.
protected void	shutDownInternal()	Do store-specific operations to ensure proper shutdown of the store.

Methods inherited from class AbstractNotifyingSail

addSailChangedListener, getConnection, notifySailChanged, removeSailChangedListener

Modifier and Type	Method	Description
void	addSailChangedListener(SailChangedListener listener)	Adds the specified SailChangedListener to receive events when the data in this Sail object changes.
NotifyingSailConnection	getConnection()	Opens a connection on the Sail which can be used to query and update data.
void	notifySailChanged(SailChangedEvent event)	Notifies all registered SailChangedListener's of changes to the contents of this Sail.
void	removeSailChangedListener(SailChangedListener listener)	Removes the specified SailChangedListener so that it no longer receives events from this Sail object.

Methods inherited from class AbstractSail

addSupportedIsolationLevel, connectionClosed, debugEnabled, getDataDir, getDefaultIsolationLevel, getDefaultQueryEvaluationMode, getIterationCacheSyncThreshold, getSupportedIsolationLevels, init, isInitialized, isTrackResultSize, removeSupportedIsolationLevel, setConnectionTimeOut, setDefaultIsolationLevel, setDefaultQueryEvaluationMode, setIterationCacheSyncThreshold, setSupportedIsolationLevels, setSupportedIsolationLevels, setTrackResultSize, toString

Modifier and Type	Method	Description
protected void	addSupportedIsolationLevel(IsolationLevels level)	Appends the provided IsolationLevels to the SAIL's list of supported isolation levels.
protected void	connectionClosed(SailConnection connection)	Signals to the store that the supplied connection has been closed; called by AbstractSailConnection.close().
protected static boolean	debugEnabled()
File	getDataDir()	Gets the Sail's data directory.
IsolationLevel	getDefaultIsolationLevel()	Retrieves the default IsolationLevel level on which transactions in this Sail operate.
QueryEvaluationMode	getDefaultQueryEvaluationMode()
long	getIterationCacheSyncThreshold()	Retrieves the currently configured threshold for syncing query evaluation iteration caches to disk.
List<IsolationLevel>	getSupportedIsolationLevels()	Retrieve the IsolationLevels supported by this SAIL, ordered by increasing complexity.
void	init()	Initializes the Sail.
protected boolean	isInitialized()	Checks whether the Sail has been initialized.
boolean	isTrackResultSize()	Returns the status of the result size tracking for the query plan.
protected void	removeSupportedIsolationLevel(IsolationLevel level)	Removes all occurrences of the provided IsolationLevels in the list of supported Isolation levels.
void	setConnectionTimeOut(long connectionTimeOut)	Set connection timeout on shutdown (in ms).
void	setDefaultIsolationLevel(IsolationLevel defaultIsolationLevel)	Sets the default IsolationLevel on which transactions in this Sail operate.
void	setDefaultQueryEvaluationMode(QueryEvaluationMode defaultQueryEvaluationMode)
void	setIterationCacheSyncThreshold(long iterationCacheSyncThreshold)	Set the threshold for syncing query evaluation iteration caches to disk.
protected void	setSupportedIsolationLevels(List<IsolationLevel> supportedIsolationLevels)	Sets the list of supported IsolationLevelss for this SAIL.
protected void	setSupportedIsolationLevels(IsolationLevel... supportedIsolationLevels)	Sets the list of supported IsolationLevelss for this SAIL.
void	setTrackResultSize(boolean trackResultSize)	Enable or disable results size tracking for the query plan.
String	toString()

Methods inherited from class Object

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

Constructor Details

LmdbStore

public LmdbStore()

Creates a new LmdbStore with default settings.

LmdbStore

public LmdbStore(LmdbStoreConfig config)

Creates a new LmdbStore.

LmdbStore

public LmdbStore(File dataDir)

Creates a new LmdbStore with default settings.

LmdbStore

public LmdbStore(File dataDir,
 LmdbStoreConfig config)

Method Details

setDataDir

public void setDataDir(File dataDir)

Description copied from interface: Sail

Sets the data directory for the Sail. The Sail can use this directory for storage of data, parameters, etc. This directory must be set before the Sail is

invalid reference

initialized

.

Specified by:

setDataDir in interface Sail

Overrides:

setDataDir in class AbstractSail

getEvaluationStrategyFactory

public EvaluationStrategyFactory getEvaluationStrategyFactory()

Returns:

Returns the EvaluationStrategy.

getPageCardinalityEstimator

public boolean getPageCardinalityEstimator()

setEvaluationStrategyFactory

public void setEvaluationStrategyFactory(EvaluationStrategyFactory factory)

Sets the EvaluationStrategy to use.

getFederatedServiceResolver

public FederatedServiceResolver getFederatedServiceResolver()

Description copied from interface: FederatedServiceResolverClient

Gets the FederatedServiceResolver used by this client.

Specified by:

getFederatedServiceResolver in interface FederatedServiceResolverClient

Returns:

Returns the SERVICE resolver.

setFederatedServiceResolver

public void setFederatedServiceResolver(FederatedServiceResolver resolver)

Overrides the FederatedServiceResolver used by this instance, but the given resolver is not shutDown when this instance is.

Specified by:

setFederatedServiceResolver in interface FederatedServiceResolverClient

Parameters:

resolver - The SERVICE resolver to set.

initializeInternal

protected void initializeInternal()
                           throws SailException

Initializes this LmdbStore.

Overrides:

initializeInternal in class AbstractSail

Throws:

SailException - If this LmdbStore could not be initialized using the parameters that have been set.

shutDownInternal

protected void shutDownInternal()
                         throws SailException

Description copied from class: AbstractSail

Do store-specific operations to ensure proper shutdown of the store.

Specified by:

shutDownInternal in class AbstractSail

Throws:

SailException

shutDown

public void shutDown()
              throws SailException

Description copied from interface: Sail

Shuts down the Sail, giving it the opportunity to synchronize any stale data. Care should be taken that all initialized Sails are being shut down before an application exits to avoid potential loss of data. Once shut down, a Sail can no longer be used until it is re-initialized.

Specified by:

shutDown in interface Sail

Overrides:

shutDown in class AbstractSail

Throws:

SailException - If the Sail object encountered an error or unexpected situation internally.

isWritable

public boolean isWritable()

Description copied from interface: Sail

Checks whether this Sail object is writable, i.e. if the data contained in this Sail object can be changed.

Specified by:

isWritable in interface Sail

getConnectionInternal

protected NotifyingSailConnection getConnectionInternal()
                                                 throws SailException

Description copied from class: AbstractSail

Returns a store-specific SailConnection object.

Specified by:

getConnectionInternal in class AbstractNotifyingSail

Returns:

A connection to the store.

Throws:

SailException

getValueFactory

public ValueFactory getValueFactory()

Description copied from interface: Sail

Gets a ValueFactory object that can be used to create IRI-, blank node-, literal- and statement objects.

Specified by:

getValueFactory in interface Sail

Returns:

a ValueFactory object for this Sail object.

getTransactionLock

protected Lock getTransactionLock(IsolationLevel level)
                           throws SailException

This call will block when IsolationLevels.NONE is provided when there are active transactions with a higher isolation and block when a higher isolation is provided when there are active transactions with IsolationLevels.NONE isolation. Store is either exclusively in IsolationLevels.NONE isolation with potentially zero or more transactions, or exclusively in higher isolation mode with potentially zero or more transactions.

Parameters:

level - indicating desired mode IsolationLevels.NONE or higher

Returns:

Lock used to prevent Store from switching isolation modes

Throws:

SailException

getCollectionFactory

public Supplier<CollectionFactory> getCollectionFactory()

Description copied from interface: Sail

Gets a CollectionFactory that may be optimized for this store and may or may not use disk or other resources.

Specified by:

getCollectionFactory in interface Sail

Returns:

a CollectionFactory