Class ElasticsearchStore

java.lang.Object

org.eclipse.rdf4j.sail.helpers.AbstractSail

org.eclipse.rdf4j.sail.helpers.AbstractNotifyingSail

org.eclipse.rdf4j.sail.extensiblestore.ExtensibleStore<org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchDataStructure, org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchNamespaceStore>

org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchStore

All Implemented Interfaces:

FederatedServiceResolverClient, NotifyingSail, Sail

@Experimental
public class ElasticsearchStore
extends ExtensibleStore<org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchDataStructure, org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchNamespaceStore>

An RDF4J SailStore persisted to Elasticsearch.

This is an EXPERIMENTAL feature. Use at your own risk!

Note that, while RDF4J is licensed under the EDL, several ElasticSearch dependencies are licensed under the Elastic License or the SSPL, which may have implications for some projects.
Please consult the ElasticSearch website and Elastic license FAQ for more information.

There is no write-ahead logging, so a failure during a transaction may result in partially persisted changes.

Author:

Håvard Mikkelsen Ottestad

See Also:

• Elastic License FAQ

Nested Class Summary

Nested classes/interfaces inherited from class ExtensibleStore

ExtensibleStore.Cache

Modifier and Type	Class	Description
static enum	ExtensibleStore.Cache

Field Summary

Fields inherited from class ExtensibleStore

dataStructure, namespaceStore, sailStore

Modifier and Type	Field	Description
protected org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchDataStructure	dataStructure
protected org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchNamespaceStore	namespaceStore
protected ExtensibleSailStore	sailStore

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
ElasticsearchStore(co.elastic.clients.elasticsearch.ElasticsearchClient client, String index)
ElasticsearchStore(co.elastic.clients.elasticsearch.ElasticsearchClient client, String index, ExtensibleStore.Cache cache)
ElasticsearchStore(String hostname, int port, String clusterName, String index)
ElasticsearchStore(String hostname, int port, String clusterName, String index, ExtensibleStore.Cache cache)
ElasticsearchStore(org.eclipse.rdf4j.sail.elasticsearchstore.ClientProvider clientPool, String index)
ElasticsearchStore(org.eclipse.rdf4j.sail.elasticsearchstore.ClientProvider clientPool, String index, ExtensibleStore.Cache cache)

Method Summary

Modifier and Type	Method	Description
String	getClusterName()
protected NotifyingSailConnection	getConnectionInternal()	Returns a store-specific SailConnection object.
ExtensibleStatementHelper	getExtensibleStatementHelper()
String	getHostname()
String	getIndex()
int	getPort()
protected void	initializeInternal()	Do store-specific operations to initialize the store.
boolean	isWritable()	Checks whether this Sail object is writable, i.e. if the data contained in this Sail object can be changed.
void	setElasticsearchBulkSize(int size)
void	setElasticsearchScrollTimeout(int timeout)
protected void	shutDownInternal()	Do store-specific operations to ensure proper shutdown of the store.
void	waitForElasticsearch(int time, TemporalUnit timeUnit)

Methods inherited from class ExtensibleStore

getCollectionFactory, getDefaultIsolationLevel, getEvaluationStatisticsType, getEvaluationStrategyFactory, getFederatedServiceResolver, getSupportedIsolationLevels, getValueFactory, setEvaluationStrategyFactory, setFederatedServiceResolver

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.
IsolationLevel	getDefaultIsolationLevel()	Retrieves the default IsolationLevel level on which transactions in this Sail operate.
EvaluationStatisticsEnum	getEvaluationStatisticsType()
EvaluationStrategyFactory	getEvaluationStrategyFactory()
FederatedServiceResolver	getFederatedServiceResolver()	Gets the FederatedServiceResolver used by this client.
List<IsolationLevel>	getSupportedIsolationLevels()	Retrieve the IsolationLevels supported by this SAIL, ordered by increasing complexity.
ValueFactory	getValueFactory()	Gets a ValueFactory object that can be used to create IRI-, blank node-, literal- and statement objects.
void	setEvaluationStrategyFactory(EvaluationStrategyFactory evalStratFactory)
void	setFederatedServiceResolver(FederatedServiceResolver resolver)	Sets the FederatedServiceResolver to use for this client.

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, getDefaultQueryEvaluationMode, getIterationCacheSyncThreshold, init, isInitialized, isTrackResultSize, removeSupportedIsolationLevel, setConnectionTimeOut, setDataDir, setDefaultIsolationLevel, setDefaultQueryEvaluationMode, setIterationCacheSyncThreshold, setSupportedIsolationLevels, setSupportedIsolationLevels, setTrackResultSize, shutDown, 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.
QueryEvaluationMode	getDefaultQueryEvaluationMode()
long	getIterationCacheSyncThreshold()	Retrieves the currently configured threshold for syncing query evaluation iteration caches to disk.
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	setDataDir(File dataDir)	Sets the data directory for the Sail.
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.
void	shutDown()	Shuts down the Sail, giving it the opportunity to synchronize any stale data.
String	toString()

Methods inherited from class Object

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

Constructor Details

ElasticsearchStore

public ElasticsearchStore(String hostname,
 int port,
 String clusterName,
 String index)

ElasticsearchStore

public ElasticsearchStore(String hostname,
 int port,
 String clusterName,
 String index,
 ExtensibleStore.Cache cache)

ElasticsearchStore

public ElasticsearchStore(org.eclipse.rdf4j.sail.elasticsearchstore.ClientProvider clientPool,
 String index)

ElasticsearchStore

public ElasticsearchStore(org.eclipse.rdf4j.sail.elasticsearchstore.ClientProvider clientPool,
 String index,
 ExtensibleStore.Cache cache)

ElasticsearchStore

public ElasticsearchStore(co.elastic.clients.elasticsearch.ElasticsearchClient client,
 String index)

ElasticsearchStore

public ElasticsearchStore(co.elastic.clients.elasticsearch.ElasticsearchClient client,
 String index,
 ExtensibleStore.Cache cache)

Method Details

initializeInternal

protected void initializeInternal()
                           throws SailException

Description copied from class: AbstractSail

Do store-specific operations to initialize the store. The default implementation of this method does nothing.

Overrides:

initializeInternal in class ExtensibleStore<org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchDataStructure, org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchNamespaceStore>

Throws:

SailException

shutDownInternal

protected void shutDownInternal()
                         throws SailException

Description copied from class: AbstractSail

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

Overrides:

shutDownInternal in class ExtensibleStore<org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchDataStructure, org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchNamespaceStore>

Throws:

SailException

waitForElasticsearch

public void waitForElasticsearch(int time,
 TemporalUnit timeUnit)

setElasticsearchScrollTimeout

public void setElasticsearchScrollTimeout(int timeout)

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

isWritable

public boolean isWritable()
                   throws SailException

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.

Throws:

SailException

getHostname

public String getHostname()

getPort

public int getPort()

getClusterName

public String getClusterName()

getIndex

public String getIndex()

setElasticsearchBulkSize

public void setElasticsearchBulkSize(int size)

getExtensibleStatementHelper

public ExtensibleStatementHelper getExtensibleStatementHelper()

Overrides:

getExtensibleStatementHelper in class ExtensibleStore<org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchDataStructure, org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchNamespaceStore>