apache / apache/lucene

DocValues is Closeable/has a close() but says users shouldn't call it [LUCENE-3861]

Open
#4,934 1 comment 0 reactions 0 assignees View on GitHub
legacy-jira-priority:Major type:enhancement
Dominant language
Java
Stars
3.6k
Forks
1.4k
Avg merge
2d 11h
Merged PRs (30d)
88

Description

I think this is confusing: the javadocs say you should not call it, if this is the case,
can we make it so that DocValues coming from IR is not actually closeable?

---
Migrated from [LUCENE-3861](https://issues.apache.org/jira/browse/LUCENE-3861) by Robert Muir (@rmuir)

Contributor guide

Open the contributing guide

Research direction

Start by locating the DocValues API and the IR entry points that return it, then read the javadocs describing its close() behavior. Determine the affected API and usage surface before deciding how to make DocValues from IR non-closeable; done means the interface and documentation consistently reflect the intended lifecycle and relevant tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend, search
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.