openstack/ceilometer
Code Issues Proposed changes

Fix description for "Inapt spelling of 'MongoDB'"

Browse Source 
There is an inapt spelling in the file called
ceilometer/doc/source/webapi/v2.rst.
  line194:...different meaning in Mongo DB and...
  line198:...the Mongo DB will return every....
  line199:See more in the Mongod DB doc.
I think "Mongo DB" and "Mongod DB" are supposed to
spelled as "MongoDB".

Change-Id: Icb72e5e5eb099a839c4ef5aba292a42976144428
Closes-Bug: #1488775
This commit is contained in:
JuPing 2015-08-26 08:38:21 +00:00
parent 7d4fa41b16
commit b569a66491
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/webapi/v2.rst
View File

@ -191,12 +191,12 @@ supported: *=*, *!=*, *<*, *<=*, *>*, *>=* and *in*; and the following logical
operators can be used: *and* *or* and *not*. The field names are validated
against the database models. See :ref:`api-queries` for how to query the API.
.. note:: The *not* operator has different meaning in Mongo DB and in SQL DB engine.
.. note:: The *not* operator has different meaning in MongoDB and in SQL DB engine.
If the *not* operator is applied on a non existent metadata field then
the result depends on the DB engine. For example if
{"not": {"metadata.nonexistent_field" : "some value"}} filter is used in a query
the Mongo DB will return every Sample object as *not* operator evaluated true
for every Sample where the given field does not exists. See more in the Mongod DB doc.
the MongoDB will return every Sample object as *not* operator evaluated true
for every Sample where the given field does not exists. See more in the MongoDB doc.
On the other hand SQL based DB engine will return empty result as the join operation
on the metadata table will return zero rows as the on clause of the join which
tries to match on the metadata field name is never fulfilled.