com.holonplatform.async.datastore

Interface AsyncDatastore

All Superinterfaces:

ConfigurableDatastore, DataContextBound, DatastoreCommodityHandler, DatastoreOperations<CompletionStage<Datastore.OperationResult>,CompletionStage<PropertyBox>,AsyncBulkInsert,AsyncBulkUpdate,AsyncBulkDelete,AsyncQuery>, ExpressionResolver.ExpressionResolverSupport, Serializable

public interface AsyncDatastore
extends DatastoreOperations<CompletionStage<Datastore.OperationResult>,CompletionStage<PropertyBox>,AsyncBulkInsert,AsyncBulkUpdate,AsyncBulkDelete,AsyncQuery>, ConfigurableDatastore, Serializable

Asynchronous DatastoreOperations API, which can be used to execute the Datastore operations and obtain the the results asynchronously, using CompletionStage as operation return type.

Extends DatastoreCommodityHandler to support DatastoreCommodity creation by type.

Extends ExpressionResolver.ExpressionResolverSupport to allow ExpressionResolvers registration, which can be used to extend and/or customize the datastore operations.

Since:

5.2.0

See Also:

Datastore

Nested Class Summary

Nested classes/interfaces inherited from interface com.holonplatform.core.datastore.DatastoreOperations

DatastoreOperations.Builder<D extends DatastoreOperations,B extends DatastoreOperations.Builder<D,B>>, DatastoreOperations.WriteOption

Method Summary

Modifier and Type	Method and Description
default AsyncBulkDelete	bulkDelete(DataTarget<?> target, DatastoreOperations.WriteOption... options) Create a BulkDeleteOperation actuator, which can be used to configure and execute a bulk DELETE operation.
default AsyncBulkInsert	bulkInsert(DataTarget<?> target, PropertySet<?> propertySet, DatastoreOperations.WriteOption... options) Create a BulkInsertOperation actuator, which can be used to configure and execute a bulk INSERT operation.
default AsyncBulkUpdate	bulkUpdate(DataTarget<?> target, DatastoreOperations.WriteOption... options) Create a BulkUpdateOperation actuator, which can be used to configure and execute a bulk UPDATE operation.
default CompletionStage<Datastore.OperationResult>	delete(DataTarget<?> target, PropertyBox propertyBox, DatastoreOperations.WriteOption... options) Remove a PropertyBox from the data store, using given target to denote the data store persistent entity from which the data has to be deleted.
default CompletionStage<Datastore.OperationResult>	insert(DataTarget<?> target, PropertyBox propertyBox, DatastoreOperations.WriteOption... options) Insert a PropertyBox in the data store, using given target to denote the data store persistent entity into which the data has to be inserted.
default Optional<AsyncTransactional>	isTransactional() Check if this Datastore is AsyncTransactional, i.e. supports execution of transactional operations.
default AsyncQuery	query() Create a QueryBuilder actuator, which can be used to configure and execute a query on the data managed by this Datastore.
default AsyncQuery	query(DataTarget<?> target) Create an AsyncQuery commodity, setting given target as query data target.
default CompletionStage<PropertyBox>	refresh(DataTarget<?> target, PropertyBox propertyBox) Refresh a PropertyBox, updating all its model properties to current value in data store and using given target to denote the data store persistent entity to use.
default AsyncTransactional	requireTransactional() Requires this Datastore to be AsyncTransactional, i.e. to support execution of transactional operations, throwing an IllegalStateException if this Datastore is not transactional.
default CompletionStage<Datastore.OperationResult>	save(DataTarget<?> target, PropertyBox propertyBox, DatastoreOperations.WriteOption... options) Save a PropertyBox in the data store, using given target to denote the data store persistent entity into which the data has to be saved.
default CompletionStage<Datastore.OperationResult>	update(DataTarget<?> target, PropertyBox propertyBox, DatastoreOperations.WriteOption... options) Update a PropertyBox in the data store, using given target to denote the data store persistent entity into which the data has to be updated.

Methods inherited from interface com.holonplatform.core.datastore.DatastoreCommodityHandler

create, getAvailableCommodities, hasCommodity

Methods inherited from interface com.holonplatform.core.ExpressionResolver.ExpressionResolverSupport

addExpressionResolver, addExpressionResolvers, removeExpressionResolver

Methods inherited from interface com.holonplatform.core.datastore.DataContextBound

getDataContextId

Method Detail

refresh

default CompletionStage<PropertyBox> refresh(DataTarget<?> target,
                                             PropertyBox propertyBox)

Description copied from interface: DatastoreOperations

Refresh a PropertyBox, updating all its model properties to current value in data store and using given target to denote the data store persistent entity to use.

Specified by:

refresh in interface DatastoreOperations<CompletionStage<Datastore.OperationResult>,CompletionStage<PropertyBox>,AsyncBulkInsert,AsyncBulkUpdate,AsyncBulkDelete,AsyncQuery>

Parameters:

target - DataTarget to declare the data store persistent entity from which data has to be refreshed

propertyBox - The data to refresh, represented using a PropertyBox (not null)

Returns:

The refresh operation result, which should provide the refreshed PropertyBox instance

insert

default CompletionStage<Datastore.OperationResult> insert(DataTarget<?> target,
                                                          PropertyBox propertyBox,
                                                          DatastoreOperations.WriteOption... options)

Description copied from interface: DatastoreOperations

Insert a PropertyBox in the data store, using given target to denote the data store persistent entity into which the data has to be inserted.

Specified by:

insert in interface DatastoreOperations<CompletionStage<Datastore.OperationResult>,CompletionStage<PropertyBox>,AsyncBulkInsert,AsyncBulkUpdate,AsyncBulkDelete,AsyncQuery>

Parameters:

target - DataTarget to declare the data store persistent entity into which the data has to be inserted (not null)

propertyBox - The data to insert, represented using a PropertyBox (not null)

options - Optional write options. The write options are specific for each concrete DatastoreOperations implementation.

Returns:

the operation execution result

update

default CompletionStage<Datastore.OperationResult> update(DataTarget<?> target,
                                                          PropertyBox propertyBox,
                                                          DatastoreOperations.WriteOption... options)

Description copied from interface: DatastoreOperations

Update a PropertyBox in the data store, using given target to denote the data store persistent entity into which the data has to be updated.

Specified by:

update in interface DatastoreOperations<CompletionStage<Datastore.OperationResult>,CompletionStage<PropertyBox>,AsyncBulkInsert,AsyncBulkUpdate,AsyncBulkDelete,AsyncQuery>

Parameters:

target - DataTarget to declare the data store persistent entity into which the data has to be updated (not null)

propertyBox - The data to update, represented using a PropertyBox (not null)

options - Optional write options. The write options are specific for each concrete DatastoreOperations implementation.

Returns:

the operation execution result

save

default CompletionStage<Datastore.OperationResult> save(DataTarget<?> target,
                                                        PropertyBox propertyBox,
                                                        DatastoreOperations.WriteOption... options)

Description copied from interface: DatastoreOperations

Save a PropertyBox in the data store, using given target to denote the data store persistent entity into which the data has to be saved. The save operation semantics is: insert data if not exists, update it otherwise.

Specified by:

save in interface DatastoreOperations<CompletionStage<Datastore.OperationResult>,CompletionStage<PropertyBox>,AsyncBulkInsert,AsyncBulkUpdate,AsyncBulkDelete,AsyncQuery>

Parameters:

target - DataTarget to declare the data store persistent entity into which the data has to be saved (not null)

propertyBox - The data to save, represented using a PropertyBox (not null)

options - Optional write options. The write options are specific for each concrete DatastoreOperations implementation.

Returns:

the operation execution result

delete

default CompletionStage<Datastore.OperationResult> delete(DataTarget<?> target,
                                                          PropertyBox propertyBox,
                                                          DatastoreOperations.WriteOption... options)

Description copied from interface: DatastoreOperations

Remove a PropertyBox from the data store, using given target to denote the data store persistent entity from which the data has to be deleted.

Specified by:

delete in interface DatastoreOperations<CompletionStage<Datastore.OperationResult>,CompletionStage<PropertyBox>,AsyncBulkInsert,AsyncBulkUpdate,AsyncBulkDelete,AsyncQuery>

Parameters:

target - DataTarget to declare the data store persistent entity from which the data has to be deleted (not null)

propertyBox - The data to delete, represented using a PropertyBox (not null)

options - Optional write options. The write options are specific for each concrete DatastoreOperations implementation.

Returns:

the operation execution result

bulkInsert

default AsyncBulkInsert bulkInsert(DataTarget<?> target,
                                   PropertySet<?> propertySet,
                                   DatastoreOperations.WriteOption... options)

Description copied from interface: DatastoreOperations

Create a BulkInsertOperation actuator, which can be used to configure and execute a bulk INSERT operation.

Specified by:

bulkInsert in interface DatastoreOperations<CompletionStage<Datastore.OperationResult>,CompletionStage<PropertyBox>,AsyncBulkInsert,AsyncBulkUpdate,AsyncBulkDelete,AsyncQuery>

Parameters:

target - DataTarget to identify data entity to insert (not null)

propertySet - The property set to use to perform insert operations. Only the properties contained in given property set will be taken into account to insert the PropertyBox values

options - Optional write options. The write options are specific for each concrete DatastoreOperations implementation.

Returns:

A new bulk INSERT operation

bulkUpdate

default AsyncBulkUpdate bulkUpdate(DataTarget<?> target,
                                   DatastoreOperations.WriteOption... options)

Description copied from interface: DatastoreOperations

Create a BulkUpdateOperation actuator, which can be used to configure and execute a bulk UPDATE operation.

Specified by:

bulkUpdate in interface DatastoreOperations<CompletionStage<Datastore.OperationResult>,CompletionStage<PropertyBox>,AsyncBulkInsert,AsyncBulkUpdate,AsyncBulkDelete,AsyncQuery>

Parameters:

target - DataTarget to identify data entity to update (not null)

options - Optional write options. The write options are specific for each concrete DatastoreOperations implementation.

Returns:

A new bulk UPDATE operation

bulkDelete

default AsyncBulkDelete bulkDelete(DataTarget<?> target,
                                   DatastoreOperations.WriteOption... options)

Description copied from interface: DatastoreOperations

Create a BulkDeleteOperation actuator, which can be used to configure and execute a bulk DELETE operation.

Specified by:

bulkDelete in interface DatastoreOperations<CompletionStage<Datastore.OperationResult>,CompletionStage<PropertyBox>,AsyncBulkInsert,AsyncBulkUpdate,AsyncBulkDelete,AsyncQuery>

Parameters:

target - DataTarget to identify data entity to delete (not null)

options - Optional write options. The write options are specific for each concrete DatastoreOperations implementation.

Returns:

A new bulk DELETE operation

query

default AsyncQuery query()

Description copied from interface: DatastoreOperations

Create a QueryBuilder actuator, which can be used to configure and execute a query on the data managed by this Datastore.

Specified by:

query in interface DatastoreOperations<CompletionStage<Datastore.OperationResult>,CompletionStage<PropertyBox>,AsyncBulkInsert,AsyncBulkUpdate,AsyncBulkDelete,AsyncQuery>

Returns:

A new query builder

query

default AsyncQuery query(DataTarget<?> target)

Create an AsyncQuery commodity, setting given target as query data target.

Parameters:

target - Query data target (not null)

Returns:

A new AsyncQuery instance, which can be used to configure and execute an asynchronous query

isTransactional

default Optional<AsyncTransactional> isTransactional()

Check if this Datastore is AsyncTransactional, i.e. supports execution of transactional operations.

Returns:

If this Datastore is transactional, return the Datastore as AsyncTransactional, or an empty Optional otherwise

requireTransactional

default AsyncTransactional requireTransactional()

Requires this Datastore to be AsyncTransactional, i.e. to support execution of transactional operations, throwing an IllegalStateException if this Datastore is not transactional.

Returns:

the Datastore as AsyncTransactional

Throws:

IllegalStateException - If this Datastore is not transactional