Apache
/
druid
mirror of https://github.com/apache/druid.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

clarify and fixup typos related to unused segments in docs and javadocs. (#15498)

This commit is contained in:
Abhishek Radhakrishnan 2023-12-05 22:30:32 -08:00 committed by GitHub
parent ae6893edc3
commit f4949afdd7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api-reference/legacy-metadata-api.md
View File

@ -163,7 +163,7 @@ segment is unused, or is unknown, a 404 response is returned.
`GET /druid/coordinator/v1/metadata/datasources/{dataSourceName}/segments/{segmentId}?includeUnused=true`
Returns full segment metadata for a specific segment as stored in the metadata store. If the is unknown, a 404 response
Returns full segment metadata for a specific segment as stored in the metadata store. If it is unknown, a 404 response
is returned.
`GET /druid/coordinator/v1/metadata/datasources/{dataSourceName}/segments`

9
server/src/main/java/org/apache/druid/indexing/overlord/IndexerMetadataStorageCoordinator.java
View File

@ -433,11 +433,12 @@ public interface IndexerMetadataStorageCoordinator
/**
* Retrieve the segment for a given id from the metadata store. Return null if no such segment exists
* <br>
* If includeUnused is set, this also returns unused segments. Unused segments could be deleted by a kill task at any
* time and might lead to unexpected behaviour. This option exists mainly to provide a consistent view of the metadata,
* for example, in calls from MSQ controller and worker and would generally not be requrired.
* If {@code includeUnused} is set, the segment {@code id} retrieval should also consider the set of unused segments
* in the metadata store. Unused segments could be deleted by a kill task at any time and might lead to unexpected behaviour.
* This option exists mainly to provide a consistent view of the metadata, for example, in calls from MSQ controller
* and worker and would generally not be required.
*
* @param id The segment id
* @param id The segment id to retrieve
*
* @return DataSegment used segment corresponding to given id
*/