sirius.db.es

Class Elastic

java.lang.Object

sirius.db.mixing.BaseMapper<ElasticEntity,ElasticConstraint,ElasticQuery<? extends ElasticEntity>>

sirius.db.es.Elastic

public class Elastic
extends BaseMapper<ElasticEntity,ElasticConstraint,ElasticQuery<? extends ElasticEntity>>

Provides the mapper used to communicate with Elasticsearch.

Field Summary

Fields

Modifier and Type	Field and Description
protected sirius.kernel.health.Average	callDuration
protected Map<EntityDescriptor,Property>	discriminatorTable
protected boolean	dockerDetected
static ElasticFilterFactory	FILTERS Constains the factory used to generate filters for a ElasticQuery.
static String	ID_FIELD Contains the name of the ID field used by Elasticsearch
static sirius.kernel.health.Log	LOG Contains the logger used by everything related to Elasticsearch
protected sirius.kernel.async.Future	readyFuture
protected Map<EntityDescriptor,Property>	routeTable

Fields inherited from class sirius.db.mixing.BaseMapper

mixing, VERSION

Constructor Summary

Constructors

Constructor and Description
Elastic()

Method Summary

Modifier and Type	Method and Description
BulkContext	batch() Creates a batch context used for bulk updates.
protected void	createEntity(ElasticEntity entity, EntityDescriptor ed) Creates a new entity in the underlying database.
protected void	deleteEntity(ElasticEntity entity, boolean force, EntityDescriptor ed) Deletes the give entity from the database.
protected String	determineId(ElasticEntity entity) Determines the id of the entity.
protected String	determineIndex(EntityDescriptor ed, ElasticEntity entity) Determines the index to use for the given entity.
protected String	determineRouting(EntityDescriptor ed, ElasticEntity entity) Determines the routing value to be used for the given entity.
protected String	determineTypeName(EntityDescriptor ed) Determines the type name used for a given entity type.
protected String	determineYearIndex(EntityDescriptor ed, Object year) Computes the effective index name for the given descriptor and year.
FilterFactory<ElasticConstraint>	filters() Returns the filter factory which is used by this mapper.
protected <E extends ElasticEntity> Optional<E>	findEntity(E entity)
protected <E extends ElasticEntity> Optional<E>	findEntity(Object id, EntityDescriptor ed, Function<String,sirius.kernel.commons.Value> context) Tries to find the entity with the given id.
LowLevelClient	getLowLevelClient() Provides access to the underlying low level client.
sirius.kernel.async.Future	getReadyFuture() Provides a future which is fulfilled once the Elasticsearch client is fully initialized.
boolean	isConfigured() Determines if an appropriate configuration is available (e.g. a host to connect to).
boolean	isRouted(EntityDescriptor ed) Determines if the entity of the given descriptor requires a routing value.
boolean	isStoredPerYear(EntityDescriptor descriptor) Determines if the given entity type is stored per year.
protected static ElasticEntity	make(EntityDescriptor ed, com.alibaba.fastjson.JSONObject obj) Creates a new instance of the given entity type for the given data.
static ContextInfo	routedBy(String value) Provides a "routed by" context for BaseMapper.find(Class, Object, ContextInfo...).
<E extends ElasticEntity> ElasticQuery<E>	select(Class<E> type) Creates a query for the given type.
protected boolean	toJSON(EntityDescriptor ed, ElasticEntity entity, com.alibaba.fastjson.JSONObject data) Transforms the given entity to JSON.
protected void	updateDiscriminatorTable(EntityDescriptor ed, Property p)
protected void	updateEntity(ElasticEntity entity, boolean force, EntityDescriptor ed) Updates an existing entity in the underlying database.
protected void	updateRouteTable(EntityDescriptor ed, Property p)

Methods inherited from class sirius.db.mixing.BaseMapper

delete, find, findOrFail, forceDelete, hasValidationWarnings, override, performDelete, performUpdate, refreshOrFail, resolve, resolveOrFail, tryDelete, tryRefresh, tryUpdate, update, validate

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final sirius.kernel.health.Log LOG

Contains the logger used by everything related to Elasticsearch

FILTERS

public static final ElasticFilterFactory FILTERS

Constains the factory used to generate filters for a ElasticQuery.

ID_FIELD

public static final String ID_FIELD

Contains the name of the ID field used by Elasticsearch

See Also:

Constant Field Values

readyFuture

protected sirius.kernel.async.Future readyFuture

callDuration

protected sirius.kernel.health.Average callDuration

routeTable

protected Map<EntityDescriptor,Property> routeTable

discriminatorTable

protected Map<EntityDescriptor,Property> discriminatorTable

dockerDetected

protected boolean dockerDetected

Constructor Detail

Elastic

public Elastic()

Method Detail

updateRouteTable

protected void updateRouteTable(EntityDescriptor ed,
                                Property p)

updateDiscriminatorTable

protected void updateDiscriminatorTable(EntityDescriptor ed,
                                        Property p)

getReadyFuture

public sirius.kernel.async.Future getReadyFuture()

Provides a future which is fulfilled once the Elasticsearch client is fully initialized.

Returns:

a future which indicates when Elasticsearch is ready

getLowLevelClient

public LowLevelClient getLowLevelClient()

Provides access to the underlying low level client.

Returns:

the underlying low level client used to perform the HTTP requests against Elasticsearch.

createEntity

protected void createEntity(ElasticEntity entity,
                            EntityDescriptor ed)
                     throws Exception

Description copied from class: BaseMapper

Creates a new entity in the underlying database.

Specified by:

createEntity in class BaseMapper<ElasticEntity,ElasticConstraint,ElasticQuery<? extends ElasticEntity>>

Parameters:

entity - the entity to create

ed - the descriptor of the entity

Throws:

Exception - in case of an database error

determineRouting

@Nullable
protected String determineRouting(EntityDescriptor ed,
                                            ElasticEntity entity)

Determines the routing value to be used for the given entity.

Parameters:

ed - the entity descriptor of the entity

entity - the entity to fetch the routing value from

Returns:

the routing value to use

updateEntity

protected void updateEntity(ElasticEntity entity,
                            boolean force,
                            EntityDescriptor ed)
                     throws Exception

Description copied from class: BaseMapper

Updates an existing entity in the underlying database.

Specified by:

updateEntity in class BaseMapper<ElasticEntity,ElasticConstraint,ElasticQuery<? extends ElasticEntity>>

Parameters:

entity - the entity to update

force - ture if the update is forced and optimistic locking must be disabled

ed - the descriptor of the entity

Throws:

Exception - in case of an database error

toJSON

protected boolean toJSON(EntityDescriptor ed,
                         ElasticEntity entity,
                         com.alibaba.fastjson.JSONObject data)

Transforms the given entity to JSON.

Parameters:

entity - the entity to transform

ed - the descriptor of the entity

data - the target JSON to fill

Returns:

true if at least on property has changed, false otherwise

determineId

protected String determineId(ElasticEntity entity)

Determines the id of the entity.

This will either return the stored ID or create a new one, if the entity is still new. If the entity is stored per year, the year will be prepended to the ID itself to determine the index in determineIndex(EntityDescriptor, ElasticEntity).

Parameters:

entity - the entity to determine the id for

Returns:

the id to use for this entity

determineIndex

protected String determineIndex(EntityDescriptor ed,
                                ElasticEntity entity)

Determines the index to use for the given entity.

This will either be the relation name or if the entity is stored per year, it will be determined by determineYearIndex(EntityDescriptor, Object).

Parameters:

ed - the descriptor of the entity

entity - the entity to determine the index for

Returns:

the index name to use for the given entity.

determineYearIndex

protected String determineYearIndex(EntityDescriptor ed,
                                    Object year)

Computes the effective index name for the given descriptor and year.

This will be ed.getRelationName() + "-" + year

Parameters:

ed - the descriptor of the entity

year - the year of the index

Returns:

the index name for the given descriptor and year

determineTypeName

protected String determineTypeName(EntityDescriptor ed)

Determines the type name used for a given entity type.

Parameters:

ed - the descriptor of the entity

Returns:

the type name to use

deleteEntity

protected void deleteEntity(ElasticEntity entity,
                            boolean force,
                            EntityDescriptor ed)
                     throws Exception

Description copied from class: BaseMapper

Deletes the give entity from the database.

Specified by:

deleteEntity in class BaseMapper<ElasticEntity,ElasticConstraint,ElasticQuery<? extends ElasticEntity>>

Parameters:

entity - the entity to delete

force - true if the delete is forced and optimistic locking must be disabled

ed - the descriptor of the entity

Throws:

Exception - in case of an database error

make

protected static ElasticEntity make(EntityDescriptor ed,
                                    com.alibaba.fastjson.JSONObject obj)

Creates a new instance of the given entity type for the given data.

Parameters:

ed - the descriptor of the entity type

obj - the JSON data to transform

Returns:

a new entity based on the given data

routedBy

public static ContextInfo routedBy(String value)

Provides a "routed by" context for BaseMapper.find(Class, Object, ContextInfo...).

Parameters:

value - the routing value to use

Returns:

the value wrapped as context info

findEntity

protected <E extends ElasticEntity> Optional<E> findEntity(Object id,
                                                           EntityDescriptor ed,
                                                           Function<String,sirius.kernel.commons.Value> context)
                                                    throws Exception

Description copied from class: BaseMapper

Tries to find the entity with the given id.

Specified by:

findEntity in class BaseMapper<ElasticEntity,ElasticConstraint,ElasticQuery<? extends ElasticEntity>>

Type Parameters:

E - the effective type of the entity

Parameters:

id - the id of the entity to find

ed - the descriptor of the entity to find

context - the advanced search context which can be populated using ContextInfo in BaseMapper.find(Class, Object, ContextInfo...)

Returns:

the entity wrapped as optional or an empty optional if the entity was not found

Throws:

Exception - in case of a database error

isRouted

public boolean isRouted(EntityDescriptor ed)

Determines if the entity of the given descriptor requires a routing value.

Parameters:

ed - the descriptor of the entity to check

Returns:

true if a routing is required, false otherwise

findEntity

protected <E extends ElasticEntity> Optional<E> findEntity(E entity)

Specified by:

findEntity in class BaseMapper<ElasticEntity,ElasticConstraint,ElasticQuery<? extends ElasticEntity>>

batch

public BulkContext batch()

Creates a batch context used for bulk updates.

Returns:

a new batch context

isConfigured

public boolean isConfigured()

Determines if an appropriate configuration is available (e.g. a host to connect to).

Returns:

true if a configuration is present, false otherwise

isStoredPerYear

public boolean isStoredPerYear(EntityDescriptor descriptor)

Determines if the given entity type is stored per year.

Parameters:

descriptor - the descriptor of the entity type

Returns:

true if it is stored per year, false otherwise

select

public <E extends ElasticEntity> ElasticQuery<E> select(Class<E> type)

Description copied from class: BaseMapper

Creates a query for the given type.

Specified by:

select in class BaseMapper<ElasticEntity,ElasticConstraint,ElasticQuery<? extends ElasticEntity>>

Type Parameters:

E - the generic type of entities to be returned

Parameters:

type - the type of entities to query for.

Returns:

a query used to search for entities of the given type

filters

public FilterFactory<ElasticConstraint> filters()

Description copied from class: BaseMapper

Returns the filter factory which is used by this mapper.

Specified by:

filters in class BaseMapper<ElasticEntity,ElasticConstraint,ElasticQuery<? extends ElasticEntity>>

Returns:

the filter factory used by this mapper