falcon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ying Zheng (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (FALCON-1095) Support free-text search for entities
Date Sun, 15 Mar 2015 07:48:38 GMT

    [ https://issues.apache.org/jira/browse/FALCON-1095?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14362278#comment-14362278

Ying Zheng commented on FALCON-1095:

Good suggestions, Ajay.

Yes, I agree that it's best to improve existing api (i.e. list) for similar tasks. We can
add support for the url path api/entities/list, instead of api/entities/search in the initial
proposal. In this way, the user still use LIST api and type is optional.

Btw. We may not be able to make type parameters optional for other APIs (e.g. schedule, update,
etc.) unless we add name duplication detection for both types of entities. Otw. it would be
ambiguous not to specify the type if a feed and a process have the same name.

If I understand your "fuzzy search" code correctly, you are doing subsequence matching. Yes,
this is a more friendly way. In terms of naming, how about "nameseq" (v.s. pattern) for the
subsequence of the name and "tagkey" for keywords of tag?

> Support free-text search for entities
> -------------------------------------
>                 Key: FALCON-1095
>                 URL: https://issues.apache.org/jira/browse/FALCON-1095
>             Project: Falcon
>          Issue Type: New Feature
>    Affects Versions: 0.6
>            Reporter: Ying Zheng
>             Fix For: 0.7
> When users have hundreds or thousands of entities to manage, they may not remember the
exact name/tag of the entity. We would like to provide a more convenient way for the user
to search an entity by providing keywords in name and tags. We also plan to provide a search
UI, similar to Visual Search, to allow the user to enter keywords in a search box and display
the filtered results. The user can click on the entity to view details and search its instances
as well.
> To support free-text search, we plan to add a new API: GET api/entities/search
> Parameters (all optional)
> name             A subsequence of name. Not case sensitive.
> tags               Keywords on tag, separated by comma. Not case sensitive.
> type               Valid options are feed and process.
> orderBy         Column by which results should be ordered. Default is “name”.
> sortOrder       Valid options are "asc" and “desc”. Default is “asc”.
> offset             Show results from the offset. Used for pagination. Default is 0.
> numResults   Number of results to show per request. Used for pagination. Only integers
> 0 are valid. Default is 10.
> e.g. falcon entity -search -name housetexas -tags estate
> This should return the entity with name "houseSellTexas" and tags "category=realestate".

This message was sent by Atlassian JIRA

View raw message