MongoQuery (SIRIUS db 5.0-rc9 API)

java.lang.Object
- sirius.db.mixing.query.BaseQuery<Q,E>
- - sirius.db.mixing.query.Query<MongoQuery<E>,E,MongoConstraint>
  - - sirius.db.mongo.MongoQuery<E>

Type Parameters:: E - the type of entities being queried.

public class MongoQuery<E extends MongoEntity>
extends Query<MongoQuery<E>,E,MongoConstraint>

Creates a new query against MongoDB.

Field Summary
- Fields inherited from class sirius.db.mixing.query.BaseQuery
  descriptor, limit, MAX_LIST_SIZE, mixing, skip

Constructor Summary

Constructors
Modifier Constructor and Description

protected MongoQuery(EntityDescriptor descriptor)
Creates a new query for the given descriptor.

Constructors
Modifier	Constructor and Description
`protected`	`MongoQuery(EntityDescriptor descriptor)` Creates a new query for the given descriptor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`count()` Executes the query and counts the number of results.
`void`	`delete()` Deletes all matches using the `BaseMapper.delete(BaseEntity)` of the appropriate mapper.
`MongoQuery<E>`	`eq(Mapping key, Object value)` Adds a constraint which ensures that the given field contains the given value.
`MongoQuery<E>`	`eqIgnoreNull(Mapping field, Object value)` Adds a constraint which ensures that the given field contains the given value.
`boolean`	`exists()` Determines if the query would have at least one matching entity.
`MongoQuery<E>`	`fields(Mapping... fieldsToReturn)` Limits the fields being returned to the given list.
`FilterFactory<MongoConstraint>`	`filters()`
`void`	`iterate(Function<E,Boolean> resultHandler)` Calls the given function on all items in the result, as long as it returns `true`.
`MongoQuery<E>`	`limit(int limit)` Specifies the max. number of items to fetch.
`MongoQuery<E>`	`limit(int skip, int limit)` Adds a limit to the query.
`MongoQuery<E>`	`orderAsc(Mapping field)` Adds a sort constraint to order by the given field ascending.
`MongoQuery<E>`	`orderDesc(Mapping field)` Adds a sort constraint to order by the given field descending.
`MongoQuery<E>`	`skip(int skip)` Specifies the number of items to skip before items are added to the result.
`String`	`toString()`
`void`	`truncate()` Deletes all matches using the capabilities of the underlying database.
`MongoQuery<E>`	`where(MongoConstraint constraint)` Applies the given contraints to the query.

Methods inherited from class sirius.db.mixing.query.Query
ne, queryString

Methods inherited from class sirius.db.mixing.query.BaseQuery
failOnOverflow, first, getDescriptor, getLimit, iterateAll, one, queryFirst, queryList, queryOne

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MongoQuery
```
protected MongoQuery(EntityDescriptor descriptor)
```
    Creates a new query for the given descriptor.
    
    Parameters:
    
    descriptor - the descriptor of the entities being queried
- Method Detail
  - fields
```
public MongoQuery<E> fields(Mapping... fieldsToReturn)
```
    Limits the fields being returned to the given list.
    
    Parameters:
    
    fieldsToReturn - specified the list of fields to return
    
    Returns:
    
    the builder itself for fluent method calls
  - eq
```
public MongoQuery<E> eq(Mapping key,
                        Object value)
```
    Description copied from class: Query
    
    Adds a constraint which ensures that the given field contains the given value.
    
    Overrides:
    
    eq in class Query<MongoQuery<E extends MongoEntity>,E extends MongoEntity,MongoConstraint>
    
    Parameters:
    
    key - the name of the field to filter on
    
    value - the value to filter on
    
    Returns:
    
    the query itself for fluent method calls
  - eqIgnoreNull
```
public MongoQuery<E> eqIgnoreNull(Mapping field,
                                  Object value)
```
    Description copied from class: Query
    
    Adds a constraint which ensures that the given field contains the given value.
    If the given value is null, the constraint is skipped.
    
    Overrides:
    
    eqIgnoreNull in class Query<MongoQuery<E extends MongoEntity>,E extends MongoEntity,MongoConstraint>
    
    Parameters:
    
    field - the field to check
    
    value - the value to filter on
    
    Returns:
    
    the query itself for fluent method calls
  - where
```
public MongoQuery<E> where(MongoConstraint constraint)
```
    Description copied from class: Query
    
    Applies the given contraints to the query.
    
    Specified by:
    
    where in class Query<MongoQuery<E extends MongoEntity>,E extends MongoEntity,MongoConstraint>
    
    Parameters:
    
    constraint - the constraint which has to be fullfilled
    
    Returns:
    
    the query itself for fluent method calls
  - orderAsc
```
public MongoQuery<E> orderAsc(Mapping field)
```
    Description copied from class: Query
    
    Adds a sort constraint to order by the given field ascending.
    
    Specified by:
    
    orderAsc in class Query<MongoQuery<E extends MongoEntity>,E extends MongoEntity,MongoConstraint>
    
    Parameters:
    
    field - the field to order by.
    
    Returns:
    
    the builder itself for fluent method calls
  - orderDesc
```
public MongoQuery<E> orderDesc(Mapping field)
```
    Description copied from class: Query
    
    Adds a sort constraint to order by the given field descending.
    
    Specified by:
    
    orderDesc in class Query<MongoQuery<E extends MongoEntity>,E extends MongoEntity,MongoConstraint>
    
    Parameters:
    
    field - the field to order by.
    
    Returns:
    
    the builder itself for fluent method calls
  - limit
```
public MongoQuery<E> limit(int skip,
                           int limit)
```
    Adds a limit to the query.
    
    Parameters:
    
    skip - the number of items to skip (used for pagination).
    
    limit - the max. number of items to return (exluding those who have been skipped).
    
    Returns:
    
    the builder itself for fluent method calls
  - skip
```
public MongoQuery<E> skip(int skip)
```
    Description copied from class: BaseQuery
    
    Specifies the number of items to skip before items are added to the result.
    
    Overrides:
    
    skip in class BaseQuery<MongoQuery<E extends MongoEntity>,E extends MongoEntity>
    
    Parameters:
    
    skip - the number of items to skip. Value <= 0 are ignored.
    
    Returns:
    
    the query itself for fluent method calls
  - limit
```
public MongoQuery<E> limit(int limit)
```
    Description copied from class: BaseQuery
    
    Specifies the max. number of items to fetch.
    
    Overrides:
    
    limit in class BaseQuery<MongoQuery<E extends MongoEntity>,E extends MongoEntity>
    
    Parameters:
    
    limit - the max. number of items to fetch. Value <= 0 indicate "unlimited".
    
    Returns:
    
    the query itself for fluent method calls
  - iterate
```
public void iterate(Function<E,Boolean> resultHandler)
```
    Description copied from class: BaseQuery
    
    Calls the given function on all items in the result, as long as it returns true.
    Note that this method is intended for large results as not all items in the result need to be kept in memory when iterating through them.
    
    Specified by:
    
    iterate in class BaseQuery<MongoQuery<E extends MongoEntity>,E extends MongoEntity>
    
    Parameters:
    
    resultHandler - the handle to be invoked for each item in the result
  - count
```
public long count()
```
    Description copied from class: Query
    
    Executes the query and counts the number of results.
    
    Specified by:
    
    count in class Query<MongoQuery<E extends MongoEntity>,E extends MongoEntity,MongoConstraint>
    
    Returns:
    
    the number of matched result entries
  - exists
```
public boolean exists()
```
    Description copied from class: Query
    
    Determines if the query would have at least one matching entity.
    
    Specified by:
    
    exists in class Query<MongoQuery<E extends MongoEntity>,E extends MongoEntity,MongoConstraint>
    
    Returns:
    
    true if at least one entity matches the query, false otherwise.
  - delete
```
public void delete()
```
    Description copied from class: Query
    
    Deletes all matches using the BaseMapper.delete(BaseEntity) of the appropriate mapper.
    Be aware that this might be slow for very large result sets.
    
    Specified by:
    
    delete in class Query<MongoQuery<E extends MongoEntity>,E extends MongoEntity,MongoConstraint>
  - truncate
```
public void truncate()
```
    Description copied from class: Query
    
    Deletes all matches using the capabilities of the underlying database.
    Therefore no checks or anything will be invoked for the deleted entities.
    Use this for larger result sets where integrity and constraints do not matter or are managed manually.
    
    Specified by:
    
    truncate in class Query<MongoQuery<E extends MongoEntity>,E extends MongoEntity,MongoConstraint>
  - filters
```
public FilterFactory<MongoConstraint> filters()
```
    Specified by:
    
    filters in class Query<MongoQuery<E extends MongoEntity>,E extends MongoEntity,MongoConstraint>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MongoQuery<E extends MongoEntity>

Field Summary

Fields inherited from class sirius.db.mixing.query.BaseQuery

Constructor Summary

Method Summary

Methods inherited from class sirius.db.mixing.query.Query

Methods inherited from class sirius.db.mixing.query.BaseQuery

Methods inherited from class java.lang.Object

Constructor Detail

MongoQuery

Method Detail

fields

eq

eqIgnoreNull

where

orderAsc

orderDesc

limit

skip

limit

iterate

count

exists

delete

truncate

filters

toString