Features/Plain Query Format: Difference between revisions

Godiard (talk | contribs)
No edit summary
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<noinclude>{{GoogleTrans-en}}{{TOCright}}</noinclude>
<noinclude>{{GoogleTrans-en}}{{TOCright}}
[[Category:Feature Page Incomplete]]
[[Category:FeatureObsoleted|Plain Query Format]]</noinclude>


<!-- All fields on this form are required to be accepted.
<!-- All fields on this form are required to be accepted.
Line 8: Line 10:
== Summary ==
== Summary ==


Provide simple string query format for Datastore find() method to cover all kinds of requests.
Provide a simple string query format for the Datastore find() method to cover all kinds of requests.


== Owner ==
== Owner ==
Line 17: Line 19:
== Current status ==
== Current status ==


* Targeted release: 0.86
* Targeted release: ?
* Last updated: Tue Aug 25 07:59:58 UTC 2009
* Last updated: Tue Aug 25 07:59:58 UTC 2009
* Percentage of completion: core part was implemented within [[Version support for datastore/Proposal]]
* Percentage of completion: 90%, core part was implemented within [[Version support for datastore/Proposal]]


== Detailed Description ==
== Detailed Description ==


Let users create complex queries with all possible terms([http://xapian.org/docs/glossary.html Xapian glossary]) including system ones. Users can use in query string [[#System prefixes|system]] prefixes and predefined set of [[#Users predefined prefixes|custom]] prefixes.
Let users create complex queries with all possible terms (see Xapian [http://xapian.org/docs/glossary.html glossary]) including system ones. Users can use in query string [[#System prefixes|system]] prefixes and predefined set of [[#Users predefined prefixes|custom]] prefixes.


Prefixes in query string could look like
Prefixes in query string could look like
Line 29: Line 31:
  <prefix>:"<multi-word-value>"
  <prefix>:"<multi-word-value>"


Values for system prefixes, sugar fills on its own i.e. if ''title'' metadata field is ''My activity'', user can type ''title:"My activity"'' in query string.
Values for system prefixes, Sugar fills on its own, i.e., if ''title'' metadata field is ''My activity'', user can type ''title:"My activity"'' in query string to search ''My activity'' substring only within ''title'' fields.


Values for [[#Users predefined prefixes|custom]] prefixes user should place to ''tags'' metadata field in the same form like in query string.
Values for [[#Users predefined prefixes|custom]] prefixes user should place to ''tags'' metadata field in the same form like in query string.


If value is multi worded, any of these word could be used in query e.g. ''title:My'' or ''title:activity''.
If value is multi-worded, any of these words could be used in query, e.g., ''title:My'' or ''title:activity''.


==== System prefixes ====
==== System prefixes ====
Line 188: Line 190:
== Benefit to Sugar ==
== Benefit to Sugar ==


* simple(plain string in comparing with existed API with dictionary find()'s argument) query format for dbus find() method
* Feature lets users specify exact metadata fields to search for.
* simple and new-feature-proof way to implement find method for example in CLI tools(because this tool needs only to pass plain string to Datastore service)
* let experienced users use system terms in Journal search bar
* existed implementation has hard-coded logic for example in case of having several mime_types in query(all mime_types will be ORed despite what user wants).


== Scope ==
== Scope ==
Line 212: Line 211:
== User Experience ==
== User Experience ==


* In Journal search bar users can use system terms e.g. ''timestamp:<date1>..<date2> AND mime_type="text/plain" AND participant:me'''
* feature just expands query dictionary
* use tags with prefixes to differentiate them from regular words e.g. having substring ''books:favorite'' in tags field, user can type ''books:favorite'' in search bar and differentiate word ''favorite'' with prefix ''books'' from other ''books'' words.


== Dependencies ==
== Dependencies ==
Line 234: Line 232:
== Comments and Discussion ==
== Comments and Discussion ==
* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
* See [[{{TALKPAGENAME}}|discussion tab for this feature]] <!-- This adds a link to the "discussion" tab associated with your page.  This provides the ability to have ongoing comments or conversation without bogging down the main feature page -->
[[Category:Feature Page Incomplete]]
[[Category:Feature]]