[OASIS Issue Tracker] Commented: (ODATA-139) New system query option $search for free-text search within an entity set

[OASIS Issues Tracker <workgroup_mailer@lists.oasis-open.org>]

    [ http://tools.oasis-open.org/issues/browse/ODATA-139?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=32726#action_32726 ] 

Stefan Drees commented on ODATA-139:
------------------------------------

Thanks Mike! I think this proposal now is well balanced.

I really like the ease of use for the clients that comes with the parenthesis grouping. Although one can always rewrite such expressions to not need parentheses, the idea behind introducing the $search in the first place was fullfilling the expectations of the (human) users, that there should be "some simple text entry search field" like Bing/Google etc. for broad exploration of the data offered through a tool (interfacing over open data).

No one really wants to be forced to say 
    $search=foo AND bar OR foo AND baz OR that AND bar OR that AND baz

when instead she can write:
    $search=(foo OR that) AND (bar OR baz) 

Plus it (if unsure about precedence) gives the warm feeling of requesting precisely what is meant ... if one can say 
    $search=(foo AND bar) OR baz 

being equivalent to
    $search=foo AND bar OR baz 


> New system query option $search for free-text search within an entity set
> -------------------------------------------------------------------------
>
>                 Key: ODATA-139
>                 URL: http://tools.oasis-open.org/issues/browse/ODATA-139
>             Project: OASIS Open Data Protocol (OData) TC
>          Issue Type: Improvement
>          Components: OData ABNF Construction Rules, OData Protocol , OData URL Conventions 
>    Affects Versions: V4.0_WD01
>         Environment: [Proposed]
>            Reporter: Ralf Handl
>            Assignee: Michael Pizzo
>             Fix For: V4.0_WD01
>
>
> Searching a list of entries by entering a free-text search phrase in a single input field is a very common UI pattern in mobile and browser-based applications.
> Translating this (typically case-insensitive) search phrase into an OData filter string is cumbersome and error-prone.
> A better alternative is providing a specialized query option that takes a search term and allows the server to interpret this search term.
>     GET ~/Orders?$search=blue
> could return sales orders that somehow match the phrase "blue", without the client needing to specify where this phrase may occur. It even could appear in related entities, e.g. the description of one of the products ordered.
> This is comparable to Level 0 Conformance in CQL, see ODATA-3.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://tools.oasis-open.org/issues/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira