apache / apache/lucene

Add useful toString()s to DocValues impls [LUCENE-5095]

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

Description

Currently, you have no insight into what these are doing (what kind of compression does your numerics have, how much RAM are the datastructures taking up, so on.

So I think we should add some cheap toString's (nothing heavy), things like

```Java
`@Override`
public String toString() {
return "Lucene42Numeric(compression=TABLE,bpv=" + bitsPerValue)";
}
```

and so on. Maybe we could think about printing them from CheckIndex when verbose=true too.

---
Migrated from [LUCENE-5095](https://issues.apache.org/jira/browse/LUCENE-5095) by Robert Muir (@rmuir), 2 votes, updated Jul 07 2013

Contributor guide

Open the contributing guide

Research direction

Review the Java DocValues implementations and the issue's proposed Lucene42Numeric example first. Identify the relevant implementations and determine which inexpensive compression, bits-per-value, or memory details each can expose. Done means useful lightweight toString() output across the implementations, with CheckIndex verbose output considered only if the scope is confirmed.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.