Entity
- The type of entity to operate onId
- The ID type of the entitypublic interface PanacheMongoRepositoryBase<Entity,Id>
Entity
, with an ID type
of Id
. Implementing this repository will gain you the exact same useful methods
that are on PanacheMongoEntityBase
. Unless you have a custom ID strategy, you should not
implement this interface directly but implement PanacheMongoRepository
instead.PanacheMongoRepository
Modifier and Type | Method and Description |
---|---|
default long |
count()
Counts the number of this type of entity in the database.
|
default long |
count(org.bson.Document query)
Counts the number of this type of entity matching the given query
|
default long |
count(String query,
Map<String,Object> params)
Counts the number of this type of entity matching the given query, with named parameters.
|
default long |
count(String query,
Object... params)
Counts the number of this type of entity matching the given query, with optional indexed parameters.
|
default long |
count(String query,
Parameters params)
Counts the number of this type of entity matching the given query, with named parameters.
|
default long |
delete(org.bson.Document query)
Delete all entities of this type matching the given query
|
default void |
delete(Entity entity)
Delete the given entity from the database, if it is already persisted.
|
default long |
delete(String query,
Map<String,Object> params)
Delete all entities of this type matching the given query, with named parameters.
|
default long |
delete(String query,
Object... params)
Delete all entities of this type matching the given query, with optional indexed parameters.
|
default long |
delete(String query,
Parameters params)
Delete all entities of this type matching the given query, with named parameters.
|
default long |
deleteAll()
Delete all entities of this type from the database.
|
default boolean |
deleteById(Id id)
Delete an entity of this type by ID.
|
default PanacheQuery<Entity> |
find(org.bson.Document query)
Find entities using a BSON query.
|
default PanacheQuery<Entity> |
find(org.bson.Document query,
org.bson.Document sort)
Find entities using a a BSON query and a BSON sort.
|
default PanacheQuery<Entity> |
find(String query,
Map<String,Object> params)
Find entities using a query, with named parameters.
|
default PanacheQuery<Entity> |
find(String query,
Object... params)
Find entities using a query, with optional indexed parameters.
|
default PanacheQuery<Entity> |
find(String query,
Parameters params)
Find entities using a query, with named parameters.
|
default PanacheQuery<Entity> |
find(String query,
Sort sort,
Map<String,Object> params)
Find entities using a query and the given sort options, with named parameters.
|
default PanacheQuery<Entity> |
find(String query,
Sort sort,
Object... params)
Find entities using a query and the given sort options, with optional indexed parameters.
|
default PanacheQuery<Entity> |
find(String query,
Sort sort,
Parameters params)
Find entities using a query and the given sort options, with named parameters.
|
default PanacheQuery<Entity> |
findAll()
Find all entities of this type.
|
default PanacheQuery<Entity> |
findAll(Sort sort)
Find all entities of this type, in the given order.
|
default Entity |
findById(Id id)
Find an entity of this type by ID.
|
default Optional<Entity> |
findByIdOptional(Id id)
Find an entity of this type by ID.
|
default List<Entity> |
list(org.bson.Document query)
Find entities using a BSON query.
|
default List<Entity> |
list(org.bson.Document query,
org.bson.Document sort)
Find entities using a a BSON query and a BSON sort.
|
default List<Entity> |
list(String query,
Map<String,Object> params)
Find entities matching a query, with named parameters.
|
default List<Entity> |
list(String query,
Object... params)
Find entities matching a query, with optional indexed parameters.
|
default List<Entity> |
list(String query,
Parameters params)
Find entities matching a query, with named parameters.
|
default List<Entity> |
list(String query,
Sort sort,
Map<String,Object> params)
Find entities matching a query and the given sort options, with named parameters.
|
default List<Entity> |
list(String query,
Sort sort,
Object... params)
Find entities matching a query and the given sort options, with optional indexed parameters.
|
default List<Entity> |
list(String query,
Sort sort,
Parameters params)
Find entities matching a query and the given sort options, with named parameters.
|
default List<Entity> |
listAll()
Find all entities of this type.
|
default List<Entity> |
listAll(Sort sort)
Find all entities of this type, in the given order.
|
default com.mongodb.client.MongoCollection<Entity> |
mongoCollection()
Allow to access the underlying Mongo Collection
|
default com.mongodb.client.MongoDatabase |
mongoDatabase()
Allow to access the underlying Mongo Database.
|
default void |
persist(Entity entity)
Persist the given entity in the database.
|
default void |
persist(Entity firstEntity,
Entity... entities)
Persist all given entities.
|
default void |
persist(Iterable<Entity> entities)
Persist all given entities.
|
default void |
persist(Stream<Entity> entities)
Persist all given entities.
|
default void |
persistOrUpdate(Entity entity)
Persist the given entity in the database or update it if it already exist.
|
default void |
persistOrUpdate(Entity firstEntity,
Entity... entities)
Persist all given entities or update them if they already exist.
|
default void |
persistOrUpdate(Iterable<Entity> entities)
Persist all given entities or update them if they already exist.
|
default void |
persistOrUpdate(Stream<Entity> entities)
Persist all given entities or update them if they already exist.
|
default Stream<Entity> |
stream(org.bson.Document query)
Find entities using a BSON query.
|
default Stream<Entity> |
stream(org.bson.Document query,
org.bson.Document sort)
Find entities using a a BSON query and a BSON sort.
|
default Stream<Entity> |
stream(String query,
Map<String,Object> params)
Find entities matching a query, with named parameters.
|
default Stream<Entity> |
stream(String query,
Object... params)
Find entities matching a query, with optional indexed parameters.
|
default Stream<Entity> |
stream(String query,
Parameters params)
Find entities matching a query, with named parameters.
|
default Stream<Entity> |
stream(String query,
Sort sort,
Map<String,Object> params)
Find entities matching a query and the given sort options, with named parameters.
|
default Stream<Entity> |
stream(String query,
Sort sort,
Object... params)
Find entities matching a query and the given sort options, with optional indexed parameters.
|
default Stream<Entity> |
stream(String query,
Sort sort,
Parameters params)
Find entities matching a query and the given sort options, with named parameters.
|
default Stream<Entity> |
streamAll()
Find all entities of this type, in the given order.
|
default Stream<Entity> |
streamAll(Sort sort)
Find all entities of this type.
|
default void |
update(Entity entity)
Update the given entity in the database.
|
default void |
update(Entity firstEntity,
Entity... entities)
Update all given entities.
|
default void |
update(Iterable<Entity> entities)
Update all given entities.
|
default void |
update(Stream<Entity> entities)
Update all given entities.
|
default PanacheUpdate |
update(String update,
Map<String,Object> params)
Update all entities of this type by the given update document, with named parameters.
|
default PanacheUpdate |
update(String update,
Object... params)
Update all entities of this type by the given update document, with optional indexed parameters.
|
default PanacheUpdate |
update(String update,
Parameters params)
Update all entities of this type by the given update document, with named parameters.
|
default void persist(Entity entity)
entity
- the entity to insert.persist(Iterable)
,
persist(Stream)
,
persist(Object, Object...)
default void update(Entity entity)
entity
- the entity to update.update(Iterable)
,
update(Stream)
,
update(Object, Object...)
default void persistOrUpdate(Entity entity)
entity
- the entity to update.persistOrUpdate(Iterable)
,
persistOrUpdate(Stream)
,
persistOrUpdate(Object, Object...)
default void delete(Entity entity)
entity
- the entity to delete.delete(String, Object...)
,
delete(String, Map)
,
delete(String, Parameters)
,
deleteAll()
@GenerateBridge(targetReturnTypeErased=true) default Entity findById(Id id)
id
- the ID of the entity to find.null
if not found.@GenerateBridge default Optional<Entity> findByIdOptional(Id id)
id
- the ID of the entity to find.Optional.empty()
.@GenerateBridge default PanacheQuery<Entity> find(String query, Object... params)
query
- a query string
params
- optional sequence of indexed parametersPanacheQuery
instance for the given queryfind(String, Sort, Object...)
,
find(String, Map)
,
find(String, Parameters)
,
list(String, Object...)
,
stream(String, Object...)
@GenerateBridge default PanacheQuery<Entity> find(String query, Sort sort, Object... params)
query
- a query string
sort
- the sort strategy to useparams
- optional sequence of indexed parametersPanacheQuery
instance for the given queryfind(String, Object...)
,
find(String, Sort, Map)
,
find(String, Sort, Parameters)
,
list(String, Sort, Object...)
,
stream(String, Sort, Object...)
@GenerateBridge default PanacheQuery<Entity> find(String query, Map<String,Object> params)
query
- a query string
params
- Map
of named parametersPanacheQuery
instance for the given queryfind(String, Sort, Map)
,
find(String, Object...)
,
find(String, Parameters)
,
list(String, Map)
,
stream(String, Map)
@GenerateBridge default PanacheQuery<Entity> find(String query, Sort sort, Map<String,Object> params)
query
- a query string
sort
- the sort strategy to useparams
- Map
of indexed parametersPanacheQuery
instance for the given queryfind(String, Map)
,
find(String, Sort, Object...)
,
find(String, Sort, Parameters)
,
list(String, Sort, Map)
,
stream(String, Sort, Map)
@GenerateBridge default PanacheQuery<Entity> find(String query, Parameters params)
query
- a query string
params
- Parameters
of named parametersPanacheQuery
instance for the given queryfind(String, Sort, Parameters)
,
find(String, Map)
,
find(String, Parameters)
,
list(String, Parameters)
,
stream(String, Parameters)
@GenerateBridge default PanacheQuery<Entity> find(String query, Sort sort, Parameters params)
query
- a query string
sort
- the sort strategy to useparams
- Parameters
of indexed parametersPanacheQuery
instance for the given queryfind(String, Parameters)
,
find(String, Sort, Map)
,
find(String, Sort, Parameters)
,
list(String, Sort, Parameters)
,
stream(String, Sort, Parameters)
@GenerateBridge default PanacheQuery<Entity> find(org.bson.Document query)
query
- a Document
queryPanacheQuery
instance for the given queryfind(Document, Document)
,
list(Document)
,
list(Document, Document)
,
stream(Document)
,
stream(Document, Document)
@GenerateBridge default PanacheQuery<Entity> find(org.bson.Document query, org.bson.Document sort)
query
- a Document
querysort
- the Document
sortPanacheQuery
instance for the given queryfind(Document)
,
list(Document)
,
list(Document, Document)
,
stream(Document)
,
stream(Document, Document)
@GenerateBridge default PanacheQuery<Entity> findAll()
PanacheQuery
instance to find all entities of this type.findAll(Sort)
,
listAll()
,
streamAll()
@GenerateBridge default PanacheQuery<Entity> findAll(Sort sort)
sort
- the sort order to usePanacheQuery
instance to find all entities of this type.findAll()
,
listAll(Sort)
,
streamAll(Sort)
@GenerateBridge default List<Entity> list(String query, Object... params)
find(query, params).list()
.query
- a query string
params
- optional sequence of indexed parametersList
containing all results, without paginglist(String, Sort, Object...)
,
list(String, Map)
,
list(String, Parameters)
,
find(String, Object...)
,
stream(String, Object...)
@GenerateBridge default List<Entity> list(String query, Sort sort, Object... params)
find(query, sort, params).list()
.query
- a query string
sort
- the sort strategy to useparams
- optional sequence of indexed parametersList
containing all results, without paginglist(String, Object...)
,
list(String, Sort, Map)
,
list(String, Sort, Parameters)
,
find(String, Sort, Object...)
,
stream(String, Sort, Object...)
@GenerateBridge default List<Entity> list(String query, Map<String,Object> params)
find(query, params).list()
.query
- a query string
params
- Map
of named parametersList
containing all results, without paginglist(String, Sort, Map)
,
list(String, Object...)
,
list(String, Parameters)
,
find(String, Map)
,
stream(String, Map)
@GenerateBridge default List<Entity> list(String query, Sort sort, Map<String,Object> params)
find(query, sort, params).list()
.query
- a query string
sort
- the sort strategy to useparams
- Map
of indexed parametersList
containing all results, without paginglist(String, Map)
,
list(String, Sort, Object...)
,
list(String, Sort, Parameters)
,
find(String, Sort, Map)
,
stream(String, Sort, Map)
@GenerateBridge default List<Entity> list(String query, Parameters params)
find(query, params).list()
.query
- a query string
params
- Parameters
of named parametersList
containing all results, without paginglist(String, Sort, Parameters)
,
list(String, Object...)
,
list(String, Map)
,
find(String, Parameters)
,
stream(String, Parameters)
@GenerateBridge default List<Entity> list(String query, Sort sort, Parameters params)
find(query, sort, params).list()
.query
- a query string
sort
- the sort strategy to useparams
- Parameters
of indexed parametersList
containing all results, without paginglist(String, Parameters)
,
list(String, Sort, Object...)
,
list(String, Sort, Map)
,
find(String, Sort, Parameters)
,
stream(String, Sort, Parameters)
@GenerateBridge default List<Entity> list(org.bson.Document query)
find(query).list()
.query
- a Document
queryList
containing all results, without pagingfind(Document)
,
find(Document, Document)
,
list(Document, Document)
,
stream(Document)
,
stream(Document, Document)
@GenerateBridge default List<Entity> list(org.bson.Document query, org.bson.Document sort)
find(query, sort).list()
.query
- a Document
querysort
- the Document
sortList
containing all results, without pagingfind(Document)
,
find(Document, Document)
,
list(Document)
,
stream(Document)
,
stream(Document, Document)
@GenerateBridge default List<Entity> listAll()
findAll().list()
.List
containing all results, without paginglistAll(Sort)
,
findAll()
,
streamAll()
@GenerateBridge default List<Entity> listAll(Sort sort)
findAll(sort).list()
.sort
- the sort order to useList
containing all results, without paginglistAll()
,
findAll(Sort)
,
streamAll(Sort)
@GenerateBridge default Stream<Entity> stream(String query, Object... params)
find(query, params).stream()
.query
- a query string
params
- optional sequence of indexed parametersStream
containing all results, without pagingstream(String, Sort, Object...)
,
stream(String, Map)
,
stream(String, Parameters)
,
find(String, Object...)
,
list(String, Object...)
@GenerateBridge default Stream<Entity> stream(String query, Sort sort, Object... params)
find(query, sort, params).stream()
.query
- a query string
sort
- the sort strategy to useparams
- optional sequence of indexed parametersStream
containing all results, without pagingstream(String, Object...)
,
stream(String, Sort, Map)
,
stream(String, Sort, Parameters)
,
find(String, Sort, Object...)
,
list(String, Sort, Object...)
@GenerateBridge default Stream<Entity> stream(String query, Map<String,Object> params)
find(query, params).stream()
.query
- a query string
params
- Map
of named parametersStream
containing all results, without pagingstream(String, Sort, Map)
,
stream(String, Object...)
,
stream(String, Parameters)
,
find(String, Map)
,
list(String, Map)
@GenerateBridge default Stream<Entity> stream(String query, Sort sort, Map<String,Object> params)
find(query, sort, params).stream()
.query
- a query string
sort
- the sort strategy to useparams
- Map
of indexed parametersStream
containing all results, without pagingstream(String, Map)
,
stream(String, Sort, Object...)
,
stream(String, Sort, Parameters)
,
find(String, Sort, Map)
,
list(String, Sort, Map)
@GenerateBridge default Stream<Entity> stream(String query, Parameters params)
find(query, params).stream()
.query
- a query string
params
- Parameters
of named parametersStream
containing all results, without pagingstream(String, Sort, Parameters)
,
stream(String, Object...)
,
stream(String, Map)
,
find(String, Parameters)
,
list(String, Parameters)
@GenerateBridge default Stream<Entity> stream(String query, Sort sort, Parameters params)
find(query, sort, params).stream()
.query
- a query string
sort
- the sort strategy to useparams
- Parameters
of indexed parametersStream
containing all results, without pagingstream(String, Parameters)
,
stream(String, Sort, Object...)
,
stream(String, Sort, Map)
,
find(String, Sort, Parameters)
,
list(String, Sort, Parameters)
@GenerateBridge default Stream<Entity> stream(org.bson.Document query)
find(query).stream()
.query
- a Document
queryStream
containing all results, without pagingfind(Document)
,
find(Document, Document)
,
list(Document)
,
list(Document, Document)
,
stream(Document, Document)
@GenerateBridge default Stream<Entity> stream(org.bson.Document query, org.bson.Document sort)
find(query, sort).stream()
.query
- a Document
querysort
- the Document
sortStream
containing all results, without pagingfind(Document)
,
find(Document, Document)
,
list(Document)
,
list(Document, Document)
,
stream(Document)
@GenerateBridge default Stream<Entity> streamAll(Sort sort)
findAll().stream()
.Stream
containing all results, without pagingstreamAll(Sort)
,
findAll()
,
listAll()
@GenerateBridge default Stream<Entity> streamAll()
findAll(sort).stream()
.Stream
containing all results, without pagingstreamAll()
,
findAll(Sort)
,
listAll(Sort)
@GenerateBridge default long count()
count(String, Object...)
,
count(String, Map)
,
count(String, Parameters)
@GenerateBridge default long count(String query, Object... params)
query
- a query string
params
- optional sequence of indexed parameterscount()
,
count(String, Map)
,
count(String, Parameters)
@GenerateBridge default long count(String query, Map<String,Object> params)
query
- a query string
params
- Map
of named parameterscount()
,
count(String, Object...)
,
count(String, Parameters)
@GenerateBridge default long count(String query, Parameters params)
query
- a query string
params
- Parameters
of named parameterscount()
,
count(String, Object...)
,
count(String, Map)
@GenerateBridge default long count(org.bson.Document query)
query
- a Document
querycount()
,
count(String, Object...)
,
count(String, Map)
@GenerateBridge default long deleteAll()
delete(String, Object...)
,
delete(String, Map)
,
delete(String, Parameters)
@GenerateBridge default boolean deleteById(Id id)
id
- the ID of the entity to delete.@GenerateBridge default long delete(String query, Object... params)
query
- a query string
params
- optional sequence of indexed parametersdeleteAll()
,
delete(String, Map)
,
delete(String, Parameters)
@GenerateBridge default long delete(String query, Map<String,Object> params)
query
- a query string
params
- Map
of named parametersdeleteAll()
,
delete(String, Object...)
,
delete(String, Parameters)
@GenerateBridge default long delete(String query, Parameters params)
query
- a query string
params
- Parameters
of named parametersdeleteAll()
,
delete(String, Object...)
,
delete(String, Map)
@GenerateBridge default long delete(org.bson.Document query)
query
- a Document
querycount()
,
count(String, Object...)
,
count(String, Map)
default void persist(Iterable<Entity> entities)
entities
- the entities to insertpersist(Object)
,
persist(Stream)
,
persist(Object,Object...)
default void persist(Stream<Entity> entities)
entities
- the entities to insertpersist(Object)
,
persist(Iterable)
,
persist(Object,Object...)
default void persist(Entity firstEntity, Entity... entities)
entities
- the entities to insertpersist(Object)
,
persist(Stream)
,
persist(Iterable)
default void update(Iterable<Entity> entities)
entities
- the entities to updateupdate(Object)
,
update(Stream)
,
update(Object,Object...)
default void update(Stream<Entity> entities)
entities
- the entities to updateupdate(Object)
,
update(Iterable)
,
update(Object,Object...)
default void update(Entity firstEntity, Entity... entities)
entities
- the entities to updateupdate(Object)
,
update(Stream)
,
update(Iterable)
default void persistOrUpdate(Iterable<Entity> entities)
entities
- the entities to updatepersistOrUpdate(Object)
,
persistOrUpdate(Stream)
,
persistOrUpdate(Object,Object...)
default void persistOrUpdate(Stream<Entity> entities)
entities
- the entities to updatepersistOrUpdate(Object)
,
persistOrUpdate(Iterable)
,
persistOrUpdate(Object,Object...)
default void persistOrUpdate(Entity firstEntity, Entity... entities)
entities
- the entities to updateupdate(Object)
,
update(Stream)
,
update(Iterable)
@GenerateBridge default PanacheUpdate update(String update, Object... params)
PanacheUpdate
object will allow to restrict on which documents the update should be applied.update
- the update document, if it didn't contain $set
we add it.
It can also be expressed as a query string
.params
- optional sequence of indexed parametersPanacheUpdate
instance for the given update documentupdate(String, Map)
,
update(String, Parameters)
@GenerateBridge default PanacheUpdate update(String update, Map<String,Object> params)
PanacheUpdate
object will allow to restrict on which documents the update should be applied.update
- the update document, if it didn't contain $set
we add it.
It can also be expressed as a query string
.params
- Map
of named parametersPanacheUpdate
instance for the given update documentupdate(String, Object...)
,
update(String, Parameters)
@GenerateBridge default PanacheUpdate update(String update, Parameters params)
PanacheUpdate
object will allow to restrict on which document the update should be applied.update
- the update document, if it didn't contain $set
we add it.
It can also be expressed as a query string
.params
- Parameters
of named parametersPanacheUpdate
instance for the given update documentupdate(String, Object...)
,
update(String, Map)
@GenerateBridge default com.mongodb.client.MongoCollection<Entity> mongoCollection()
@GenerateBridge default com.mongodb.client.MongoDatabase mongoDatabase()
Copyright © 2020 JBoss by Red Hat. All rights reserved.