Deprecated API

Contents

• Interfaces
• Classes
• Methods

Interfaces

Interface	Description
org.hibernate.search.FullTextQuery	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(Session), then create a SearchQuery with SearchSession.search(Class). If you really need an adapter to Hibernate ORM's Query type, convert that SearchQuery using Search.toOrmQuery(SearchQuery), but be aware that only part of the contract is implemented. Refer to the migration guide for more information.
org.hibernate.search.FullTextSession	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(Session). Refer to the migration guide for more information.
org.hibernate.search.FullTextSharedSessionBuilder	Will be removed without replacement, as Hibernate Search sessions (SearchSession) no longer extend JPA's EntityManager interface or Hibernate ORM's Session. To get access to a Hibernate Search 6 session, use Search.session(Session).
org.hibernate.search.jpa.FullTextEntityManager	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager). Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextQuery	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), then create a SearchQuery with SearchSession.search(Class). If you really need an adapter to JPA's Query, convert that SearchQuery using Search.toJpaQuery(SearchQuery), but be aware that only part of the contract is implemented. Refer to the migration guide for more information.
org.hibernate.search.MassIndexer	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(Session), then create a mass indexer with SearchSession.massIndexer(Class[]). Refer to the migration guide for more information.
org.hibernate.search.SearchFactory	Instead of using Hibernate Search 5 APIs, get a SearchMapping using Search.mapping(javax.persistence.EntityManagerFactory), or Search.mapping(SessionFactory). See the individual methods for the replacement of each method. Refer to the migration guide for more information.

Classes

Class	Description
org.hibernate.search.jpa.Search	Use Search instead.
org.hibernate.search.Search	Use Search instead.

Methods

Method	Description
org.hibernate.search.FullTextQuery.setFetchSize(int)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), and define your loading options using SearchQueryOptionsStep.loading(Consumer). To set the equivalent to FullTextQuery.setFetchSize(int) in Hibernate Search 6, use SearchLoadingOptionsStep.fetchSize(int). Refer to the migration guide for more information.
org.hibernate.search.FullTextQuery.setResultTransformer(ResultTransformer)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(Session), create a search query with SearchSession.search(Class), and define your projections using SearchQuerySelectStep.select(Function). See in particular the composite projection, which allows applying a function to another projection: SearchProjectionFactory.composite(Function, ProjectionFinalStep). Refer to the migration guide for more information.
org.hibernate.search.FullTextSharedSessionBuilder.autoClose(boolean)
org.hibernate.search.FullTextSharedSessionBuilder.connectionReleaseMode()
org.hibernate.search.FullTextSharedSessionBuilder.flushBeforeCompletion()
org.hibernate.search.FullTextSharedSessionBuilder.transactionContext()
org.hibernate.search.jpa.FullTextEntityManager.createFullTextQuery(Query, Class<?>...)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), then create a SearchQuery with SearchSession.search(Class). If you really need an adapter to Hibernate ORM's Query type, convert that SearchQuery using Search.toOrmQuery(SearchQuery), but be aware that only part of the contract is implemented. Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextEntityManager.createIndexer(Class<?>...)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(Session), then create a mass indexer with SearchSession.massIndexer(Class[]). Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextEntityManager.flushToIndexes()	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), then get the indexing plan for that session using SearchSession.indexingPlan(), then force the immediate execution of indexing operations using SearchIndexingPlan.execute().
org.hibernate.search.jpa.FullTextEntityManager.getSearchFactory()	See the deprecation note on SearchFactory.
org.hibernate.search.jpa.FullTextEntityManager.index(T)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), then get the indexing plan for that session using SearchSession.indexingPlan(), then add/update/remove entities to/from the index using SearchIndexingPlan.addOrUpdate(Object), SearchIndexingPlan.delete(Object), or SearchIndexingPlan.purge(Class, Object, String).
org.hibernate.search.jpa.FullTextEntityManager.purge(Class<T>, Serializable)	To purge all instances of a given type, see the deprecation note on FullTextEntityManager.purgeAll(Class). To purge a specific instance, instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), then get the indexing plan for that session using SearchSession.indexingPlan(), then add/update/remove entities to/from the index using SearchIndexingPlan.addOrUpdate(Object), SearchIndexingPlan.delete(Object), or SearchIndexingPlan.purge(Class, Object, String).
org.hibernate.search.jpa.FullTextEntityManager.purgeAll(Class<T>)	Instead of using Hibernate Search 5 APIs, get a SearchScope using SearchSession.scope(Class) or SearchMapping.scope(Class), then a SearchWorkspace using SearchScope.workspace(), then call SearchWorkspace.purge() to purge all indexes in scope.
org.hibernate.search.jpa.FullTextQuery.explain(Object)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), convert it to a LuceneSearchQuery by passing LuceneExtension.get() to SearchQuery.extension(SearchQueryExtension), and get the explanation using LuceneSearchQuery.explain(Object). Note the explain methods now expect an entity ID, not the internal Lucene docId. Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextQuery.getFacetManager()	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), and define your facets (now called aggregations) using SearchQueryOptionsStep.aggregation(AggregationKey, Function). You can then fetch the query result using SearchFetchable.fetch(Integer) and get each aggregation using SearchResult.aggregation(AggregationKey). Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextQuery.getResultSize()	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), and get the total hit count ("result size") using SearchFetchable.fetchTotalHitCount(). Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextQuery.hasPartialResults()	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), set a "truncation" timeout using SearchQueryOptionsStep.truncateAfter(long, TimeUnit), and get the SearchResult with SearchFetchable.fetch(Integer). You'll be able to check whether the result is partial or not using SearchResult.timedOut(). Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextQuery.initializeObjectsWith(ObjectLookupMethod, DatabaseRetrievalMethod)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), and define your loading options using SearchQueryOptionsStep.loading(Consumer). To set the equivalent to ObjectLookupMethod in Hibernate Search 6, use SearchLoadingOptionsStep.cacheLookupStrategy(EntityLoadingCacheLookupStrategy). Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextQuery.limitExecutionTimeTo(long, TimeUnit)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), set a "truncation" timeout using SearchQueryOptionsStep.truncateAfter(long, TimeUnit), and get the SearchResult with SearchFetchable.fetch(Integer). You'll be able to check whether the result is partial or not using SearchResult.timedOut(). Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextQuery.setFirstResult(int)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), and pass the hit offset ("firstResult") when fetching results using SearchFetchable.fetch(Integer), SearchFetchable.fetch(Integer, Integer), SearchFetchable.fetchHits(Integer) or SearchFetchable.fetch(Integer, Integer).
org.hibernate.search.jpa.FullTextQuery.setMaxResults(int)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), and pass the hit limit ("maxResults") when fetching results using SearchFetchable.fetch(Integer), SearchFetchable.fetch(Integer, Integer), SearchFetchable.fetchHits(Integer) or SearchFetchable.fetch(Integer, Integer).
org.hibernate.search.jpa.FullTextQuery.setProjection(String...)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), and define your projections using SearchQuerySelectStep.select(Function). Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextQuery.setResultTransformer(ResultTransformer)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), and define your projections using SearchQuerySelectStep.select(Function). See in particular the composite projection, which allows applying a function to another projection: SearchProjectionFactory.composite(Function, ProjectionFinalStep). Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextQuery.setSort(Sort)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), and define your sorts using SearchQueryOptionsStep.sort(Function). Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextQuery.setSpatialParameters(double, double, String)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), and define your projections using SearchQuerySelectStep.select(Function). See in particular the distance projection: SearchProjectionFactory.distance(String, GeoPoint). Refer to the migration guide for more information.
org.hibernate.search.jpa.FullTextQuery.setTimeout(long, TimeUnit)	Instead of using Hibernate Search 5 APIs, get a SearchSession using Search.session(EntityManager), create a search query with SearchSession.search(Class), and set a "failure" timeout using SearchQueryOptionsStep.failAfter(long, TimeUnit). Refer to the migration guide for more information.
org.hibernate.search.jpa.Search.getFullTextEntityManager(EntityManager)	Use Search.session(EntityManager) instead.
org.hibernate.search.MassIndexer.threadsForSubsequentFetching(int)	Being ignored: this method will be removed.
org.hibernate.search.Search.getFullTextSession(Session)	Use Search.session(Session) instead.
org.hibernate.search.SearchFactory.buildQueryBuilder()	See the deprecation note on QueryBuilder for predicates ("queries") SortContext for sorts, FacetContext for aggregations ("facets").
org.hibernate.search.SearchFactory.getAnalyzer(String)	Instead of using Hibernate Search 5 APIs, get a SearchMapping using Search.mapping(javax.persistence.EntityManagerFactory), or Search.mapping(SessionFactory), then get access to the backend using SearchMapping.backend(), then convert it to a LuceneBackend using Backend.unwrap(Class), then get the analyzer using LuceneBackend.analyzer(String). Refer to the migration guide for more information.
org.hibernate.search.SearchFactory.getIndexedTypes()	Instead of using Hibernate Search 5 APIs, get a SearchMapping using Search.mapping(javax.persistence.EntityManagerFactory), or Search.mapping(SessionFactory), then get access to the entity metadata using SearchMapping.allIndexedEntities().
org.hibernate.search.SearchFactory.optimize()	Instead of using Hibernate Search 5 APIs, get a SearchScope using SearchSession.scope(Class) or SearchMapping.scope(Class), then a SearchWorkspace using SearchScope.workspace(), then call SearchWorkspace.mergeSegments() to "optimize" all indexes in scope.