Module evita.java.driver

Package io.evitadb.driver

Class EvitaClient

java.lang.Object

io.evitadb.driver.EvitaClient

All Implemented Interfaces:

EvitaContract, AutoCloseable

@ThreadSafe
public class EvitaClient
extends Object
implements EvitaContract

The EvitaClient implements EvitaContract interface and aims to behave identically as if the evitaDB is used as an embedded engine. The purpose is to switch between the client & server setup and the single server setup seamlessly. The client & server implementation takes advantage of gRPC API that is best suited for fast communication between two endpoints if both parties are Java based. The class is thread-safe and can be used from multiple threads to acquire EvitaClientSession that are not thread-safe.

Author:

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

See Also:

• EvitaContract

Constructor Summary

Constructors

Constructor	Description
EvitaClient(EvitaClientConfiguration configuration)
EvitaClient(EvitaClientConfiguration configuration, Consumer<com.linecorp.armeria.client.grpc.GrpcClientBuilder> grpcConfigurator)

Method Summary

Modifier and Type	Method	Description
protected void	assertActive()	Verifies this instance is still active.
void	close()
EvitaClientSession	createSession(SessionTraits traits)
CatalogSchemaEditor.CatalogSchemaBuilder	defineCatalog(String catalogName)
boolean	deleteCatalogIfExists(String catalogName)
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>	getCatalogNames()
Optional<EvitaSessionContract>	getSessionById(UUID uuid)
String	getVersion()	Retrieves the version number of the evitaDB client.
boolean	isActive()
EvitaManagementContract	management()
void	queryCatalog(String catalogName, Consumer<EvitaSessionContract> queryLogic, SessionTraits.SessionFlags... flags)
<T> T	queryCatalog(String catalogName, Function<EvitaSessionContract,T> queryLogic, SessionTraits.SessionFlags... flags)
<T> CompletableFuture<T>	queryCatalogAsync(String catalogName, Function<EvitaSessionContract,T> queryLogic, SessionTraits.SessionFlags... flags)
void	renameCatalog(String catalogName, String newCatalogName)
void	replaceCatalog(String catalogNameToBeReplacedWith, String catalogNameToBeReplaced)
void	terminateSession(EvitaSessionContract session)
void	update(TopLevelCatalogSchemaMutation... catalogMutations)
void	updateCatalog(String catalogName, Consumer<EvitaSessionContract> updater, TransactionContract.CommitBehavior commitBehaviour, SessionTraits.SessionFlags... flags)
<T> T	updateCatalog(String catalogName, Function<EvitaSessionContract,T> updater, TransactionContract.CommitBehavior commitBehaviour, SessionTraits.SessionFlags... flags)
CompletableFuture<Long>	updateCatalogAsync(String catalogName, Consumer<EvitaSessionContract> updater, TransactionContract.CommitBehavior commitBehaviour, SessionTraits.SessionFlags... flags)
<T> CompletableFuture<T>	updateCatalogAsync(String catalogName, Function<EvitaSessionContract,T> updater, TransactionContract.CommitBehavior commitBehaviour, SessionTraits.SessionFlags... flags)

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.EvitaContract

createReadOnlySession, createReadWriteSession, updateCatalog, updateCatalog

Constructor Details

EvitaClient

public EvitaClient(@Nonnull
 EvitaClientConfiguration configuration)

EvitaClient

public EvitaClient(@Nonnull
 EvitaClientConfiguration configuration,
 @Nullable
 Consumer<com.linecorp.armeria.client.grpc.GrpcClientBuilder> grpcConfigurator)

Method Details

isActive

public boolean isActive()

Specified by:

isActive in interface EvitaContract

createSession

@Nonnull
public EvitaClientSession createSession(@Nonnull
 SessionTraits traits)

Specified by:

createSession in interface EvitaContract

getSessionById

@Nonnull
public Optional<EvitaSessionContract> getSessionById(@Nonnull
 UUID uuid)

Specified by:

getSessionById in interface EvitaContract

terminateSession

public void terminateSession(@Nonnull
 EvitaSessionContract session)

Specified by:

terminateSession in interface EvitaContract

getCatalogNames

@Nonnull
public Set<String> getCatalogNames()

Specified by:

getCatalogNames in interface EvitaContract

defineCatalog

@Nonnull
public CatalogSchemaEditor.CatalogSchemaBuilder defineCatalog(@Nonnull
 String catalogName)

Specified by:

defineCatalog in interface EvitaContract

renameCatalog

public void renameCatalog(@Nonnull
 String catalogName,
 @Nonnull
 String newCatalogName)

Specified by:

renameCatalog in interface EvitaContract

replaceCatalog

public void replaceCatalog(@Nonnull
 String catalogNameToBeReplacedWith,
 @Nonnull
 String catalogNameToBeReplaced)

Specified by:

replaceCatalog in interface EvitaContract

deleteCatalogIfExists

public boolean deleteCatalogIfExists(@Nonnull
 String catalogName)

Specified by:

deleteCatalogIfExists in interface EvitaContract

update

public void update(@Nonnull
 TopLevelCatalogSchemaMutation... catalogMutations)

Specified by:

update in interface EvitaContract

queryCatalog

public <T> T queryCatalog(@Nonnull
 String catalogName,
 @Nonnull
 Function<EvitaSessionContract,T> queryLogic,
 @Nullable
 SessionTraits.SessionFlags... flags)

Specified by:

queryCatalog in interface EvitaContract

queryCatalog

public void queryCatalog(@Nonnull
 String catalogName,
 @Nonnull
 Consumer<EvitaSessionContract> queryLogic,
 @Nullable
 SessionTraits.SessionFlags... flags)

Specified by:

queryCatalog in interface EvitaContract

queryCatalogAsync

@Nonnull
public <T> CompletableFuture<T> queryCatalogAsync(@Nonnull
 String catalogName,
 @Nonnull
 Function<EvitaSessionContract,T> queryLogic,
 @Nullable
 SessionTraits.SessionFlags... flags)

Specified by:

queryCatalogAsync in interface EvitaContract

updateCatalog

public <T> T updateCatalog(@Nonnull
 String catalogName,
 @Nonnull
 Function<EvitaSessionContract,T> updater,
 @Nonnull
 TransactionContract.CommitBehavior commitBehaviour,
 @Nullable
 SessionTraits.SessionFlags... flags)

Specified by:

updateCatalog in interface EvitaContract

updateCatalogAsync

@Nonnull
public <T> CompletableFuture<T> updateCatalogAsync(@Nonnull
 String catalogName,
 @Nonnull
 Function<EvitaSessionContract,T> updater,
 @Nonnull
 TransactionContract.CommitBehavior commitBehaviour,
 @Nullable
 SessionTraits.SessionFlags... flags)

Specified by:

updateCatalogAsync in interface EvitaContract

updateCatalog

public void updateCatalog(@Nonnull
 String catalogName,
 @Nonnull
 Consumer<EvitaSessionContract> updater,
 @Nonnull
 TransactionContract.CommitBehavior commitBehaviour,
 @Nullable
 SessionTraits.SessionFlags... flags)

Specified by:

updateCatalog in interface EvitaContract

updateCatalogAsync

@Nonnull
public CompletableFuture<Long> updateCatalogAsync(@Nonnull
 String catalogName,
 @Nonnull
 Consumer<EvitaSessionContract> updater,
 @Nonnull
 TransactionContract.CommitBehavior commitBehaviour,
 @Nullable
 SessionTraits.SessionFlags... flags)
                                           throws TransactionException

Specified by:

updateCatalogAsync in interface EvitaContract

Throws:

TransactionException

management

@Nonnull
public EvitaManagementContract management()

Specified by:

management in interface EvitaContract

close

public void close()

Specified by:

close in interface AutoCloseable

getVersion

@Nonnull
public String getVersion()

Retrieves the version number of the evitaDB client.

Returns:

The version number as a string.

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

assertActive

protected void assertActive()

Verifies this instance is still active.