apache/pinot

Add excludeReplacedSegments param into table metadata API

Open

#10,244 opened on Feb 8, 2023

View on GitHub
 (2 comments) (1 reaction) (1 assignee)Java (1,234 forks)batch import
good first issue

Repository metrics

Stars
 (4,937 stars)
PR merge metrics
 (Avg merge 6d 7h) (186 merged PRs in 30d)

Description

/tables/{tableName}/metadata endpoint should take an additional parameter such as excludeReplacedSegments as found in getSegments in order to discern between reporting stats with consistent push accounted for or not.

Currently, the table returns TableMetadata with info such as diskSizeInBytes, numSegments and numRows approximately doubled when consistent push is in-place, and users who are unaware of the consistent push concept may incorrectly interpret the result, e.g. leading to provisioning 2x the storage by mistake.

This should be done in a backward compatible manner, with the default behavior being the current one if the additional param is not explicitly set.

Contributor guide

Research direction
Examine the getSegments endpoint implementation in PinotSegmentRestletResource.java to understand how the excludeReplacedSegments parameter is handled, then add a similar parameter to the /tables/{tableName}/metadata endpoint in the corresponding controller, ensuring backward compatibility by defaulting to current behavior.
Tech stack
java
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75