Package io.quarkus.hibernate.panache

Interface PanacheRepositoryQueries<Entity,EntityList,Query extends PanacheQuery<?,?,?,?>,Count,Confirmation,Id>

All Known Subinterfaces:

PanacheManagedBlockingRepository<Entity>, PanacheManagedBlockingRepositoryBase<Entity,Id>, PanacheManagedBlockingRepositoryQueries<Entity,Id>, PanacheManagedReactiveRepository<Entity>, PanacheManagedReactiveRepositoryBase<Entity,Id>, PanacheManagedReactiveRepositoryQueries<Entity,Id>, PanacheRepository<Entity>, PanacheRepository.Managed<Entity,Id>, PanacheRepository.Reactive<Entity,Id>, PanacheRepository.Reactive.Stateless<Entity,Id>, PanacheRepository.Stateless<Entity,Id>, PanacheRepositoryBlockingQueries<Entity,Id>, PanacheRepositoryReactiveQueries<Entity,Id>, PanacheStatelessBlockingRepository<Entity>, PanacheStatelessBlockingRepositoryBase<Entity,Id>, PanacheStatelessBlockingRepositoryQueries<Entity,Id>, PanacheStatelessReactiveRepository<Entity>, PanacheStatelessReactiveRepositoryBase<Entity,Id>, PanacheStatelessReactiveRepositoryQueries<Entity,Id>

public interface PanacheRepositoryQueries<Entity,EntityList,Query extends PanacheQuery<?,?,?,?>,Count,Confirmation,Id>

Method Summary

Modifier and Type	Method	Description
Count	count()	Counts the number of this type of entity in the database.
Count	count(String query, Object... params)	Counts the number of this type of entity matching the given query, with optional indexed parameters.
Count	count(String query, Map<String,Object> params)	Counts the number of this type of entity matching the given query, with named parameters.
Count	delete(String query, Object... params)	Delete all entities of this type matching the given query, with optional indexed parameters.
Count	delete(String query, Map<String,Object> params)	Delete all entities of this type matching the given query, with named parameters.
Count	deleteAll()	Delete all entities of this type from the database.
Confirmation	deleteById(Id id)	Delete an entity of this type by ID.
Query	find(String query, io.quarkus.panache.common.Sort sort, Object... params)	Find entities using a query and the given sort options, with optional indexed parameters.
Query	find(String query, io.quarkus.panache.common.Sort sort, Map<String,Object> params)	Find entities using a query and the given sort options, with named parameters.
Query	find(String query, Object... params)	Find entities using a query, with optional indexed parameters.
Query	find(String query, Map<String,Object> params)	Find entities using a query, with named parameters.
Query	findAll()	Find all entities of this type.
Query	findAll(io.quarkus.panache.common.Sort sort)	Find all entities of this type, in the given order.
Entity	findById(Id id)	Find an entity of this type by ID.
Entity	findById(Id id, jakarta.persistence.LockModeType lockModeType)	Find an entity of this type by ID and lock it.
EntityList	list(String query, io.quarkus.panache.common.Sort sort, Object... params)	Find entities matching a query and the given sort options, with optional indexed parameters.
EntityList	list(String query, io.quarkus.panache.common.Sort sort, Map<String,Object> params)	Find entities matching a query and the given sort options, with named parameters.
EntityList	list(String query, Object... params)	Find entities matching a query, with optional indexed parameters.
EntityList	list(String query, Map<String,Object> params)	Find entities matching a query, with named parameters.
EntityList	listAll()	Find all entities of this type.
EntityList	listAll(io.quarkus.panache.common.Sort sort)	Find all entities of this type, in the given order.
Count	update(String query, Object... params)	Update all entities of this type matching the given query, with optional indexed parameters.
Count	update(String query, Map<String,Object> params)	Update all entities of this type matching the given query, with named parameters.

Method Details

findById

Entity findById(Id 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.

findById

Entity findById(Id id,
 jakarta.persistence.LockModeType lockModeType)

Find an entity of this type by ID and lock it.

Parameters:

id - the ID of the entity to find.

lockModeType - the locking strategy to be used when retrieving the entity.

Returns:

the entity found, or null if not found.

find

Query find(String query,
 Object... params)

Find entities using a query, with optional indexed parameters.

Parameters:

query - a query 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)
• invalid reference

  #find(String, Parameters)

• list(String, Object...)
• invalid reference

  #stream(String, Object...)

find

Query find(String query,
 io.quarkus.panache.common.Sort sort,
 Object... params)

Find entities using a query and the given sort options, with optional indexed parameters.

Parameters:

query - a query string

sort - the sort strategy to use

params - optional sequence of indexed parameters

Returns:

a new PanacheQuery instance for the given query

See Also:

• find(String, Object...)
• find(String, Sort, Map)
• invalid reference

  #find(String, Sort, Parameters)

• list(String, Sort, Object...)
• invalid reference

  #stream(String, Sort, Object...)

find

Query find(String query,
 Map<String,Object> params)

Find entities using a query, with named parameters.

Parameters:

query - a query string

params - Map of named parameters

Returns:

a new PanacheQuery instance for the given query

See Also:

• find(String, Sort, Map)
• find(String, Object...)
• invalid reference

  #find(String, Parameters)

• list(String, Map)
• invalid reference

  #stream(String, Map)

find

Query find(String query,
 io.quarkus.panache.common.Sort sort,
 Map<String,Object> params)

Find entities using a query and the given sort options, with named parameters.

Parameters:

query - a query string

sort - the sort strategy to use

params - Map of indexed parameters

Returns:

a new PanacheQuery instance for the given query

See Also:

• find(String, Map)
• find(String, Sort, Object...)
• invalid reference

  #find(String, Sort, Parameters)

• list(String, Sort, Map)
• invalid reference

  #stream(String, Sort, Map)

findAll

Query findAll()

Find all entities of this type.

Returns:

a new PanacheQuery instance to find all entities of this type.

See Also:

• findAll(Sort)
• listAll()
• invalid reference

  #streamAll()

findAll

Query findAll(io.quarkus.panache.common.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)
• invalid reference

  #streamAll(Sort)

list

EntityList list(String query,
 Object... params)

Find entities matching a query, with optional indexed parameters. This method is a shortcut for find(query, params).list().

Parameters:

query - a query string

params - optional sequence of indexed parameters

Returns:

a

invalid reference

List

containing all results, without paging

See Also:

• list(String, Sort, Object...)
• list(String, Map)
• invalid reference

  #list(String, Parameters)

• find(String, Object...)
• invalid reference

  #stream(String, Object...)

list

EntityList list(String query,
 io.quarkus.panache.common.Sort sort,
 Object... params)

Find entities matching a query and the given sort options, with optional indexed parameters. This method is a shortcut for find(query, sort, params).list().

Parameters:

query - a query string

sort - the sort strategy to use

params - optional sequence of indexed parameters

Returns:

a

invalid reference

List

containing all results, without paging

See Also:

• list(String, Object...)
• list(String, Sort, Map)
• invalid reference

  #list(String, Sort, Parameters)

• find(String, Sort, Object...)
• invalid reference

  #stream(String, Sort, Object...)

list

EntityList list(String query,
 Map<String,Object> params)

Find entities matching a query, with named parameters. This method is a shortcut for find(query, params).list().

Parameters:

query - a query string

params - Map of named parameters

Returns:

a

invalid reference

List

containing all results, without paging

See Also:

• list(String, Sort, Map)
• list(String, Object...)
• invalid reference

  #list(String, Parameters)

• find(String, Map)
• invalid reference

  #stream(String, Map)

list

EntityList list(String query,
 io.quarkus.panache.common.Sort sort,
 Map<String,Object> params)

Find entities matching a query and the given sort options, with named parameters. This method is a shortcut for find(query, sort, params).list().

Parameters:

query - a query string

sort - the sort strategy to use

params - Map of indexed parameters

Returns:

a

invalid reference

List

containing all results, without paging

See Also:

• list(String, Map)
• list(String, Sort, Object...)
• invalid reference

  #list(String, Sort, Parameters)

• find(String, Sort, Map)
• invalid reference

  #stream(String, Sort, Map)

listAll

EntityList listAll()

Find all entities of this type. This method is a shortcut for findAll().list().

Returns:

a

invalid reference

List

containing all results, without paging

See Also:

• listAll(Sort)
• findAll()
• invalid reference

  #streamAll()

listAll

EntityList listAll(io.quarkus.panache.common.Sort sort)

Find all entities of this type, in the given order. This method is a shortcut for findAll(sort).list().

Parameters:

sort - the sort order to use

Returns:

a

invalid reference

List

containing all results, without paging

See Also:

• listAll()
• findAll(Sort)
• invalid reference

  #streamAll(Sort)

count

Count 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)
• invalid reference

  #count(String, Parameters)

count

Count count(String query,
 Object... params)

Counts the number of this type of entity matching the given query, with optional indexed parameters.

Parameters:

query - a query string

params - optional sequence of indexed parameters

Returns:

the number of entities counted.

See Also:

• count()
• count(String, Map)
• invalid reference

  #count(String, Parameters)

count

Count count(String query,
 Map<String,Object> params)

Counts the number of this type of entity matching the given query, with named parameters.

Parameters:

query - a query string

params - Map of named parameters

Returns:

the number of entities counted.

See Also:

• count()
• count(String, Object...)
• invalid reference

  #count(String, Parameters)

deleteAll

Count deleteAll()

Delete all entities of this type from the database. WARNING: the default implementation of this method uses a bulk delete query and ignores cascading rules from the JPA model.

Returns:

the number of entities deleted.

See Also:

• delete(String, Object...)
• delete(String, Map)
• invalid reference

  #delete(String, Parameters)

deleteById

Confirmation deleteById(Id 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

Count delete(String query,
 Object... params)

Delete all entities of this type matching the given query, with optional indexed parameters. WARNING: the default implementation of this method uses a bulk delete query and ignores cascading rules from the JPA model.

Parameters:

query - a query string

params - optional sequence of indexed parameters

Returns:

the number of entities deleted.

See Also:

• deleteAll()
• delete(String, Map)
• invalid reference

  #delete(String, Parameters)

delete

Count delete(String query,
 Map<String,Object> params)

Delete all entities of this type matching the given query, with named parameters. WARNING: the default implementation of this method uses a bulk delete query and ignores cascading rules from the JPA model.

Parameters:

query - a query string

params - Map of named parameters

Returns:

the number of entities deleted.

See Also:

• deleteAll()
• delete(String, Object...)
• invalid reference

  #delete(String, Parameters)

update

Count update(String query,
 Object... params)

Update all entities of this type matching the given query, with optional indexed parameters.

Parameters:

query - a query string

params - optional sequence of indexed parameters

Returns:

the number of entities updated.

See Also:

• update(String, Map)
• invalid reference

  #update(String, Parameters)

update

Count update(String query,
 Map<String,Object> params)

Update all entities of this type matching the given query, with named parameters.

Parameters:

query - a query string

params - Map of named parameters

Returns:

the number of entities updated.

See Also:

• update(String, Object...)
• invalid reference

  #update(String, Parameters)