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

@Deprecated(since="5.3.0",
            forRemoval=true)
@Experimental
public class ElasticsearchStore
extends ExtensibleStore<org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchDataStructure, org.eclipse.rdf4j.sail.elasticsearchstore.ElasticsearchNamespaceStore>

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in preparation for an Elasticsearch client upgrade; this API will change or be removed in a future release.

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

Field Summary

Fields inherited from class ExtensibleStore

dataStructure, namespaceStore, sailStore

Fields inherited from class AbstractSail

connectionTimeOut, DEFAULT_CONNECTION_TIMEOUT, DEFAULT_ITERATION_SYNC_THRESHOLD, initializationLock

Constructor Summary

Constructors

Constructor	Description
ElasticsearchStore(String hostname, int port, String clusterName, String index)	Deprecated, for removal: This API element is subject to removal in a future version.
ElasticsearchStore(String hostname, int port, String clusterName, String index, ExtensibleStore.Cache cache)	Deprecated, for removal: This API element is subject to removal in a future version.
ElasticsearchStore(org.eclipse.rdf4j.sail.elasticsearchstore.ClientProvider clientPool, String index)	Deprecated, for removal: This API element is subject to removal in a future version.
ElasticsearchStore(org.eclipse.rdf4j.sail.elasticsearchstore.ClientProvider clientPool, String index, ExtensibleStore.Cache cache)	Deprecated, for removal: This API element is subject to removal in a future version.
ElasticsearchStore(org.elasticsearch.client.Client client, String index)	Deprecated, for removal: This API element is subject to removal in a future version.
ElasticsearchStore(org.elasticsearch.client.Client client, String index, ExtensibleStore.Cache cache)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

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

Methods inherited from class ExtensibleStore

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

Methods inherited from class AbstractNotifyingSail

addSailChangedListener, getConnection, notifySailChanged, removeSailChangedListener

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

Methods inherited from class Object

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

Methods inherited from interface Sail

getDataDir, init, setDataDir, shutDown

Constructor Details

ElasticsearchStore

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

Deprecated, for removal: This API element is subject to removal in a future version.

ElasticsearchStore

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

Deprecated, for removal: This API element is subject to removal in a future version.

ElasticsearchStore

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

Deprecated, for removal: This API element is subject to removal in a future version.

ElasticsearchStore

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

Deprecated, for removal: This API element is subject to removal in a future version.

ElasticsearchStore

public ElasticsearchStore(org.elasticsearch.client.Client client,
 String index)

Deprecated, for removal: This API element is subject to removal in a future version.

ElasticsearchStore

public ElasticsearchStore(org.elasticsearch.client.Client client,
 String index,
 ExtensibleStore.Cache cache)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

initializeInternal

protected void initializeInternal()
                           throws SailException

Deprecated, for removal: This API element is subject to removal in a future version.

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

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

setElasticsearchScrollTimeout

public void setElasticsearchScrollTimeout(int timeout)

Deprecated, for removal: This API element is subject to removal in a future version.

getConnectionInternal

protected NotifyingSailConnection getConnectionInternal()
                                                 throws SailException

Deprecated, for removal: This API element is subject to removal in a future version.

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

Deprecated, for removal: This API element is subject to removal in a future version.

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()

Deprecated, for removal: This API element is subject to removal in a future version.

getPort

public int getPort()

Deprecated, for removal: This API element is subject to removal in a future version.

getClusterName

public String getClusterName()

Deprecated, for removal: This API element is subject to removal in a future version.

getIndex

public String getIndex()

Deprecated, for removal: This API element is subject to removal in a future version.

setElasticsearchBulkSize

public void setElasticsearchBulkSize(int size)

Deprecated, for removal: This API element is subject to removal in a future version.

getExtensibleStatementHelper

public ExtensibleStatementHelper getExtensibleStatementHelper()

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

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