Package io.quarkus.mongodb.panache
Class PanacheMongoEntityBase
- java.lang.Object
-
- io.quarkus.mongodb.panache.PanacheMongoEntityBase
-
- Direct Known Subclasses:
PanacheMongoEntity
public abstract class PanacheMongoEntityBase extends Object
Represents an entity. If your Mongo entities extend this class they gain auto-generated accessors to all their public fields, as well as a lot of useful methods. Unless you have a custom ID strategy, you should not extend this class directly but extendPanacheMongoEntity
instead.- See Also:
PanacheMongoEntity
-
-
Constructor Summary
Constructors Constructor Description PanacheMongoEntityBase()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static long
count()
Counts the number of this type of entity in the database.static long
count(String query, Parameters params)
Counts the number of this type of entity matching the given query, with named parameters.static long
count(String query, Object... params)
Counts the number of this type of entity matching the given query, with optional indexed parameters.static long
count(String query, Map<String,Object> params)
Counts the number of this type of entity matching the given query, with named parameters.static long
count(org.bson.Document query)
Counts the number of this type of entity matching the given queryvoid
delete()
Delete this entity from the database, if it is already persisted.static long
delete(String query, Parameters params)
Delete all entities of this type matching the given query, with named parameters.static long
delete(String query, Object... params)
Delete all entities of this type matching the given query, with optional indexed parameters.static long
delete(String query, Map<String,Object> params)
Delete all entities of this type matching the given query, with named parameters.static long
delete(org.bson.Document query)
Delete all entities of this type matching the given querystatic long
deleteAll()
Delete all entities of this type from the database.static boolean
deleteById(Object id)
Delete an entity of this type by ID.static <T extends PanacheMongoEntityBase>
PanacheQuery<T>find(String query, Parameters params)
Find entities using a query, with named parameters.static <T extends PanacheMongoEntityBase>
PanacheQuery<T>find(String query, Sort sort, Parameters params)
Find entities using a query and the given sort options, with named parameters.static <T extends PanacheMongoEntityBase>
PanacheQuery<T>find(String query, Sort sort, Object... params)
Find entities using a query and the given sort options, with optional indexed parameters.static <T extends PanacheMongoEntityBase>
PanacheQuery<T>find(String query, Sort sort, Map<String,Object> params)
Find entities using a query and the given sort options, with named parameters.static <T extends PanacheMongoEntityBase>
PanacheQuery<T>find(String query, Object... params)
Find entities using a query, with optional indexed parameters.static <T extends PanacheMongoEntityBase>
PanacheQuery<T>find(String query, Map<String,Object> params)
Find entities using a query, with named parameters.static <T extends PanacheMongoEntityBase>
PanacheQuery<T>find(org.bson.Document query)
Find entities using a BSON query.static <T extends PanacheMongoEntityBase>
PanacheQuery<T>find(org.bson.Document query, org.bson.Document sort)
Find entities using a BSON query and a BSON sort.static <T extends PanacheMongoEntityBase>
PanacheQuery<T>findAll()
Find all entities of this type.static <T extends PanacheMongoEntityBase>
PanacheQuery<T>findAll(Sort sort)
Find all entities of this type, in the given order.static <T extends PanacheMongoEntityBase>
TfindById(Object id)
Find an entity of this type by ID.static <T extends PanacheMongoEntityBase>
Optional<T>findByIdOptional(Object id)
Find an entity of this type by ID.static <T extends PanacheMongoEntityBase>
List<T>list(String query, Parameters params)
Find entities matching a query, with named parameters.static <T extends PanacheMongoEntityBase>
List<T>list(String query, Sort sort, Parameters params)
Find entities matching a query and the given sort options, with named parameters.static <T extends PanacheMongoEntityBase>
List<T>list(String query, Sort sort, Object... params)
Find entities matching a query and the given sort options, with optional indexed parameters.static <T extends PanacheMongoEntityBase>
List<T>list(String query, Sort sort, Map<String,Object> params)
Find entities matching a query and the given sort options, with named parameters.static <T extends PanacheMongoEntityBase>
List<T>list(String query, Object... params)
Find entities matching a query, with optional indexed parameters.static <T extends PanacheMongoEntityBase>
List<T>list(String query, Map<String,Object> params)
Find entities matching a query, with named parameters.static <T extends PanacheMongoEntityBase>
List<T>list(org.bson.Document query)
Find entities using a BSON query.static <T extends PanacheMongoEntityBase>
List<T>list(org.bson.Document query, org.bson.Document sort)
Find entities using a BSON query and a BSON sort.static <T extends PanacheMongoEntityBase>
List<T>listAll()
Find all entities of this type.static <T extends PanacheMongoEntityBase>
List<T>listAll(Sort sort)
Find all entities of this type, in the given order.static <T extends PanacheMongoEntityBase>
com.mongodb.client.MongoCollection<T>mongoCollection()
Allow to access the underlying Mongo Collection.static com.mongodb.client.MongoDatabase
mongoDatabase()
Allow to access the underlying Mongo Database.void
persist()
Persist this entity in the database.static void
persist(Iterable<?> entities)
Insert all given entities.static void
persist(Object firstEntity, Object... entities)
Insert all given entities.static void
persist(Stream<?> entities)
Insert all given entities.void
persistOrUpdate()
Persist this entity in the database or update it if it already exists.static void
persistOrUpdate(Iterable<?> entities)
Persist all given entities or update them if they already exist.static void
persistOrUpdate(Object firstEntity, Object... entities)
Persist all given entities.static void
persistOrUpdate(Stream<?> entities)
Persist all given entities.static <T extends PanacheMongoEntityBase>
Stream<T>stream(String query, Parameters params)
Find entities matching a query, with named parameters.static <T extends PanacheMongoEntityBase>
Stream<T>stream(String query, Sort sort, Parameters params)
Find entities matching a query and the given sort options, with named parameters.static <T extends PanacheMongoEntityBase>
Stream<T>stream(String query, Sort sort, Object... params)
Find entities matching a query and the given sort options, with optional indexed parameters.static <T extends PanacheMongoEntityBase>
Stream<T>stream(String query, Sort sort, Map<String,Object> params)
Find entities matching a query and the given sort options, with named parameters.static <T extends PanacheMongoEntityBase>
Stream<T>stream(String query, Object... params)
Find entities matching a query, with optional indexed parameters.static <T extends PanacheMongoEntityBase>
Stream<T>stream(String query, Map<String,Object> params)
Find entities matching a query, with named parameters.static <T extends PanacheMongoEntityBase>
Stream<T>stream(org.bson.Document query)
Find entities using a BSON query.static <T extends PanacheMongoEntityBase>
Stream<T>stream(org.bson.Document query, org.bson.Document sort)
Find entities using a BSON query and a BSON sort.static <T extends PanacheMongoEntityBase>
Stream<T>streamAll()
Find all entities of this type.static <T extends PanacheMongoEntityBase>
Stream<T>streamAll(Sort sort)
Find all entities of this type, in the given order.void
update()
Update this entity in the database.static void
update(Iterable<?> entities)
Update all given entities.static void
update(Object firstEntity, Object... entities)
Update all given entities.static PanacheUpdate
update(String update, Parameters params)
Update all entities of this type by the given update document, with named parameters.static PanacheUpdate
update(String update, Object... params)
Update all entities of this type by the given update document, with optional indexed parameters.static PanacheUpdate
update(String update, Map<String,Object> params)
Update all entities of this type by the given update document, with named parameters.static void
update(Stream<?> entities)
Update all given entities.static PanacheUpdate
update(org.bson.Document update)
Update all entities of this type by the given update BSON document.
-
-
-
Method Detail
-
persist
public void persist()
Persist this entity in the database. This will set its ID field if not already set.
-
update
public void update()
Update this entity in the database.- See Also:
update(Iterable)
,update(Stream)
,update(Object, Object...)
-
persistOrUpdate
public void persistOrUpdate()
Persist this entity in the database or update it if it already exists.
-
delete
public void delete()
Delete this entity from the database, if it is already persisted.
-
findById
@GenerateBridge(targetReturnTypeErased=true) public static <T extends PanacheMongoEntityBase> T findById(Object id)
Find an entity of this type by ID.- Parameters:
id
- the ID of the entity to find.- Returns:
- the entity found, or
null
if not found.
-
findByIdOptional
@GenerateBridge public static <T extends PanacheMongoEntityBase> Optional<T> findByIdOptional(Object id)
Find an entity of this type by ID.- Parameters:
id
- the ID of the entity to find.- Returns:
- if found, an optional containing the entity, else
Optional.empty()
.
-
find
@GenerateBridge public static <T extends PanacheMongoEntityBase> PanacheQuery<T> find(String query, Object... params)
Find entities using a query, with optional indexed parameters.- Parameters:
query
- aquery string
params
- optional sequence of indexed parameters- Returns:
- a new
PanacheQuery
instance for the given query - See Also:
find(String, Sort, Object...)
,find(String, Map)
,find(String, Parameters)
,list(String, Object...)
,stream(String, Object...)
-
find
@GenerateBridge public static <T extends PanacheMongoEntityBase> PanacheQuery<T> find(String query, Sort sort, Object... params)
Find entities using a query and the given sort options, with optional indexed parameters.- Parameters:
query
- aquery string
sort
- the sort strategy to useparams
- optional sequence of indexed parameters- Returns:
- a new
PanacheQuery
instance for the given query - See Also:
find(String, Object...)
,find(String, Sort, Map)
,find(String, Sort, Parameters)
,list(String, Sort, Object...)
,stream(String, Sort, Object...)
-
find
@GenerateBridge public static <T extends PanacheMongoEntityBase> PanacheQuery<T> find(String query, Map<String,Object> params)
Find entities using a query, with named parameters.- Parameters:
query
- aquery string
params
-Map
of named parameters- Returns:
- a new
PanacheQuery
instance for the given query - See Also:
find(String, Sort, Map)
,find(String, Object...)
,find(String, Parameters)
,list(String, Map)
,stream(String, Map)
-
find
@GenerateBridge public static <T extends PanacheMongoEntityBase> PanacheQuery<T> find(String query, Sort sort, Map<String,Object> params)
Find entities using a query and the given sort options, with named parameters.- Parameters:
query
- aquery string
sort
- the sort strategy to useparams
-Map
of indexed parameters- Returns:
- a new
PanacheQuery
instance for the given query - See Also:
find(String, Map)
,find(String, Sort, Object...)
,find(String, Sort, Parameters)
,list(String, Sort, Map)
,stream(String, Sort, Map)
-
find
@GenerateBridge public static <T extends PanacheMongoEntityBase> PanacheQuery<T> find(String query, Parameters params)
Find entities using a query, with named parameters.- Parameters:
query
- aquery string
params
-Parameters
of named parameters- Returns:
- a new
PanacheQuery
instance for the given query - See Also:
find(String, Sort, Parameters)
,find(String, Map)
,find(String, Parameters)
,list(String, Parameters)
,stream(String, Parameters)
-
find
@GenerateBridge public static <T extends PanacheMongoEntityBase> PanacheQuery<T> find(String query, Sort sort, Parameters params)
Find entities using a query and the given sort options, with named parameters.- Parameters:
query
- aquery string
sort
- the sort strategy to useparams
-Parameters
of indexed parameters- Returns:
- a new
PanacheQuery
instance for the given query - See Also:
find(String, Parameters)
,find(String, Sort, Map)
,find(String, Sort, Parameters)
,list(String, Sort, Parameters)
,stream(String, Sort, Parameters)
-
find
@GenerateBridge public static <T extends PanacheMongoEntityBase> PanacheQuery<T> find(org.bson.Document query)
Find entities using a BSON query.- Parameters:
query
- aDocument
query- Returns:
- a new
PanacheQuery
instance for the given query - See Also:
find(Document, Document)
,list(Document)
,list(Document, Document)
,stream(Document)
,stream(Document, Document)
-
find
@GenerateBridge public static <T extends PanacheMongoEntityBase> PanacheQuery<T> find(org.bson.Document query, org.bson.Document sort)
Find entities using a BSON query and a BSON sort.- Parameters:
query
- aDocument
querysort
- theDocument
sort- Returns:
- a new
PanacheQuery
instance for the given query - See Also:
find(Document)
,list(Document)
,list(Document, Document)
,stream(Document)
,stream(Document, Document)
-
findAll
@GenerateBridge public static <T extends PanacheMongoEntityBase> PanacheQuery<T> findAll()
Find all entities of this type.- Returns:
- a new
PanacheQuery
instance to find all entities of this type. - See Also:
findAll(Sort)
,listAll()
,streamAll()
-
findAll
@GenerateBridge public static <T extends PanacheMongoEntityBase> PanacheQuery<T> findAll(Sort sort)
Find all entities of this type, in the given order.- Parameters:
sort
- the sort order to use- Returns:
- a new
PanacheQuery
instance to find all entities of this type. - See Also:
findAll()
,listAll(Sort)
,streamAll(Sort)
-
list
@GenerateBridge public static <T extends PanacheMongoEntityBase> List<T> list(String query, Object... params)
Find entities matching a query, with optional indexed parameters. This method is a shortcut forfind(query, params).list()
.- Parameters:
query
- aquery string
params
- optional sequence of indexed parameters- Returns:
- a
List
containing all results, without paging - See Also:
list(String, Sort, Object...)
,list(String, Map)
,list(String, Parameters)
,find(String, Object...)
,stream(String, Object...)
-
list
@GenerateBridge public static <T extends PanacheMongoEntityBase> List<T> list(String query, Sort sort, Object... params)
Find entities matching a query and the given sort options, with optional indexed parameters. This method is a shortcut forfind(query, sort, params).list()
.- Parameters:
query
- aquery string
sort
- the sort strategy to useparams
- optional sequence of indexed parameters- Returns:
- a
List
containing all results, without paging - See Also:
list(String, Object...)
,list(String, Sort, Map)
,list(String, Sort, Parameters)
,find(String, Sort, Object...)
,stream(String, Sort, Object...)
-
list
@GenerateBridge public static <T extends PanacheMongoEntityBase> List<T> list(String query, Map<String,Object> params)
Find entities matching a query, with named parameters. This method is a shortcut forfind(query, params).list()
.- Parameters:
query
- aquery string
params
-Map
of named parameters- Returns:
- a
List
containing all results, without paging - See Also:
list(String, Sort, Map)
,list(String, Object...)
,list(String, Parameters)
,find(String, Map)
,stream(String, Map)
-
list
@GenerateBridge public static <T extends PanacheMongoEntityBase> List<T> list(String query, Sort sort, Map<String,Object> params)
Find entities matching a query and the given sort options, with named parameters. This method is a shortcut forfind(query, sort, params).list()
.- Parameters:
query
- aquery string
sort
- the sort strategy to useparams
-Map
of indexed parameters- Returns:
- a
List
containing all results, without paging - See Also:
list(String, Map)
,list(String, Sort, Object...)
,list(String, Sort, Parameters)
,find(String, Sort, Map)
,stream(String, Sort, Map)
-
list
@GenerateBridge public static <T extends PanacheMongoEntityBase> List<T> list(String query, Parameters params)
Find entities matching a query, with named parameters. This method is a shortcut forfind(query, params).list()
.- Parameters:
query
- aquery string
params
-Parameters
of named parameters- Returns:
- a
List
containing all results, without paging - See Also:
list(String, Sort, Parameters)
,list(String, Object...)
,list(String, Map)
,find(String, Parameters)
,stream(String, Parameters)
-
list
@GenerateBridge public static <T extends PanacheMongoEntityBase> List<T> list(String query, Sort sort, Parameters params)
Find entities matching a query and the given sort options, with named parameters. This method is a shortcut forfind(query, sort, params).list()
.- Parameters:
query
- aquery string
sort
- the sort strategy to useparams
-Parameters
of indexed parameters- Returns:
- a
List
containing all results, without paging - See Also:
list(String, Parameters)
,list(String, Sort, Object...)
,list(String, Sort, Map)
,find(String, Sort, Parameters)
,stream(String, Sort, Parameters)
-
list
@GenerateBridge public static <T extends PanacheMongoEntityBase> List<T> list(org.bson.Document query)
Find entities using a BSON query. This method is a shortcut forfind(query).list()
.- Parameters:
query
- aDocument
query- Returns:
- a
List
containing all results, without paging - See Also:
find(Document)
,find(Document, Document)
,list(Document, Document)
,stream(Document)
,stream(Document, Document)
-
list
@GenerateBridge public static <T extends PanacheMongoEntityBase> List<T> list(org.bson.Document query, org.bson.Document sort)
Find entities using a BSON query and a BSON sort. This method is a shortcut forfind(query, sort).list()
.- Parameters:
query
- aDocument
querysort
- theDocument
sort- Returns:
- a
List
containing all results, without paging - See Also:
find(Document)
,find(Document, Document)
,list(Document)
,stream(Document)
,stream(Document, Document)
-
listAll
@GenerateBridge public static <T extends PanacheMongoEntityBase> List<T> listAll()
Find all entities of this type. This method is a shortcut forfindAll().list()
.- Returns:
- a
List
containing all results, without paging - See Also:
listAll(Sort)
,findAll()
,streamAll()
-
listAll
@GenerateBridge public static <T extends PanacheMongoEntityBase> List<T> listAll(Sort sort)
Find all entities of this type, in the given order. This method is a shortcut forfindAll(sort).list()
.- Parameters:
sort
- the sort order to use- Returns:
- a
List
containing all results, without paging - See Also:
listAll()
,findAll(Sort)
,streamAll(Sort)
-
stream
@GenerateBridge public static <T extends PanacheMongoEntityBase> Stream<T> stream(String query, Object... params)
Find entities matching a query, with optional indexed parameters. This method is a shortcut forfind(query, params).stream()
.- Parameters:
query
- aquery string
params
- optional sequence of indexed parameters- Returns:
- a
Stream
containing all results, without paging - See Also:
stream(String, Sort, Object...)
,stream(String, Map)
,stream(String, Parameters)
,find(String, Object...)
,list(String, Object...)
-
stream
@GenerateBridge public static <T extends PanacheMongoEntityBase> Stream<T> stream(String query, Sort sort, Object... params)
Find entities matching a query and the given sort options, with optional indexed parameters. This method is a shortcut forfind(query, sort, params).stream()
.- Parameters:
query
- aquery string
sort
- the sort strategy to useparams
- optional sequence of indexed parameters- Returns:
- a
Stream
containing all results, without paging - See Also:
stream(String, Object...)
,stream(String, Sort, Map)
,stream(String, Sort, Parameters)
,find(String, Sort, Object...)
,list(String, Sort, Object...)
-
stream
@GenerateBridge public static <T extends PanacheMongoEntityBase> Stream<T> stream(String query, Map<String,Object> params)
Find entities matching a query, with named parameters. This method is a shortcut forfind(query, params).stream()
.- Parameters:
query
- aquery string
params
-Map
of named parameters- Returns:
- a
Stream
containing all results, without paging - See Also:
stream(String, Sort, Map)
,stream(String, Object...)
,stream(String, Parameters)
,find(String, Map)
,list(String, Map)
-
stream
@GenerateBridge public static <T extends PanacheMongoEntityBase> Stream<T> stream(String query, Sort sort, Map<String,Object> params)
Find entities matching a query and the given sort options, with named parameters. This method is a shortcut forfind(query, sort, params).stream()
.- Parameters:
query
- aquery string
sort
- the sort strategy to useparams
-Map
of indexed parameters- Returns:
- a
Stream
containing all results, without paging - See Also:
stream(String, Map)
,stream(String, Sort, Object...)
,stream(String, Sort, Parameters)
,find(String, Sort, Map)
,list(String, Sort, Map)
-
stream
@GenerateBridge public static <T extends PanacheMongoEntityBase> Stream<T> stream(String query, Parameters params)
Find entities matching a query, with named parameters. This method is a shortcut forfind(query, params).stream()
.- Parameters:
query
- aquery string
params
-Parameters
of named parameters- Returns:
- a
Stream
containing all results, without paging - See Also:
stream(String, Sort, Parameters)
,stream(String, Object...)
,stream(String, Map)
,find(String, Parameters)
,list(String, Parameters)
-
stream
@GenerateBridge public static <T extends PanacheMongoEntityBase> Stream<T> stream(String query, Sort sort, Parameters params)
Find entities matching a query and the given sort options, with named parameters. This method is a shortcut forfind(query, sort, params).stream()
.- Parameters:
query
- aquery string
sort
- the sort strategy to useparams
-Parameters
of indexed parameters- Returns:
- a
Stream
containing all results, without paging - See Also:
stream(String, Parameters)
,stream(String, Sort, Object...)
,stream(String, Sort, Map)
,find(String, Sort, Parameters)
,list(String, Sort, Parameters)
-
stream
@GenerateBridge public static <T extends PanacheMongoEntityBase> Stream<T> stream(org.bson.Document query)
Find entities using a BSON query. This method is a shortcut forfind(query).stream()
.- Parameters:
query
- aDocument
query- Returns:
- a
Stream
containing all results, without paging - See Also:
find(Document)
,find(Document, Document)
,list(Document)
,list(Document, Document)
,stream(Document, Document)
-
stream
@GenerateBridge public static <T extends PanacheMongoEntityBase> Stream<T> stream(org.bson.Document query, org.bson.Document sort)
Find entities using a BSON query and a BSON sort. This method is a shortcut forfind(query, sort).stream()
.- Parameters:
query
- aDocument
querysort
- theDocument
sort- Returns:
- a
Stream
containing all results, without paging - See Also:
find(Document)
,find(Document, Document)
,list(Document)
,list(Document, Document)
,stream(Document, Document)
-
streamAll
@GenerateBridge public static <T extends PanacheMongoEntityBase> Stream<T> streamAll()
Find all entities of this type. This method is a shortcut forfindAll().stream()
.- Returns:
- a
Stream
containing all results, without paging - See Also:
streamAll(Sort)
,findAll()
,listAll()
-
streamAll
@GenerateBridge public static <T extends PanacheMongoEntityBase> Stream<T> streamAll(Sort sort)
Find all entities of this type, in the given order. This method is a shortcut forfindAll(sort).stream()
.- Parameters:
sort
- the sort order to use- Returns:
- a
Stream
containing all results, without paging - See Also:
streamAll()
,findAll(Sort)
,listAll(Sort)
-
count
@GenerateBridge public static long count()
Counts the number of this type of entity in the database.- Returns:
- the number of this type of entity in the database.
- See Also:
count(String, Object...)
,count(String, Map)
,count(String, Parameters)
-
count
@GenerateBridge public static long count(String query, Object... params)
Counts the number of this type of entity matching the given query, with optional indexed parameters.- Parameters:
query
- aquery string
params
- optional sequence of indexed parameters- Returns:
- the number of entities counted.
- See Also:
count()
,count(String, Map)
,count(String, Parameters)
-
count
@GenerateBridge public static long count(String query, Map<String,Object> params)
Counts the number of this type of entity matching the given query, with named parameters.- Parameters:
query
- aquery string
params
-Map
of named parameters- Returns:
- the number of entities counted.
- See Also:
count()
,count(String, Object...)
,count(String, Parameters)
-
count
@GenerateBridge public static long count(String query, Parameters params)
Counts the number of this type of entity matching the given query, with named parameters.- Parameters:
query
- aquery string
params
-Parameters
of named parameters- Returns:
- the number of entities counted.
- See Also:
count()
,count(String, Object...)
,count(String, Map)
-
count
@GenerateBridge public static long count(org.bson.Document query)
Counts the number of this type of entity matching the given query- Parameters:
query
- aDocument
query- Returns:
- he number of entities counted.
- See Also:
count()
,count(String, Object...)
,count(String, Map)
-
deleteAll
@GenerateBridge public static long deleteAll()
Delete all entities of this type from the database.- Returns:
- the number of entities deleted.
- See Also:
delete(String, Object...)
,delete(String, Map)
,delete(String, Parameters)
-
deleteById
@GenerateBridge public static boolean deleteById(Object id)
Delete an entity of this type by ID.- Parameters:
id
- the ID of the entity to delete.- Returns:
- false if the entity was not deleted (not found).
-
delete
@GenerateBridge public static long delete(String query, Object... params)
Delete all entities of this type matching the given query, with optional indexed parameters.- Parameters:
query
- aquery string
params
- optional sequence of indexed parameters- Returns:
- the number of entities deleted.
- See Also:
deleteAll()
,delete(String, Map)
,delete(String, Parameters)
-
delete
@GenerateBridge public static long delete(String query, Map<String,Object> params)
Delete all entities of this type matching the given query, with named parameters.- Parameters:
query
- aquery string
params
-Map
of named parameters- Returns:
- the number of entities deleted.
- See Also:
deleteAll()
,delete(String, Object...)
,delete(String, Parameters)
-
delete
@GenerateBridge public static long delete(String query, Parameters params)
Delete all entities of this type matching the given query, with named parameters.- Parameters:
query
- aquery string
params
-Parameters
of named parameters- Returns:
- the number of entities deleted.
- See Also:
deleteAll()
,delete(String, Object...)
,delete(String, Map)
-
delete
@GenerateBridge public static long delete(org.bson.Document query)
Delete all entities of this type matching the given query- Parameters:
query
- aDocument
query- Returns:
- he number of entities counted.
- See Also:
count()
,count(String, Object...)
,count(String, Map)
-
persist
@GenerateBridge(callSuperMethod=true) public static void persist(Iterable<?> entities)
Insert all given entities.- Parameters:
entities
- the entities to insert- See Also:
persist()
,persist(Stream)
,persist(Object,Object...)
-
persist
@GenerateBridge(callSuperMethod=true) public static void persist(Stream<?> entities)
Insert all given entities.- Parameters:
entities
- the entities to insert- See Also:
persist()
,persist(Iterable)
,persist(Object,Object...)
-
persist
@GenerateBridge(callSuperMethod=true) public static void persist(Object firstEntity, Object... entities)
Insert all given entities.- Parameters:
entities
- the entities to insert- See Also:
persist()
,persist(Stream)
,persist(Iterable)
-
update
@GenerateBridge(callSuperMethod=true) public static void update(Iterable<?> entities)
Update all given entities.- Parameters:
entities
- the entities to update- See Also:
update()
,update(Stream)
,update(Object,Object...)
-
update
@GenerateBridge(callSuperMethod=true) public static void update(Stream<?> entities)
Update all given entities.- Parameters:
entities
- the entities to insert- See Also:
update()
,update(Iterable)
,update(Object,Object...)
-
update
@GenerateBridge(callSuperMethod=true) public static void update(Object firstEntity, Object... entities)
Update all given entities.- Parameters:
entities
- the entities to update- See Also:
update()
,update(Stream)
,update(Iterable)
-
persistOrUpdate
@GenerateBridge(callSuperMethod=true) public static void persistOrUpdate(Iterable<?> entities)
Persist all given entities or update them if they already exist.- Parameters:
entities
- the entities to update- See Also:
persistOrUpdate()
,persistOrUpdate(Stream)
,persistOrUpdate(Object,Object...)
-
persistOrUpdate
@GenerateBridge(callSuperMethod=true) public static void persistOrUpdate(Stream<?> entities)
Persist all given entities.- Parameters:
entities
- the entities to insert- See Also:
persistOrUpdate()
,persistOrUpdate(Iterable)
,persistOrUpdate(Object,Object...)
-
persistOrUpdate
@GenerateBridge(callSuperMethod=true) public static void persistOrUpdate(Object firstEntity, Object... entities)
Persist all given entities.- Parameters:
entities
- the entities to update- See Also:
persistOrUpdate()
,persistOrUpdate(Stream)
,persistOrUpdate(Iterable)
-
update
@GenerateBridge public static PanacheUpdate update(String update, Object... params)
Update all entities of this type by the given update document, with optional indexed parameters. The returnedPanacheUpdate
object will allow to restrict on which document the update should be applied.- Parameters:
update
- the update document, if it didn't contain any update operator, we add$set
.. It can also be expressed as aquery string
.params
- optional sequence of indexed parameters- Returns:
- a new
PanacheUpdate
instance for the given update document - See Also:
update(String, Map)
,update(String, Parameters)
,update(Document)
-
update
@GenerateBridge public static PanacheUpdate update(String update, Map<String,Object> params)
Update all entities of this type by the given update document, with named parameters. The returnedPanacheUpdate
object will allow to restrict on which document the update should be applied.- Parameters:
update
- the update document, if it didn't contain any update operator, we add$set
. It can also be expressed as aquery string
.params
-Map
of named parameters- Returns:
- a new
PanacheUpdate
instance for the given update document - See Also:
update(String, Object...)
,update(String, Parameters)
,update(Document)
-
update
@GenerateBridge public static PanacheUpdate update(String update, Parameters params)
Update all entities of this type by the given update document, with named parameters. The returnedPanacheUpdate
object will allow to restrict on which document the update should be applied.- Parameters:
update
- the update document, if it didn't contain any update operator, we add$set
. It can also be expressed as aquery string
.params
-Parameters
of named parameters- Returns:
- a new
PanacheUpdate
instance for the given update document - See Also:
update(String, Object...)
,update(String, Map)
,update(Document)
-
update
@GenerateBridge public static PanacheUpdate update(org.bson.Document update)
Update all entities of this type by the given update BSON document. The returnedPanacheUpdate
object will allow to restrict on which document the update should be applied.- Parameters:
update
- the update document, as aDocument
.- Returns:
- a new
PanacheUpdate
instance for the given update document - See Also:
update(String, Object...)
,update(String, Map)
,update(String, Parameters)
-
mongoCollection
@GenerateBridge public static <T extends PanacheMongoEntityBase> com.mongodb.client.MongoCollection<T> mongoCollection()
Allow to access the underlying Mongo Collection.
-
mongoDatabase
@GenerateBridge public static com.mongodb.client.MongoDatabase mongoDatabase()
Allow to access the underlying Mongo Database.
-
-