Module evita.java.driver

Package io.evitadb.driver

Class EvitaClientSession

java.lang.Object

io.evitadb.driver.EvitaClientSession

All Implemented Interfaces:

EvitaSessionContract, Closeable, AutoCloseable, Comparable<EvitaSessionContract>

@NotThreadSafe
public class EvitaClientSession
extends Object
implements EvitaSessionContract

The EvitaClientSession implements EvitaSessionContract interface and aims to behave identically as if the evitaDB is used as an embedded engine. The EvitaClientSession is not thread-safe. It keeps a gRPC session opened, but it doesn't mean that the session on the server side is still alive. Server can close the session due to the timeout and the client will realize this on the next server call attempt.

Author:

Jan Novotný (novotny@fg.cz), FG Forrest a.s. (c) 2022

See Also:

• EvitaSessionContract

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EvitaClientSession.StreamValueWrapper<T>	Simple wrapper class that allows to pass capture value, or signalize end of stream with possible error returned byt the server.

Constructor Summary

Constructors

Constructor

Description

EvitaClientSession(EvitaClient evita, EvitaClientManagement management, io.evitadb.driver.EvitaEntitySchemaCache schemaCache, com.linecorp.armeria.client.grpc.GrpcClientBuilder grpcClientBuilder, String catalogName, CatalogState catalogState, UUID catalogId, UUID sessionId, TransactionContract.CommitBehavior commitBehaviour, SessionTraits sessionTraits, Consumer<EvitaClientSession> onTerminationCallback, Timeout timeout)

Method Summary

Modifier and Type	Method	Description
Task<?,FileForFetch>	backupCatalog(OffsetDateTime pastMoment, boolean includingWAL)
CompletableFuture<Long>	closeInternally()	Method internally closes the session
CompletableFuture<Long>	closeNow(TransactionContract.CommitBehavior commitBehaviour)
<S extends Serializable> S	createNewEntity(Class<S> expectedType)
<S extends Serializable> S	createNewEntity(Class<S> expectedType, int primaryKey)
EntityEditor.EntityBuilder	createNewEntity(String entityType)
EntityEditor.EntityBuilder	createNewEntity(String entityType, int primaryKey)
EntitySchemaEditor.EntitySchemaBuilder	defineEntitySchema(String entityType)
SealedEntitySchema	defineEntitySchemaFromModelClass(Class<?> modelClass)
SealedEntitySchema	defineEntitySchemaFromModelClass(Class<?> modelClass, SchemaPostProcessor postProcessor)
boolean	deleteCollection(Class<?> modelClass)
boolean	deleteCollection(String entityType)
int	deleteEntities(io.evitadb.api.query.Query query)
boolean	deleteEntity(Class<?> modelClass, int primaryKey)
<T extends Serializable> Optional<T>	deleteEntity(Class<T> modelClass, int primaryKey, io.evitadb.api.query.require.EntityContentRequire... require)
boolean	deleteEntity(String entityType, int primaryKey)
Optional<SealedEntity>	deleteEntity(String entityType, int primaryKey, io.evitadb.api.query.require.EntityContentRequire... require)
<T extends Serializable> DeletedHierarchy<T>	deleteEntityAndItsHierarchy(Class<T> modelClass, int primaryKey, io.evitadb.api.query.require.EntityContentRequire... require)
int	deleteEntityAndItsHierarchy(String entityType, int primaryKey)
DeletedHierarchy<SealedEntity>	deleteEntityAndItsHierarchy(String entityType, int primaryKey, io.evitadb.api.query.require.EntityContentRequire... require)
SealedEntity[]	deleteSealedEntitiesAndReturnBodies(io.evitadb.api.query.Query query)
<T extends Serializable> T	enrichEntity(T partiallyLoadedEntity, io.evitadb.api.query.require.EntityContentRequire... require)
<T extends Serializable> T	enrichOrLimitEntity(T partiallyLoadedEntity, io.evitadb.api.query.require.EntityContentRequire... require)
void	executeWithExtendedTimeout(Runnable lambda, long timeout, TimeUnit unit)	Method executes lambda using specified timeout for the call ignoring the defaults specified in EvitaClientConfiguration.timeout().
<T> T	executeWithExtendedTimeout(Supplier<T> lambda, long timeout, TimeUnit unit)	Method executes lambda using specified timeout for the call ignoring the defaults specified in EvitaClientConfiguration.timeout().
Set<String>	getAllEntityTypes()
UUID	getCatalogId()
String	getCatalogName()
SealedCatalogSchema	getCatalogSchema()
SealedCatalogSchema	getCatalogSchema(EvitaClient evita)	This method is internal and is a special form of getCatalogSchema() that can handle the situation when this particular session is already closed and opens a new temporary one for accessing the schemas on the server side when necessary.
CatalogState	getCatalogState()
long	getCatalogVersion()
CatalogVersion	getCatalogVersionAt(OffsetDateTime moment)
<T extends Serializable> Optional<T>	getEntity(Class<T> expectedType, int primaryKey, io.evitadb.api.query.require.EntityContentRequire... require)
Optional<SealedEntity>	getEntity(String entityType, int primaryKey, io.evitadb.api.query.require.EntityContentRequire... require)
int	getEntityCollectionSize(String entityType)
Optional<SealedEntitySchema>	getEntitySchema(Class<?> modelClass)
Optional<SealedEntitySchema>	getEntitySchema(String entityType)
SealedEntitySchema	getEntitySchemaOrThrowException(Class<?> modelClass)
SealedEntitySchema	getEntitySchemaOrThrowException(String entityType)
UUID	getId()
long	getInactivityDurationInSeconds()
Stream<ChangeCatalogCapture>	getMutationsHistory(ChangeCatalogCaptureRequest request)	If the stream is closed prematurely the server stream is cancelled and the server is notified about it.
Optional<UUID>	getOpenedTransactionId()
boolean	goLiveAndClose()
boolean	isActive()
boolean	isBinaryFormat()
boolean	isDryRun()
boolean	isReadOnly()
boolean	isRollbackOnly()
<S extends Serializable, T extends EvitaResponse<S>> T	query(io.evitadb.api.query.Query query, Class<S> expectedType)
<S extends Serializable> List<S>	queryList(io.evitadb.api.query.Query query, Class<S> expectedType)
<S extends Serializable> Optional<S>	queryOne(io.evitadb.api.query.Query query, Class<S> expectedType)
boolean	renameCollection(String entityType, String newName)
boolean	replaceCollection(String entityTypeToBeReplaced, String entityTypeToBeReplacedWith)
void	setRollbackOnly()
SealedCatalogSchema	updateAndFetchCatalogSchema(LocalCatalogSchemaMutation... schemaMutation)
SealedEntitySchema	updateAndFetchEntitySchema(ModifyEntitySchemaMutation schemaMutation)
int	updateCatalogSchema(LocalCatalogSchemaMutation... schemaMutation)
int	updateEntitySchema(ModifyEntitySchemaMutation schemaMutation)
SealedEntity	upsertAndFetchEntity(EntityEditor.EntityBuilder entityBuilder, io.evitadb.api.query.require.EntityContentRequire... require)
SealedEntity	upsertAndFetchEntity(EntityMutation entityMutation, io.evitadb.api.query.require.EntityContentRequire... require)
EntityReference	upsertEntity(EntityMutation entityMutation)
<S extends Serializable> EntityReference	upsertEntity(S customEntity)
<S extends Serializable> List<EntityReference>	upsertEntityDeeply(S customEntity)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.evitadb.api.EvitaSessionContract

close, closeWhen, compareTo, getEntitySchemaOrThrow, getEntitySchemaOrThrow, getEvita, getProxyFactory, isTransactionOpen, queryEntityReference, queryListOfEntityReferences, queryListOfSealedEntities, queryOneEntityReference, queryOneSealedEntity, querySealedEntity, updateAndFetchCatalogSchema, updateAndFetchEntitySchema, updateCatalogSchema, updateEntitySchema

Constructor Details

EvitaClientSession

public EvitaClientSession(@Nonnull
 EvitaClient evita,
 @Nonnull
 EvitaClientManagement management,
 @Nonnull
 io.evitadb.driver.EvitaEntitySchemaCache schemaCache,
 @Nonnull
 com.linecorp.armeria.client.grpc.GrpcClientBuilder grpcClientBuilder,
 @Nonnull
 String catalogName,
 @Nonnull
 CatalogState catalogState,
 @Nonnull
 UUID catalogId,
 @Nonnull
 UUID sessionId,
 @Nonnull
 TransactionContract.CommitBehavior commitBehaviour,
 @Nonnull
 SessionTraits sessionTraits,
 @Nonnull
 Consumer<EvitaClientSession> onTerminationCallback,
 @Nonnull
 Timeout timeout)

Method Details

getId

@Nonnull
public UUID getId()

Specified by:

getId in interface EvitaSessionContract

getCatalogId

@Nonnull
public UUID getCatalogId()

Specified by:

getCatalogId in interface EvitaSessionContract

getCatalogSchema

@Nonnull
public SealedCatalogSchema getCatalogSchema()

Specified by:

getCatalogSchema in interface EvitaSessionContract

getCatalogName

@Nonnull
public String getCatalogName()

Specified by:

getCatalogName in interface EvitaSessionContract

getCatalogState

@Nonnull
public CatalogState getCatalogState()

Specified by:

getCatalogState in interface EvitaSessionContract

getCatalogVersion

public long getCatalogVersion()

Specified by:

getCatalogVersion in interface EvitaSessionContract

isActive

public boolean isActive()

Specified by:

isActive in interface EvitaSessionContract

goLiveAndClose

public boolean goLiveAndClose()

Specified by:

goLiveAndClose in interface EvitaSessionContract

closeNow

@Nonnull
public CompletableFuture<Long> closeNow(@Nonnull
 TransactionContract.CommitBehavior commitBehaviour)

Specified by:

closeNow in interface EvitaSessionContract

defineEntitySchema

@Nonnull
public EntitySchemaEditor.EntitySchemaBuilder defineEntitySchema(@Nonnull
 String entityType)

Specified by:

defineEntitySchema in interface EvitaSessionContract

defineEntitySchemaFromModelClass

@Nonnull
public SealedEntitySchema defineEntitySchemaFromModelClass(@Nonnull
 Class<?> modelClass)

Specified by:

defineEntitySchemaFromModelClass in interface EvitaSessionContract

defineEntitySchemaFromModelClass

@Nonnull
public SealedEntitySchema defineEntitySchemaFromModelClass(@Nonnull
 Class<?> modelClass,
 @Nonnull
 SchemaPostProcessor postProcessor)

Specified by:

defineEntitySchemaFromModelClass in interface EvitaSessionContract

getEntitySchema

@Nonnull
public Optional<SealedEntitySchema> getEntitySchema(@Nonnull
 String entityType)

Specified by:

getEntitySchema in interface EvitaSessionContract

getEntitySchema

@Nonnull
public Optional<SealedEntitySchema> getEntitySchema(@Nonnull
 Class<?> modelClass)
                                             throws EntityClassInvalidException

Specified by:

getEntitySchema in interface EvitaSessionContract

Throws:

EntityClassInvalidException

getEntitySchemaOrThrowException

@Nonnull
public SealedEntitySchema getEntitySchemaOrThrowException(@Nonnull
 String entityType)
                                                   throws CollectionNotFoundException

Specified by:

getEntitySchemaOrThrowException in interface EvitaSessionContract

Throws:

CollectionNotFoundException

getEntitySchemaOrThrowException

@Nonnull
public SealedEntitySchema getEntitySchemaOrThrowException(@Nonnull
 Class<?> modelClass)
                                                   throws CollectionNotFoundException,
EntityClassInvalidException

Specified by:

getEntitySchemaOrThrowException in interface EvitaSessionContract

Throws:

CollectionNotFoundException

EntityClassInvalidException

getAllEntityTypes

@Nonnull
public Set<String> getAllEntityTypes()

Specified by:

getAllEntityTypes in interface EvitaSessionContract

queryOne

@Nonnull
public <S extends Serializable> Optional<S> queryOne(@Nonnull
 io.evitadb.api.query.Query query,
 @Nonnull
 Class<S> expectedType)
                                              throws UnexpectedResultException,
UnexpectedResultCountException,
InstanceTerminatedException

Specified by:

queryOne in interface EvitaSessionContract

Throws:

UnexpectedResultException

UnexpectedResultCountException

InstanceTerminatedException

queryList

@Nonnull
public <S extends Serializable> List<S> queryList(@Nonnull
 io.evitadb.api.query.Query query,
 @Nonnull
 Class<S> expectedType)
                                           throws UnexpectedResultException,
InstanceTerminatedException

Specified by:

queryList in interface EvitaSessionContract

Throws:

UnexpectedResultException

InstanceTerminatedException

query

@Nonnull
public <S extends Serializable,
T extends EvitaResponse<S>>
T query(@Nonnull
 io.evitadb.api.query.Query query,
 @Nonnull
 Class<S> expectedType)
 throws UnexpectedResultException,
InstanceTerminatedException

Specified by:

query in interface EvitaSessionContract

Throws:

UnexpectedResultException

InstanceTerminatedException

getEntity

@Nonnull
public Optional<SealedEntity> getEntity(@Nonnull
 String entityType,
 int primaryKey,
 io.evitadb.api.query.require.EntityContentRequire... require)

Specified by:

getEntity in interface EvitaSessionContract

getEntity

@Nonnull
public <T extends Serializable> Optional<T> getEntity(@Nonnull
 Class<T> expectedType,
 int primaryKey,
 io.evitadb.api.query.require.EntityContentRequire... require)
                                               throws EntityClassInvalidException

Specified by:

getEntity in interface EvitaSessionContract

Throws:

EntityClassInvalidException

enrichEntity

@Nonnull
public <T extends Serializable> T enrichEntity(@Nonnull
 T partiallyLoadedEntity,
 io.evitadb.api.query.require.EntityContentRequire... require)

Specified by:

enrichEntity in interface EvitaSessionContract

enrichOrLimitEntity

@Nonnull
public <T extends Serializable> T enrichOrLimitEntity(@Nonnull
 T partiallyLoadedEntity,
 io.evitadb.api.query.require.EntityContentRequire... require)

Specified by:

enrichOrLimitEntity in interface EvitaSessionContract

updateCatalogSchema

public int updateCatalogSchema(@Nonnull
 LocalCatalogSchemaMutation... schemaMutation)
                        throws SchemaAlteringException

Specified by:

updateCatalogSchema in interface EvitaSessionContract

Throws:

SchemaAlteringException

updateAndFetchCatalogSchema

@Nonnull
public SealedCatalogSchema updateAndFetchCatalogSchema(@Nonnull
 LocalCatalogSchemaMutation... schemaMutation)
                                                throws SchemaAlteringException

Specified by:

updateAndFetchCatalogSchema in interface EvitaSessionContract

Throws:

SchemaAlteringException

updateEntitySchema

public int updateEntitySchema(@Nonnull
 ModifyEntitySchemaMutation schemaMutation)
                       throws SchemaAlteringException

Specified by:

updateEntitySchema in interface EvitaSessionContract

Throws:

SchemaAlteringException

updateAndFetchEntitySchema

@Nonnull
public SealedEntitySchema updateAndFetchEntitySchema(@Nonnull
 ModifyEntitySchemaMutation schemaMutation)
                                              throws SchemaAlteringException

Specified by:

updateAndFetchEntitySchema in interface EvitaSessionContract

Throws:

SchemaAlteringException

deleteCollection

public boolean deleteCollection(@Nonnull
 String entityType)

Specified by:

deleteCollection in interface EvitaSessionContract

deleteCollection

public boolean deleteCollection(@Nonnull
 Class<?> modelClass)
                         throws EntityClassInvalidException

Specified by:

deleteCollection in interface EvitaSessionContract

Throws:

EntityClassInvalidException

renameCollection

public boolean renameCollection(@Nonnull
 String entityType,
 @Nonnull
 String newName)

Specified by:

renameCollection in interface EvitaSessionContract

replaceCollection

public boolean replaceCollection(@Nonnull
 String entityTypeToBeReplaced,
 @Nonnull
 String entityTypeToBeReplacedWith)

Specified by:

replaceCollection in interface EvitaSessionContract

getEntityCollectionSize

public int getEntityCollectionSize(@Nonnull
 String entityType)

Specified by:

getEntityCollectionSize in interface EvitaSessionContract

createNewEntity

@Nonnull
public EntityEditor.EntityBuilder createNewEntity(@Nonnull
 String entityType)

Specified by:

createNewEntity in interface EvitaSessionContract

createNewEntity

@Nonnull
public <S extends Serializable> S createNewEntity(@Nonnull
 Class<S> expectedType)

Specified by:

createNewEntity in interface EvitaSessionContract

createNewEntity

@Nonnull
public EntityEditor.EntityBuilder createNewEntity(@Nonnull
 String entityType,
 int primaryKey)

Specified by:

createNewEntity in interface EvitaSessionContract

createNewEntity

@Nonnull
public <S extends Serializable> S createNewEntity(@Nonnull
 Class<S> expectedType,
 int primaryKey)

Specified by:

createNewEntity in interface EvitaSessionContract

upsertEntity

@Nonnull
public <S extends Serializable> EntityReference upsertEntity(@Nonnull
 S customEntity)

Specified by:

upsertEntity in interface EvitaSessionContract

upsertEntityDeeply

@Nonnull
public <S extends Serializable>
List<EntityReference> upsertEntityDeeply(@Nonnull
 S customEntity)

Specified by:

upsertEntityDeeply in interface EvitaSessionContract

upsertEntity

@Nonnull
public EntityReference upsertEntity(@Nonnull
 EntityMutation entityMutation)

Specified by:

upsertEntity in interface EvitaSessionContract

upsertAndFetchEntity

@Nonnull
public SealedEntity upsertAndFetchEntity(@Nonnull
 EntityEditor.EntityBuilder entityBuilder,
 io.evitadb.api.query.require.EntityContentRequire... require)

Specified by:

upsertAndFetchEntity in interface EvitaSessionContract

upsertAndFetchEntity

@Nonnull
public SealedEntity upsertAndFetchEntity(@Nonnull
 EntityMutation entityMutation,
 io.evitadb.api.query.require.EntityContentRequire... require)

Specified by:

upsertAndFetchEntity in interface EvitaSessionContract

deleteEntity

public boolean deleteEntity(@Nonnull
 String entityType,
 int primaryKey)

Specified by:

deleteEntity in interface EvitaSessionContract

deleteEntity

public boolean deleteEntity(@Nonnull
 Class<?> modelClass,
 int primaryKey)
                     throws EntityClassInvalidException

Specified by:

deleteEntity in interface EvitaSessionContract

Throws:

EntityClassInvalidException

deleteEntity

@Nonnull
public Optional<SealedEntity> deleteEntity(@Nonnull
 String entityType,
 int primaryKey,
 io.evitadb.api.query.require.EntityContentRequire... require)

Specified by:

deleteEntity in interface EvitaSessionContract

deleteEntity

@Nonnull
public <T extends Serializable> Optional<T> deleteEntity(@Nonnull
 Class<T> modelClass,
 int primaryKey,
 io.evitadb.api.query.require.EntityContentRequire... require)
                                                  throws EntityClassInvalidException

Specified by:

deleteEntity in interface EvitaSessionContract

Throws:

EntityClassInvalidException

deleteEntityAndItsHierarchy

public int deleteEntityAndItsHierarchy(@Nonnull
 String entityType,
 int primaryKey)

Specified by:

deleteEntityAndItsHierarchy in interface EvitaSessionContract

deleteEntityAndItsHierarchy

@Nonnull
public DeletedHierarchy<SealedEntity> deleteEntityAndItsHierarchy(@Nonnull
 String entityType,
 int primaryKey,
 io.evitadb.api.query.require.EntityContentRequire... require)

Specified by:

deleteEntityAndItsHierarchy in interface EvitaSessionContract

deleteEntityAndItsHierarchy

@Nonnull
public <T extends Serializable> DeletedHierarchy<T> deleteEntityAndItsHierarchy(@Nonnull
 Class<T> modelClass,
 int primaryKey,
 io.evitadb.api.query.require.EntityContentRequire... require)
                                                                         throws io.evitadb.exception.EvitaInvalidUsageException,
EntityClassInvalidException

Specified by:

deleteEntityAndItsHierarchy in interface EvitaSessionContract

Throws:

io.evitadb.exception.EvitaInvalidUsageException

EntityClassInvalidException

deleteEntities

public int deleteEntities(@Nonnull
 io.evitadb.api.query.Query query)

Specified by:

deleteEntities in interface EvitaSessionContract

deleteSealedEntitiesAndReturnBodies

@Nonnull
public SealedEntity[] deleteSealedEntitiesAndReturnBodies(@Nonnull
 io.evitadb.api.query.Query query)

Specified by:

deleteSealedEntitiesAndReturnBodies in interface EvitaSessionContract

getCatalogVersionAt

@Nonnull
public CatalogVersion getCatalogVersionAt(@Nullable
 OffsetDateTime moment)
                                   throws TemporalDataNotAvailableException

Specified by:

getCatalogVersionAt in interface EvitaSessionContract

Throws:

TemporalDataNotAvailableException

getMutationsHistory

@Nonnull
public Stream<ChangeCatalogCapture> getMutationsHistory(@Nonnull
 ChangeCatalogCaptureRequest request)

If the stream is closed prematurely the server stream is cancelled and the server is notified about it.

Specified by:

getMutationsHistory in interface EvitaSessionContract

Parameters:

request - request that specifies the criteria for the changes to be returned

Returns:

backupCatalog

@Nonnull
public Task<?,FileForFetch> backupCatalog(@Nullable
 OffsetDateTime pastMoment,
 boolean includingWAL)
                                   throws TemporalDataNotAvailableException

Specified by:

backupCatalog in interface EvitaSessionContract

Throws:

TemporalDataNotAvailableException

getOpenedTransactionId

@Nonnull
public Optional<UUID> getOpenedTransactionId()

Specified by:

getOpenedTransactionId in interface EvitaSessionContract

isRollbackOnly

public boolean isRollbackOnly()

Specified by:

isRollbackOnly in interface EvitaSessionContract

setRollbackOnly

public void setRollbackOnly()

Specified by:

setRollbackOnly in interface EvitaSessionContract

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface EvitaSessionContract

isBinaryFormat

public boolean isBinaryFormat()

Specified by:

isBinaryFormat in interface EvitaSessionContract

isDryRun

public boolean isDryRun()

Specified by:

isDryRun in interface EvitaSessionContract

getInactivityDurationInSeconds

public long getInactivityDurationInSeconds()

Specified by:

getInactivityDurationInSeconds in interface EvitaSessionContract

getCatalogSchema

@Nonnull
public SealedCatalogSchema getCatalogSchema(@Nonnull
 EvitaClient evita)

This method is internal and is a special form of getCatalogSchema() that can handle the situation when this particular session is already closed and opens a new temporary one for accessing the schemas on the server side when necessary.

Parameters:

evita - - reference to the EvitaClient instance that is used to open a new temporary session when necessary

Returns:

SealedCatalogSchema of the catalog targeted by this session

closeInternally

@Nonnull
public CompletableFuture<Long> closeInternally()

Method internally closes the session

executeWithExtendedTimeout

public void executeWithExtendedTimeout(@Nonnull
 Runnable lambda,
 long timeout,
 @Nonnull
 TimeUnit unit)

Method executes lambda using specified timeout for the call ignoring the defaults specified in EvitaClientConfiguration.timeout().

Parameters:

lambda - logic to be executed

timeout - timeout value

unit - time unit of the timeout

executeWithExtendedTimeout

public <T> T executeWithExtendedTimeout(@Nonnull
 Supplier<T> lambda,
 long timeout,
 @Nonnull
 TimeUnit unit)

Method executes lambda using specified timeout for the call ignoring the defaults specified in EvitaClientConfiguration.timeout().

Type Parameters:

T - type of the result

Parameters:

lambda - logic to be executed

timeout - timeout value

unit - time unit of the timeout

Returns:

result of the lambda