{"action":"created","issue":{"url":"https://api.github.com/repos/cloudant/sync-android/issues/142","labels_url":"https://api.github.com/repos/cloudant/sync-android/issues/142/labels{/name}","comments_url":"https://api.github.com/repos/cloudant/sync-android/issues/142/comments","events_url":"https://api.github.com/repos/cloudant/sync-android/issues/142/events","html_url":"https://github.com/cloudant/sync-android/pull/142","id":80962700,"number":142,"title":"Document dollar sign and period use in a field name","user":{"login":"alfinkel","id":8793303,"avatar_url":"https://avatars.githubusercontent.com/u/8793303?v=3","gravatar_id":"","url":"https://api.github.com/users/alfinkel","html_url":"https://github.com/alfinkel","followers_url":"https://api.github.com/users/alfinkel/followers","following_url":"https://api.github.com/users/alfinkel/following{/other_user}","gists_url":"https://api.github.com/users/alfinkel/gists{/gist_id}","starred_url":"https://api.github.com/users/alfinkel/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alfinkel/subscriptions","organizations_url":"https://api.github.com/users/alfinkel/orgs","repos_url":"https://api.github.com/users/alfinkel/repos","events_url":"https://api.github.com/users/alfinkel/events{/privacy}","received_events_url":"https://api.github.com/users/alfinkel/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-05-26T13:29:38Z","updated_at":"2015-05-26T13:41:42Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/cloudant/sync-android/pulls/142","html_url":"https://github.com/cloudant/sync-android/pull/142","diff_url":"https://github.com/cloudant/sync-android/pull/142.diff","patch_url":"https://github.com/cloudant/sync-android/pull/142.patch"},"body":"_What_\r\n\r\nThis PR adds content to the documentation to explain the use of `$` and `.` in field names.\r\n\r\n_Why_\r\n\r\nA user needs to understand the expected behavior of the query and indexing engine when naming fields.\r\n\r\n_How_\r\n\r\nAdd a \"Restrictions\" sub-heading under the \"Creating Indexes\" heading to describe the behaviors of using a dollar sign as the first character in a field name and a period within a field name.\r\n\r\nreviewer @mikerhodes \r\nreviewer @gadamc \r\n\r\nBugId: 47451"},"comment":{"url":"https://api.github.com/repos/cloudant/sync-android/issues/comments/105527013","html_url":"https://github.com/cloudant/sync-android/pull/142#issuecomment-105527013","issue_url":"https://api.github.com/repos/cloudant/sync-android/issues/142","id":105527013,"user":{"login":"mikerhodes","id":453210,"avatar_url":"https://avatars.githubusercontent.com/u/453210?v=3","gravatar_id":"","url":"https://api.github.com/users/mikerhodes","html_url":"https://github.com/mikerhodes","followers_url":"https://api.github.com/users/mikerhodes/followers","following_url":"https://api.github.com/users/mikerhodes/following{/other_user}","gists_url":"https://api.github.com/users/mikerhodes/gists{/gist_id}","starred_url":"https://api.github.com/users/mikerhodes/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mikerhodes/subscriptions","organizations_url":"https://api.github.com/users/mikerhodes/orgs","repos_url":"https://api.github.com/users/mikerhodes/repos","events_url":"https://api.github.com/users/mikerhodes/events{/privacy}","received_events_url":"https://api.github.com/users/mikerhodes/received_events","type":"User","site_admin":false},"created_at":"2015-05-26T13:41:42Z","updated_at":"2015-05-26T13:41:42Z","body":"I'd be tempted to move this to above the \"Creating Indexes\" title, so nearer to the top. Then start with something like:\r\n> Query offers a powerful way to find documents within your datastore. There are a couple of restrictions on fieldnames you need to be aware of before using query:\r\nAnd postfix with:\r\n> These come from Query's MongoDB heritage where these characters are not allowed in fieldnames, which we don't share. Hopefully we'll work around these restrictions in future."}}