Package io.quarkus.hibernate.panache.managed.blocking

Interface PanacheManagedBlockingRepositoryQueries<Entity,Id>

All Superinterfaces:

PanacheRepositoryBlockingQueries<Entity,Id>, PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

All Known Subinterfaces:

PanacheManagedBlockingRepository<Entity>, PanacheManagedBlockingRepositoryBase<Entity,Id>, PanacheRepository<Entity>, PanacheRepository.Managed<Entity,Id>

public interface PanacheManagedBlockingRepositoryQueries<Entity,Id>
extends PanacheRepositoryBlockingQueries<Entity,Id>

Method Summary

Modifier and Type	Method	Description
default Long	count()	Counts the number of this type of entity in the database.
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, Map<String,Object> params)	Counts the number of this type of entity 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, Map<String,Object> 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 PanacheBlockingQuery<Entity>	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.
default PanacheBlockingQuery<Entity>	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.
default PanacheBlockingQuery<Entity>	find(String query, Object... params)	Find entities using a query, with optional indexed parameters.
default PanacheBlockingQuery<Entity>	find(String query, Map<String,Object> params)	Find entities using a query, with named parameters.
default PanacheBlockingQuery<Entity>	findAll()	Find all entities of this type.
default PanacheBlockingQuery<Entity>	findAll(io.quarkus.panache.common.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 Entity	findById(Id id, jakarta.persistence.LockModeType lockModeType)	Find an entity of this type by ID and lock it.
default Optional<Entity>	findByIdOptional(Id id)	Find an entity of this type by ID.
default Optional<Entity>	findByIdOptional(Id id, jakarta.persistence.LockModeType lockModeType)	Find an entity of this type by ID.
default List<Entity>	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.
default List<Entity>	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.
default List<Entity>	list(String query, Object... params)	Find entities matching a query, with optional indexed parameters.
default List<Entity>	list(String query, Map<String,Object> params)	Find entities matching a query, with named parameters.
default List<Entity>	listAll()	Find all entities of this type.
default List<Entity>	listAll(io.quarkus.panache.common.Sort sort)	Find all entities of this type, in the given order.
default Stream<Entity>	stream(String query, io.quarkus.panache.common.Sort sort, Object... params)	Find entities matching a query and the given sort options, with optional indexed parameters.
default Stream<Entity>	stream(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.
default Stream<Entity>	stream(String query, Object... params)	Find entities matching a query, with optional indexed parameters.
default Stream<Entity>	stream(String query, Map<String,Object> params)	Find entities matching a query, with named parameters.
default Stream<Entity>	streamAll()	Find all entities of this type, in the given order.
default Stream<Entity>	streamAll(io.quarkus.panache.common.Sort sort)	Find all entities of this type.
default Long	update(String query, Object... params)	Update all entities of this type matching the given query, with optional indexed parameters.
default Long	update(String query, Map<String,Object> params)	Update all entities of this type matching the given query, with named parameters.

Method Details

findById

default Entity findById(Id id)

Description copied from interface: PanacheRepositoryQueries

Find an entity of this type by ID.

Specified by:

findById in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

id - the ID of the entity to find.

Returns:

the entity found, or null if not found.

findById

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

Description copied from interface: PanacheRepositoryQueries

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

Specified by:

findById in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

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.

findByIdOptional

default Optional<Entity> findByIdOptional(Id id)

Description copied from interface: PanacheRepositoryBlockingQueries

Find an entity of this type by ID.

Specified by:

findByIdOptional in interface PanacheRepositoryBlockingQueries<Entity,Id>

Parameters:

id - the ID of the entity to find.

Returns:

if found, an optional containing the entity, else Optional.empty().

findByIdOptional

default Optional<Entity> findByIdOptional(Id id,
 jakarta.persistence.LockModeType lockModeType)

Description copied from interface: PanacheRepositoryBlockingQueries

Find an entity of this type by ID.

Specified by:

findByIdOptional in interface PanacheRepositoryBlockingQueries<Entity,Id>

Parameters:

id - the ID of the entity to find.

Returns:

if found, an optional containing the entity, else Optional.empty().

find

default PanacheBlockingQuery<Entity> find(String query,
 Object... params)

Description copied from interface: PanacheRepositoryQueries

Find entities using a query, with optional indexed parameters.

Specified by:

find in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

query - a query string

params - optional sequence of indexed parameters

Returns:

a new PanacheQuery instance for the given query

See Also:

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

  #find(String, Parameters)

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

  #stream(String, Object...)

find

default PanacheBlockingQuery<Entity> find(String query,
 io.quarkus.panache.common.Sort sort,
 Object... params)

Description copied from interface: PanacheRepositoryQueries

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

Specified by:

find in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

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:

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

  #find(String, Sort, Parameters)

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

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

find

default PanacheBlockingQuery<Entity> find(String query,
 Map<String,Object> params)

Description copied from interface: PanacheRepositoryQueries

Find entities using a query, with named parameters.

Specified by:

find in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

query - a query string

params - Map of named parameters

Returns:

a new PanacheQuery instance for the given query

See Also:

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

  #find(String, Parameters)

• PanacheRepositoryQueries.list(String, Map)
• invalid reference

  #stream(String, Map)

find

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

Description copied from interface: PanacheRepositoryQueries

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

Specified by:

find in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

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:

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

  #find(String, Sort, Parameters)

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

  #stream(String, Sort, Map)

findAll

default PanacheBlockingQuery<Entity> findAll()

Description copied from interface: PanacheRepositoryQueries

Find all entities of this type.

Specified by:

findAll in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Returns:

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

See Also:

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

  #streamAll()

findAll

default PanacheBlockingQuery<Entity> findAll(io.quarkus.panache.common.Sort sort)

Description copied from interface: PanacheRepositoryQueries

Find all entities of this type, in the given order.

Specified by:

findAll in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

sort - the sort order to use

Returns:

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

See Also:

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

  #streamAll(Sort)

list

default List<Entity> list(String query,
 Object... params)

Description copied from interface: PanacheRepositoryQueries

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

Specified by:

list in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

query - a query string

params - optional sequence of indexed parameters

Returns:

a

invalid reference

List

containing all results, without paging

See Also:

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

  #list(String, Parameters)

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

  #stream(String, Object...)

list

default List<Entity> list(String query,
 io.quarkus.panache.common.Sort sort,
 Object... params)

Description copied from interface: PanacheRepositoryQueries

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().

Specified by:

list in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

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:

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

  #list(String, Sort, Parameters)

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

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

list

default List<Entity> list(String query,
 Map<String,Object> params)

Description copied from interface: PanacheRepositoryQueries

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

Specified by:

list in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

query - a query string

params - Map of named parameters

Returns:

a

invalid reference

List

containing all results, without paging

See Also:

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

  #list(String, Parameters)

• PanacheRepositoryQueries.find(String, Map)
• invalid reference

  #stream(String, Map)

list

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

Description copied from interface: PanacheRepositoryQueries

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

Specified by:

list in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

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:

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

  #list(String, Sort, Parameters)

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

  #stream(String, Sort, Map)

listAll

default List<Entity> listAll()

Description copied from interface: PanacheRepositoryQueries

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

Specified by:

listAll in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Returns:

a

invalid reference

List

containing all results, without paging

See Also:

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

  #streamAll()

listAll

default List<Entity> listAll(io.quarkus.panache.common.Sort sort)

Description copied from interface: PanacheRepositoryQueries

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

Specified by:

listAll in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

sort - the sort order to use

Returns:

a

invalid reference

List

containing all results, without paging

See Also:

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

  #streamAll(Sort)

stream

default Stream<Entity> stream(String query,
 Object... params)

Description copied from interface: PanacheRepositoryBlockingQueries

Find entities matching a query, with optional indexed parameters. This method is a shortcut for find(query, params).stream(). It requires a transaction to work. Without a transaction, the underlying cursor can be closed before the end of the stream.

Specified by:

stream in interface PanacheRepositoryBlockingQueries<Entity,Id>

Parameters:

query - a query string

params - optional sequence of indexed parameters

Returns:

a Stream containing all results, without paging

See Also:

• PanacheRepositoryBlockingQueries.stream(String, Sort, Object...)
• PanacheRepositoryBlockingQueries.stream(String, Map)
• invalid reference

  #stream(String, Parameters)

• PanacheRepositoryQueries.find(String, Object...)
• PanacheRepositoryQueries.list(String, Object...)

stream

default Stream<Entity> stream(String query,
 io.quarkus.panache.common.Sort sort,
 Object... params)

Description copied from interface: PanacheRepositoryBlockingQueries

Find entities matching a query and the given sort options, with optional indexed parameters. This method is a shortcut for find(query, sort, params).stream(). It requires a transaction to work. Without a transaction, the underlying cursor can be closed before the end of the stream.

Specified by:

stream in interface PanacheRepositoryBlockingQueries<Entity,Id>

Parameters:

query - a query string

sort - the sort strategy to use

params - optional sequence of indexed parameters

Returns:

a Stream containing all results, without paging

See Also:

• PanacheRepositoryBlockingQueries.stream(String, Object...)
• PanacheRepositoryBlockingQueries.stream(String, Sort, Map)
• invalid reference

  #stream(String, Sort, Parameters)

• PanacheRepositoryQueries.find(String, Sort, Object...)
• PanacheRepositoryQueries.list(String, Sort, Object...)

stream

default Stream<Entity> stream(String query,
 Map<String,Object> params)

Description copied from interface: PanacheRepositoryBlockingQueries

Find entities matching a query, with named parameters. This method is a shortcut for find(query, params).stream(). It requires a transaction to work. Without a transaction, the underlying cursor can be closed before the end of the stream.

Specified by:

stream in interface PanacheRepositoryBlockingQueries<Entity,Id>

Parameters:

query - a query string

params - Map of named parameters

Returns:

a Stream containing all results, without paging

See Also:

• PanacheRepositoryBlockingQueries.stream(String, Sort, Map)
• PanacheRepositoryBlockingQueries.stream(String, Object...)
• invalid reference

  #stream(String, Parameters)

• PanacheRepositoryQueries.find(String, Map)
• PanacheRepositoryQueries.list(String, Map)

stream

default Stream<Entity> stream(String query,
 io.quarkus.panache.common.Sort sort,
 Map<String,Object> params)

Description copied from interface: PanacheRepositoryBlockingQueries

Find entities matching a query and the given sort options, with named parameters. This method is a shortcut for find(query, sort, params).stream(). It requires a transaction to work. Without a transaction, the underlying cursor can be closed before the end of the stream.

Specified by:

stream in interface PanacheRepositoryBlockingQueries<Entity,Id>

Parameters:

query - a query string

sort - the sort strategy to use

params - Map of indexed parameters

Returns:

a Stream containing all results, without paging

See Also:

• PanacheRepositoryBlockingQueries.stream(String, Map)
• PanacheRepositoryBlockingQueries.stream(String, Sort, Object...)
• invalid reference

  #stream(String, Sort, Parameters)

• PanacheRepositoryQueries.find(String, Sort, Map)
• PanacheRepositoryQueries.list(String, Sort, Map)

streamAll

default Stream<Entity> streamAll(io.quarkus.panache.common.Sort sort)

Description copied from interface: PanacheRepositoryBlockingQueries

Find all entities of this type. This method is a shortcut for findAll().stream(). It requires a transaction to work. Without a transaction, the underlying cursor can be closed before the end of the stream.

Specified by:

streamAll in interface PanacheRepositoryBlockingQueries<Entity,Id>

Returns:

a Stream containing all results, without paging

See Also:

• PanacheRepositoryBlockingQueries.streamAll(Sort)
• PanacheRepositoryQueries.findAll()
• PanacheRepositoryQueries.listAll()

streamAll

default Stream<Entity> streamAll()

Description copied from interface: PanacheRepositoryBlockingQueries

Find all entities of this type, in the given order. This method is a shortcut for findAll().stream(). It requires a transaction to work. Without a transaction, the underlying cursor can be closed before the end of the stream.

Specified by:

streamAll in interface PanacheRepositoryBlockingQueries<Entity,Id>

Returns:

a Stream containing all results, without paging

See Also:

• PanacheRepositoryBlockingQueries.streamAll()
• PanacheRepositoryQueries.findAll(Sort)
• PanacheRepositoryQueries.listAll(Sort)

count

default Long count()

Description copied from interface: PanacheRepositoryQueries

Counts the number of this type of entity in the database.

Specified by:

count in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Returns:

the number of this type of entity in the database.

See Also:

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

  #count(String, Parameters)

count

default Long count(String query,
 Object... params)

Description copied from interface: PanacheRepositoryQueries

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

Specified by:

count in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

query - a query string

params - optional sequence of indexed parameters

Returns:

the number of entities counted.

See Also:

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

  #count(String, Parameters)

count

default Long count(String query,
 Map<String,Object> params)

Description copied from interface: PanacheRepositoryQueries

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

Specified by:

count in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

query - a query string

params - Map of named parameters

Returns:

the number of entities counted.

See Also:

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

  #count(String, Parameters)

deleteAll

default Long deleteAll()

Description copied from interface: PanacheRepositoryQueries

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.

Specified by:

deleteAll in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Returns:

the number of entities deleted.

See Also:

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

  #delete(String, Parameters)

deleteById

default Boolean deleteById(Id id)

Description copied from interface: PanacheRepositoryQueries

Delete an entity of this type by ID.

Specified by:

deleteById in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

id - the ID of the entity to delete.

Returns:

false if the entity was not deleted (not found).

delete

default Long delete(String query,
 Object... params)

Description copied from interface: PanacheRepositoryQueries

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.

Specified by:

delete in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

query - a query string

params - optional sequence of indexed parameters

Returns:

the number of entities deleted.

See Also:

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

  #delete(String, Parameters)

delete

default Long delete(String query,
 Map<String,Object> params)

Description copied from interface: PanacheRepositoryQueries

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.

Specified by:

delete in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

query - a query string

params - Map of named parameters

Returns:

the number of entities deleted.

See Also:

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

  #delete(String, Parameters)

update

default Long update(String query,
 Object... params)

Description copied from interface: PanacheRepositoryQueries

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

Specified by:

update in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

query - a query string

params - optional sequence of indexed parameters

Returns:

the number of entities updated.

See Also:

• PanacheRepositoryQueries.update(String, Map)
• invalid reference

  #update(String, Parameters)

update

default Long update(String query,
 Map<String,Object> params)

Description copied from interface: PanacheRepositoryQueries

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

Specified by:

update in interface PanacheRepositoryQueries<Entity,List<Entity>,PanacheBlockingQuery<Entity>,Long,Boolean,Id>

Parameters:

query - a query string

params - Map of named parameters

Returns:

the number of entities updated.

See Also:

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

  #update(String, Parameters)