io.requery

Interface Queryable<T>

Type Parameters:

T - the base class or interface to restrict all entities that are queried to.

All Known Subinterfaces:

BlockingEntityStore<T>, CompletionStageEntityStore<T>, EntityStore<T,R>

All Known Implementing Classes:

CompletableEntityStore, EntityDataStore, ReactiveEntityStore, ReactorEntityStore, SingleEntityStore

@ParametersAreNonnullByDefault
public interface Queryable<T>

Interface for querying both Entity objects and selectable attributes of those objects.

Method Summary

Modifier and Type	Method and Description
<E extends T> Selection<? extends Scalar<Integer>>	count(Class<E> type) Initiates a query to count the number of entities of a given type.
Selection<? extends Scalar<Integer>>	count(QueryAttribute<?,?>... attributes) Initiates a query to count a given selection.
Deletion<? extends Scalar<Integer>>	delete() Initiates a delete query against this data store.
<E extends T> Deletion<? extends Scalar<Integer>>	delete(Class<E> type) Initiates an delete query for a type.
<E extends T> Insertion<? extends Result<Tuple>>	insert(Class<E> type) Initiates an insert operation for a type.
<E extends T> Result<E>	raw(Class<E> type, String query, Object... parameters) Executes a raw query against the data store mapping on to a specific entity type.
Result<Tuple>	raw(String query, Object... parameters) Executes a raw query against the data store.
<E extends T> Selection<? extends Result<E>>	select(Class<E> type, QueryAttribute<?,?>... attributes) Initiates a query against a set of expression values return a specific entity type in a Result.
<E extends T> Selection<? extends Result<E>>	select(Class<E> type, Set<? extends QueryAttribute<E,?>> attributes) Initiates a query against a set of expression values return a specific entity type in a Result.
Selection<? extends Result<Tuple>>	select(Expression<?>... expressions) Initiates a query against a set of expression values.
Selection<? extends Result<Tuple>>	select(Set<? extends Expression<?>> expressions) Initiates a query against a set of expression values.
Update<? extends Scalar<Integer>>	update() Initiates an update query against this data store.
<E extends T> Update<? extends Scalar<Integer>>	update(Class<E> type) Initiates an update query for a type.

Method Detail

select

@CheckReturnValue
<E extends T> Selection<? extends Result<E>> select(Class<E> type,
                                                                      QueryAttribute<?,?>... attributes)

Initiates a query against a set of expression values return a specific entity type in a Result.

Type Parameters:

E - entity type

Parameters:

type - of entity

attributes - to select (must of be of type E, not enforced due to erasure)

Returns:

next query step

select

@CheckReturnValue
<E extends T> Selection<? extends Result<E>> select(Class<E> type,
                                                                      Set<? extends QueryAttribute<E,?>> attributes)

Initiates a query against a set of expression values return a specific entity type in a Result.

Type Parameters:

E - entity type

Parameters:

type - of entity

attributes - to select (must of be of type E, not enforced due to erasure)

Returns:

next query step

insert

@CheckReturnValue
<E extends T> Insertion<? extends Result<Tuple>> insert(Class<E> type)

Initiates an insert operation for a type. After completing the expression call Return.get() to perform the operation. If the type has no generated key values the result is a tuple containing a single element with the number of rows affected by the operation. Otherwise if the type has generated keys those keys are returned as the result.

Type Parameters:

E - entity type

Parameters:

type - of entity

Returns:

next query step

update

@CheckReturnValue
<E extends T> Update<? extends Scalar<Integer>> update(Class<E> type)

Initiates an update query for a type. After completing the expression call Return.get() to perform the operation. The result is the number of rows affected by the call. Note that aggregate update queries will not affect existing entity objects in memory.

Type Parameters:

E - entity type

Parameters:

type - of entity

Returns:

next query step

delete

@CheckReturnValue
<E extends T> Deletion<? extends Scalar<Integer>> delete(Class<E> type)

Initiates an delete query for a type. After completing the expression call Return.get() to perform the operation. Note that aggregate delete queries will not affect existing entity objects in memory or in the EntityCache associated with the store.

Type Parameters:

E - entity type

Parameters:

type - of entity

Returns:

next query step

count

@CheckReturnValue
<E extends T> Selection<? extends Scalar<Integer>> count(Class<E> type)

Initiates a query to count the number of entities of a given type.

Type Parameters:

E - entity type

Parameters:

type - of entity

Returns:

next query step

count

@CheckReturnValue
Selection<? extends Scalar<Integer>> count(QueryAttribute<?,?>... attributes)

Initiates a query to count a given selection.

Parameters:

attributes - to select

Returns:

next query step

select

@CheckReturnValue
Selection<? extends Result<Tuple>> select(Expression<?>... expressions)

Initiates a query against a set of expression values.

Parameters:

expressions - to select

Returns:

next query step

select

@CheckReturnValue
Selection<? extends Result<Tuple>> select(Set<? extends Expression<?>> expressions)

Initiates a query against a set of expression values.

Parameters:

expressions - to select, cannot be null or empty

Returns:

next query step

update

@CheckReturnValue
Update<? extends Scalar<Integer>> update()

Initiates an update query against this data store. After completing the expression call Return.get() to perform the operation. The result is the number of rows affected by the call. Note that aggregate update queries will not affect existing entity objects in memory.

Returns:

next query step

delete

@CheckReturnValue
Deletion<? extends Scalar<Integer>> delete()

Initiates a delete query against this data store. After completing the expression call Return.get() to perform the operation. The result is the number of rows affected by the call. Note that aggregate update queries will not affect existing entity objects in memory.

Returns:

next query step

raw

@CheckReturnValue
Result<Tuple> raw(String query,
                                    Object... parameters)

Executes a raw query against the data store.

Parameters:

query - raw query to execute

parameters - query arguments, the number of arguments must match the number of place holder values in the query or a PersistenceException will be thrown.

Returns:

the result of the query as a Tuple.

raw

@CheckReturnValue
<E extends T> Result<E> raw(Class<E> type,
                                              String query,
                                              Object... parameters)

Executes a raw query against the data store mapping on to a specific entity type.

Type Parameters:

E - entity type

Parameters:

type - entity type

query - raw query to execute

parameters - query arguments, the number of arguments must match the number of place holder values in the query or a PersistenceException will be thrown.

Returns:

the result of the query.