[
https://issues.apache.org/jira/browse/YARN-5585?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15794613#comment-15794613
]
Rohith Sharma K S edited comment on YARN-5585 at 1/3/17 12:40 PM:
------------------------------------------------------------------
I think it is better to get consensus on JavaDoc before going proceeding any
further patches. This looks to be a very important.
We should enforces users to provide both rather then fromIdPrefix which would
lead confusion to user. The below Java doc will be adding, does it looks good?
# fromIdPrefix :
{code}
If specified, then retrieve entities with an id prefix greater than or equal to
the specified fromIdPrefix. It specifies the id prefix for an entity. If
fromIdPrefix is same for all entities in a given entity type then user must
provide fromId as filter, otherwise fromIdPrefix does not work as expected. It
is recommended to provide both fromIdPrefix and fromId to work as expected.
{code}
# fromId
{code}
It works along with fromIdPrefix. It is mandatorily required when fromIdPrefix
for given entity type is same for all entities. If specified, then retrieve
entities from id prefix in fromIdPrefix and entity id carried in fromId. It is
recommended to provide both fromIdPrefix and fromId to work as expected.
{code}
# entityidprefix
{code}
If specified, then entity retrieval is faster. It specifies the id prefix for
the entity to be fetched
{code}
was (Author: rohithsharma):
I think it is better to get consensus on JavaDoc before going proceeding any
further patches. This looks to be a very important.
We should enforces users to provide both rather then fromIdPrefix which would
lead confusion to user.
# fromIdPrefix :
{code}
If specified, then retrieve entities with an id prefix greater than or equal to
the specified fromIdPrefix. It specifies the id prefix for an entity. If
fromIdPrefix is same for all entities in a given entity type then user must
provide fromId as filter, otherwise fromIdPrefix does not work as expected. It
is recommended to provide both fromIdPrefix and fromId to work as expected.
{code}
# fromId
{code}
It works along with fromIdPrefix. It is mandatorily required when fromIdPrefix
for given entity type is same for all entities. If specified, then retrieve
entities from id prefix in fromIdPrefix and entity id carried in fromId. It is
recommended to provide both fromIdPrefix and fromId to work as expected.
{code}
# entityidprefix
{code}
If specified, then entity retrieval is faster. It specifies the id prefix for
the entity to be fetched
{code}
> [Atsv2] Reader side changes for entity prefix and support for pagination via
> additional filters
> -----------------------------------------------------------------------------------------------
>
> Key: YARN-5585
> URL: https://issues.apache.org/jira/browse/YARN-5585
> Project: Hadoop YARN
> Issue Type: Sub-task
> Components: timelinereader
> Reporter: Rohith Sharma K S
> Assignee: Rohith Sharma K S
> Priority: Critical
> Labels: yarn-5355-merge-blocker
> Attachments: 0001-YARN-5585.patch, YARN-5585-YARN-5355.0001.patch,
> YARN-5585-YARN-5355.0002.patch, YARN-5585-YARN-5355.0003.patch,
> YARN-5585-YARN-5355.0004.patch, YARN-5585-YARN-5355.0005.patch,
> YARN-5585-workaround.patch, YARN-5585.v0.patch
>
>
> TimelineReader REST API's provides lot of filters to retrieve the
> applications. Along with those, it would be good to add new filter i.e fromId
> so that entities can be retrieved after the fromId.
> Current Behavior : Default limit is set to 100. If there are 1000 entities
> then REST call gives first/last 100 entities. How to retrieve next set of 100
> entities i.e 101 to 200 OR 900 to 801?
> Example : If applications are stored database, app-1 app-2 ... app-10.
> *getApps?limit=5* gives app-1 to app-5. But to retrieve next 5 apps, there is
> no way to achieve this.
> So proposal is to have fromId in the filter like
> *getApps?limit=5&&fromId=app-5* which gives list of apps from app-6 to
> app-10.
> Since ATS is targeting large number of entities storage, it is very common
> use case to get next set of entities using fromId rather than querying all
> the entites. This is very useful for pagination in web UI.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
