apache / apache/lucene

maxDocBytesToAnalyze should be required arg up front [LUCENE-1560]

Open
#2,634 4 comments 0 reactions 0 assignees View on GitHub
affects-version:2.4.1 legacy-jira-fix-version:4.9 legacy-jira-fix-version:6.0 legacy-jira-label:dead legacy-jira-priority:Major module:highlighter type:enhancement
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

We recently changed IndexWriter to require you to specify up-front
MaxFieldLength, on creation, so that you are aware of this dangerous
"loses stuff" setting. Too many developers had fallen into the trap
of "how come my search can't find this document...".

I think we should do the same with "maxDocBytesToAnalyze" with
highlighter?

Spinoff from this thread:

http://www.nabble.com/Lucene-Highlighting-and-Dynamic-Summaries-p22385887.html

---
Migrated from [LUCENE-1560](https://issues.apache.org/jira/browse/LUCENE-1560) by Michael McCandless (@mikemccand), updated May 09 2016

Contributor guide

Open the contributing guide

Research direction

Start by tracing the highlighter API that currently accepts maxDocBytesToAnalyze and compare it with IndexWriter's required MaxFieldLength setting. Review the linked discussion for the intended behavior and identify all callers affected. Done means the highlighter requires this limit up front and its existing use cases remain covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
search
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.