Document in the migration guide that sort by Long @Id doesn't work anymore

Description

I recently upgraded from 5.3.0.Final to 5.6.0.Alpha3, following the migration guide.

As soon as I did I noticed that sorting HS queries by "id" field (id is the name of the property that I have annotated with @Id) simply fails silently. I.e., no exception is thrown, but results are not sorted by id. This property is of type Long, which means that the Lucene field is of type NUMERIC.

I then saw the following warning emitted by Hibernate whenever I run my query:

HSEARCH000289: Requested sort field(s) id are not configured for entity type com.fivoosh.entities.Applicant mapped to index com.fivoosh.entities.Applicant, thus an uninverting reader must be created. You should declare the missing sort fields using @SortableField.

Ok, I added the @SortableField annotation and reindexed, then tried running the query again. This time I got an exception:

Caused by: java.lang.IllegalStateException: unexpected docvalues type SORTED for field 'id' (expected=NUMERIC). Use UninvertingReader or index with docvalues. at org.apache.lucene.index.DocValues.checkField(DocValues.java:208) at org.apache.lucene.index.DocValues.getNumeric(DocValues.java:227) at org.apache.lucene.search.FieldComparator$NumericComparator.getNumericDocValues(FieldComparator.java:167) at org.apache.lucene.search.FieldComparator$NumericComparator.doSetNextReader(FieldComparator.java:153) at org.apache.lucene.search.SimpleFieldComparator.getLeafComparator(SimpleFieldComparator.java:36) at org.apache.lucene.search.FieldValueHitQueue.getComparators(FieldValueHitQueue.java:183) at org.apache.lucene.search.TopFieldCollector$SimpleFieldCollector.getLeafCollector(TopFieldCollector.java:164) at org.apache.lucene.search.IndexSearcher.search(IndexSearcher.java:812) at org.apache.lucene.search.IndexSearcher.search(IndexSearcher.java:535) at org.apache.lucene.search.IndexSearcher.search(IndexSearcher.java:523) at org.hibernate.search.query.engine.impl.LazyQueryState.search(LazyQueryState.java:100) at org.hibernate.search.query.engine.impl.QueryHits.updateTopDocs(QueryHits.java:241) at org.hibernate.search.query.engine.impl.QueryHits.<init>(QueryHits.java:136) at org.hibernate.search.query.engine.impl.LuceneHSQuery.getQueryHits(LuceneHSQuery.java:322) at org.hibernate.search.query.engine.impl.LuceneHSQuery.queryEntityInfos(LuceneHSQuery.java:131) at org.hibernate.search.query.hibernate.impl.FullTextQueryImpl.list(FullTextQueryImpl.java:200) ... 123 common frames omitted

I tried changing the type in my SortField but alas - the SortField.Type enum doesn't contain a value named "SORTED".

Activity

Guillaume SmetSeptember 5, 2016 at 2:36 PM

I added a note about this in the Migration guide of the 5.5 release.

Guillaume SmetSeptember 5, 2016 at 2:35 PM

Done.

Guillaume SmetApril 14, 2016 at 1:03 PM

That's what I meant so you're good to go!

Ido DovratApril 14, 2016 at 12:25 PM

Thanks. I didn't exactly add a new Java field, but I did generate an additional Lucene field based on the id property, simply by doing this:

@Id @Field(name = "id_forSort", index = Index.YES, analyze = Analyze.NO) @SortableField(forField = "id_forSort") public Long getId() { ...

Then I use the id_forSort field for my SortField instead of the id field.

Guillaume SmetApril 14, 2016 at 12:05 PM

Hi Ido!

Thanks for the very detailed report. I had the same issue with our applications: the fact is that it's considered a bad practice to use the @Id field to sort your results.

You need to define another field with @Field and a @SortableField for this new field. Then you should use this new field to sort your results.

It's probably worth a mention in the migration guide.

Fixed

Details

Assignee

Reporter

Fix versions

Affects versions

Priority

Created April 14, 2016 at 11:05 AM
Updated September 5, 2016 at 6:42 PM
Resolved September 5, 2016 at 2:36 PM

Flag notifications