Package org.hibernate
Interface NaturalIdMultiLoadAccess<T>
- All Known Implementing Classes:
NaturalIdMultiLoadAccessStandard
public interfaceNaturalIdMultiLoadAccess<T>
Loads multiple instances of a given entity type at once, by specifying a list of natural id values. This allows the entities to be fetched from the database in batches.
List<Book> books = session.byMultipleNaturalId(Book.class) .withBatchSize(10) .multiLoad(isbnList);
Composite natural ids may be accommodated by passing a list of maps of typeMap<String,Object> tomultiLoad(java.lang.Object...). Each map must contain the natural id attribute values keyed by@NaturalId attribute name.
var compositeNaturalId = Map.of(Book_.ISBN, isbn, Book_.PRINTING, printing);
Method Summary
Modifier and TypeMethodDescriptionenableOrderedReturn(boolean enabled) Should the returned list of entity instances be ordered, with the position of an entity instance determined by the position of its identifier in the list if ids passed tomultiLoad(java.lang.Object...)?enableReturnOfDeletedEntities(boolean enabled) ShouldmultiLoad(java.lang.Object...)return entity instances that have beenmarked for removalin the current session, but not yet deleted in the database?Retrieve the entities with the given natural id values.Retrieve the entities with the given natural id values.defaultNaturalIdMultiLoadAccess<T>with(EntityGraph<T> graph) Deprecated.with(EntityGraph<T> graph,GraphSemantic semantic) Customize the associations fetched by specifying anentity graph, and how it should beinterpreted.Specify thetimeout to use when querying the database.Specify theCacheModeto use when obtaining an entity.defaultNaturalIdMultiLoadAccess<T>Specify thelock mode to use when querying the database.with(LockMode lockMode,PessimisticLockScope lockScope) Specify thelock mode to use when querying the database.with(LockOptions lockOptions) Deprecated, for removal: This API element is subject to removal in a future version.withBatchSize(int batchSize) Specify a batch size, that is, how many entities should be fetched in each request to the database.defaultNaturalIdMultiLoadAccess<T>withFetchGraph(EntityGraph<T> graph) Override the associations fetched by default by specifying the complete list of associations to be fetched as anentity graph.defaultNaturalIdMultiLoadAccess<T>withLoadGraph(EntityGraph<T> graph) Augment the associations fetched by default by specifying a list of additional associations to be fetched as anentity graph.
Method Details
with
Specify thelock mode to use when querying the database.- Parameters:
lockMode- The lock mode to apply- Returns:
this, for method chaining
with
Specify thelock mode to use when querying the database.- Parameters:
lockMode- The lock mode to apply- Returns:
this, for method chaining
with
Specify thetimeout to use when querying the database.- Parameters:
timeout- The timeout to apply to the database operation- Returns:
this, for method chaining
with
Deprecated, for removal: This API element is subject to removal in a future version.Specify thelock options to use when querying the database.- Parameters:
lockOptions- The lock options to use- Returns:
this, for method chaining
with
Specify theCacheModeto use when obtaining an entity.- Parameters:
cacheMode- TheCacheModeto use- Returns:
this, for method chaining
withFetchGraph
Override the associations fetched by default by specifying the complete list of associations to be fetched as anentity graph.- Since:
- 6.3
withLoadGraph
Augment the associations fetched by default by specifying a list of additional associations to be fetched as anentity graph.- Since:
- 6.3
with
Deprecated.with
Customize the associations fetched by specifying anentity graph, and how it should beinterpreted.withBatchSize
Specify a batch size, that is, how many entities should be fetched in each request to the database.- By default, the batch sizing strategy is determined by theSQL dialect, but
- if some
batchSize>1is specified as an argument to this method, then that batch size will be used.
If an explicit batch size is set manually, care should be taken to not exceed the capabilities of the underlying database.
A batch size is considered a hint.
- Parameters:
batchSize- The batch size- Returns:
this, for method chaining
enableReturnOfDeletedEntities
ShouldmultiLoad(java.lang.Object...)return entity instances that have beenmarked for removalin the current session, but not yet deleted in the database?By default, instances marked for removal are replaced by null in the returned list of entities when
enableOrderedReturn(boolean)is used.- Parameters:
enabled-trueif removed entities should be returned;falseif they should be replaced by null values.- Returns:
this, for method chaining
enableOrderedReturn
Should the returned list of entity instances be ordered, with the position of an entity instance determined by the position of its identifier in the list if ids passed tomultiLoad(java.lang.Object...)?By default, the returned list is ordered and the positions of the entities correspond to the positions of their ids. In this case, thehandling of entities marked for removal becomes important.
- Parameters:
enabled-trueif entity instances should be ordered;falseif they may be returned in any order.- Returns:
this, for method chaining
multiLoad
Retrieve the entities with the given natural id values.Note that the options
enableReturnOfDeletedEntities(boolean)andenableOrderedReturn(boolean)affect the size and shape of the returned list of entity instances.- Parameters:
ids- The natural id values to load- Returns:
- The managed entities.
multiLoad
Retrieve the entities with the given natural id values.Note that the options
enableReturnOfDeletedEntities(boolean)andenableOrderedReturn(boolean)affect the size and shape of the returned list of entity instances.- Parameters:
ids- The natural id values to load- Returns:
- The managed entities.