[
https://issues.apache.org/jira/browse/FALCON-1095?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Ying Zheng updated FALCON-1095:
-------------------------------
Comment: was deleted
(was: Good question. Here are three differences in comparison with the existing
implementation.
1. We find that providing information on entity name and tags is usually enough
to find entities. However, the existing API requires the user to provide entity
type and it is part of the REST url path. So, in this proposal, we plan to make
the entity type parameter optional. This saves the user's search time since
most of the time the user doesn't need to enter entity type to narrow down
candidates if they provide information on name/tags. This is also the most
important reason why we would like to introduce a new API.
2. As you already mentioned, we provide free-text search not only on name, but
also tags. Your work on fuzzy search on name can also be applied here.
3. We plan to provide a search UI, similar to Visual Search, to allow the user
to enter keywords in a search box and view filtered results immediately. The
user can click on the entity for details and search its instances as well.
In all, this proposal is towards a more convenient way to search entities. I
added more details in the description as well.)
> 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. To be more specific, users can filter entities by keywords in name
> and tags. Moreover, a search UI, similar to Visual Search, will be provided
> 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.
> We plan to add a new API: GET api/entities/search
> Parameters (all optional)
> name Keywords on name. Not case sensitive.
> type Valid options are feed and process.
> tags Keywords on tag, separated by comma. Not case sensitive.
> 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
(v6.3.4#6332)
