Class Index | File Index

Classes


Class Bmob.Query

Bmob.Query 为Bmob.Objects定义了query操作
Defined in: bmob.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Bmob.Query(objectClass)
为Bmob.Object类创建一个新的bmob Bmob.Query 。
Method Summary
Method Attributes Method Name and Description
 
ascending(key)
根据key对结果进行升序。
 
collection(items, options)
查询后返回一个Bmob.Collection
 
containedIn(key, values)
添加key中包含任意一个值查询。
 
contains(key, substring)
查找一个值中是否包含某个子串。在大量的数据中,这个操作可能很慢。
 
containsAll(key, values)
添加key中包含全部值查询。
 
count(options)
查询结果的数目。 完成后,options.success 或 options.error 会被调用。
 
根据key对结果进行降序。
 
destroyAll(options)
把查询到的所有对象删除。
 
添加key是否不存在的查询。
 
doesNotMatchKeyInQuery(key, queryKey, query)
添加查询: key's value 不匹配一个对象,这个对象通过不同的Bmob.Query返回。
 
doesNotMatchQuery(key, 不需要匹配的query)
添加一个Bmob.Query的不匹配查询。
 
each(callback, options)
对查询的每个结果调用回调函数。 如果callback返回promise,这个迭代器不会继续直到所有的promise调用完毕。 如果回调返回拒绝promise,迭代会停止。 所有对象将以不排序的形式处理。 查询将不会有任何的排序,同时limit 或skip 将无效。
 
endsWith(key, suffix)
检查某个值是否以特殊的字符串结尾。在大量的数据中,这个操作可能很慢。
 
equalTo(key, value)
添加一个equal查询(key value 形式)。
 
exists(key)
添加key是否存在的查询。
 
find(options)
查找满足查询条件的对象。完成后,options.success 或 options.error 会被调用。
 
first(options)
在返回的结果中,返回第一个对象 完成后,options.success 或 options.error 会被调用。
 
get(objectId, options)
获取Bmob.Object,适用于id已经知道的情况。当查询完成会调用options.success 或 options.error。
 
greaterThan(key, value)
添加一个大于查询。
 
添加一个大于等于查询。
 
include(key)
当获取的Bmob.Objects有指向其子对象的Pointer类型指针Key时,你可以加入inclue选项来获取指针指向的子对象
 
lessThan(key, value)
添加一个小于查询。
 
lessThanOrEqualTo(key, value)
添加一个小于等于查询。
 
limit(n)
限制返回结果的数目。默认限制是100,最大限制数是1000.
 
matches(key, regex, modifiers)
添加正则表达式的查询。 当数据很大的时候这个操作可能很慢。
 
matchesKeyInQuery(key, queryKey, query)
添加查询: key's value 匹配一个对象,这个对象通过不同的Bmob.Query返回。
 
matchesQuery(key, query)
添加一个Bmob.Query的匹配查询。
 
near(key, point)
查找一个geo point 附近的坐标。
 
notContainedIn(key, values)
添加key中不包含任意一个值查询。
 
notEqualTo(key, value)
添加一个not equal查询(key value 形式)。
<static>  
Bmob.Query.or(var_args)
通过传递query构造or的Bmob.Query对象。 For example:
var compoundQuery = Bmob.Query.or(query1, query2, query3);
通过query1, query2, 和 query3创建一个or查询
 
select(keys)
匹配另一个查询的返回值,如果这个函数被调用多次,每次调用时所有的keys将会被包含。
 
skip(n)
在返回结果前设置跳过的结果数目。是在分页时使用的。默认是跳过0条结果。
 
startsWith(key, prefix)
检查某个值是否以特殊的字符串开头。 这查询使用了backend index,因此在大数据中也很快。
 
返回json的结局
 
withinGeoBox(key, southwest, northeast)
在一个四边形范围内,查找某个点附近的对象
 
withinKilometers(key, point, maxDistance)
添加用于查找附近的对象,并基于千米给出最大距离内的点。
 
withinMiles(key, point, maxDistance)
添加用于查找附近的对象,并基于米给出最大距离内的点。
 
withinRadians(key, point, maxDistance)
添加用于查找附近的对象,并基于弧度给出最大距离内的点。
Class Detail
Bmob.Query(objectClass)
为Bmob.Object类创建一个新的bmob Bmob.Query 。
Parameters:
objectClass
- Bmob.Object的实例,或者Bmob类名

Bmob.Query 为Bmob.Objects定义了query操作。最常用的操作就是用queryfind 操作去获取所有的对象。例如,下面简单的操作是获取所有的MyClass。根据操作的成功或失败, 会回调不同的函数。

var query = new Bmob.Query(MyClass);
query.find({
  success: function(results) {
    // results is an array of Bmob.Object.
  },

  error: function(error) {
    // error is an instance of Bmob.Error.
  }
});

Bmob.Query也可以用来获取一个id已知的对象。例如,下面的例子获取了MyClass 和 id myId 根据操作的成功或失败,会回调不同的函数。

var query = new Bmob.Query(MyClass);
query.get(myId, {
  success: function(object) {
    // object is an instance of Bmob.Object.
  },

  error: function(object, error) {
    // error is an instance of Bmob.Error.
  }
});

Bmob.Query 同时也能获取查询结果的数目。例如,下面的例子获取了MyClass的数目

   
var query = new Bmob.Query(MyClass);
query.count({
  success: function(number) {
    // There are number instances of MyClass.
  },

  error: function(error) {
    // error is an instance of Bmob.Error.
  }
});

Method Detail
{Bmob.Query} ascending(key)
根据key对结果进行升序。
Parameters:
{String} key
排序的key
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Collection} collection(items, options)
查询后返回一个Bmob.Collection
Parameters:
items
options
Returns:
{Bmob.Collection}

{Bmob.Query} containedIn(key, values)
添加key中包含任意一个值查询。
Parameters:
{String} key
需要检查的key.
{Array} values
需要包含的值的数组
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} contains(key, substring)
查找一个值中是否包含某个子串。在大量的数据中,这个操作可能很慢。
Parameters:
{String} key
需要查找的值
{String} substring
需要匹配子串
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} containsAll(key, values)
添加key中包含全部值查询。
Parameters:
{String} key
需要检查的key
{Array} values
需要包含的全部值的数组
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Promise} count(options)
查询结果的数目。 完成后,options.success 或 options.error 会被调用。
Parameters:
{Object} options
A Backbone-style options 对象.
Returns:
{Bmob.Promise} 完成后,结果的 promise 会被调用。

{Bmob.Query} descending(key)
根据key对结果进行降序。
Parameters:
{String} key
排序的key
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Promise} destroyAll(options)
把查询到的所有对象删除。
Parameters:
{Object} options
标准的带 success and error回调的options对象。
Returns:
{Bmob.Promise} 当完成后,结果的 promise 会被调用。

{Bmob.Query} doesNotExist(key)
添加key是否不存在的查询。
Parameters:
{String} key
需要检查是否不存在的key。
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} doesNotMatchKeyInQuery(key, queryKey, query)
添加查询: key's value 不匹配一个对象,这个对象通过不同的Bmob.Query返回。
Parameters:
{String} key
需要匹配的key值 excluded.
{String} queryKey
返回通过不匹配的查询的对象的键
{Bmob.Query} query
需要运行的查询
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} doesNotMatchQuery(key, 不需要匹配的query)
添加一个Bmob.Query的不匹配查询。
Parameters:
{String} key
需要检查的key。
{Bmob.Query} 不需要匹配的query
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Promise} each(callback, options)
对查询的每个结果调用回调函数。 如果callback返回promise,这个迭代器不会继续直到所有的promise调用完毕。 如果回调返回拒绝promise,迭代会停止。 所有对象将以不排序的形式处理。 查询将不会有任何的排序,同时limit 或skip 将无效。
Parameters:
callback
{Function} 每个结果调用的回调函数
options
{Object} 可选的 Backbone-like 带成功或失败的回调,回调将会执行当迭代结束的时候。
Returns:
{Bmob.Promise} 当迭代结束的时候A promise 将会执行一次。

{Bmob.Query} endsWith(key, suffix)
检查某个值是否以特殊的字符串结尾。在大量的数据中,这个操作可能很慢。
Parameters:
{String} key
需要查找的值
{String} suffix
需要匹配子串
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} equalTo(key, value)
添加一个equal查询(key value 形式)。
Parameters:
{String} key
key
value
key对应的值
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} exists(key)
添加key是否存在的查询。
Parameters:
{String} key
需要检查是否存在的key。
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Promise} find(options)
查找满足查询条件的对象。完成后,options.success 或 options.error 会被调用。
Parameters:
{Object} options
A Backbone-style options 对象.
Returns:
{Bmob.Promise} 当查询完成后,结果的 promise 会被调用。

{Bmob.Promise} first(options)
在返回的结果中,返回第一个对象 完成后,options.success 或 options.error 会被调用。
Parameters:
{Object} options
A Backbone-style options 对象.
Returns:
{Bmob.Promise} 完成后,结果的 promise 会被调用。

get(objectId, options)
获取Bmob.Object,适用于id已经知道的情况。当查询完成会调用options.success 或 options.error。
Parameters:
objectId
要获取的对象id
{Object} options
Backbone-style options 对象.

{Bmob.Query} greaterThan(key, value)
添加一个大于查询。
Parameters:
{String} key
需要检查的key.
value
key所对应的必须大于的值
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} greaterThanOrEqualTo(key, value)
添加一个大于等于查询。
Parameters:
{String} key
需要检查的key.
value
key所对应的必须大于等于的值
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} include(key)
当获取的Bmob.Objects有指向其子对象的Pointer类型指针Key时,你可以加入inclue选项来获取指针指向的子对象
Parameters:
{String} key
需要包含的key的值
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} lessThan(key, value)
添加一个小于查询。
Parameters:
{String} key
需要检查的key.
value
key所对应的必须少于的值
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} lessThanOrEqualTo(key, value)
添加一个小于等于查询。
Parameters:
{String} key
需要检查的key.
value
key所对应的必须少于等于的值
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} limit(n)
限制返回结果的数目。默认限制是100,最大限制数是1000.
Parameters:
{Number} n
限制的数目。
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} matches(key, regex, modifiers)
添加正则表达式的查询。 当数据很大的时候这个操作可能很慢。
Parameters:
{String} key
需要检查的key
{RegExp} regex
需要匹配的正则表达式
modifiers
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} matchesKeyInQuery(key, queryKey, query)
添加查询: key's value 匹配一个对象,这个对象通过不同的Bmob.Query返回。
Parameters:
{String} key
需要匹配的key值
{String} queryKey
返回通过匹配的查询的对象的键
{Bmob.Query} query
需要运行的查询
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} matchesQuery(key, query)
添加一个Bmob.Query的匹配查询。
Parameters:
{String} key
需要检查的key。
{Bmob.Query} query
需要匹配的query
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} near(key, point)
查找一个geo point 附近的坐标。
Parameters:
{String} key
Bmob.GeoPoint的key
{Bmob.GeoPoint} point
指向一个 Bmob.GeoPoint
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} notContainedIn(key, values)
添加key中不包含任意一个值查询。
Parameters:
{String} key
需要检查的key.
{Array} values
不需要包含的值的数组
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} notEqualTo(key, value)
添加一个not equal查询(key value 形式)。
Parameters:
{String} key
key
value
key对应的值
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

<static> {Bmob.Query} Bmob.Query.or(var_args)
通过传递query构造or的Bmob.Query对象。 For example:
var compoundQuery = Bmob.Query.or(query1, query2, query3);
通过query1, query2, 和 query3创建一个or查询
Parameters:
{...Bmob.Query} var_args
or的query查询.
Returns:
{Bmob.Query} 查询结果.

{Bmob.Query} select(keys)
匹配另一个查询的返回值,如果这个函数被调用多次,每次调用时所有的keys将会被包含。
Parameters:
{Array} keys
需要包含的key的值
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} skip(n)
在返回结果前设置跳过的结果数目。是在分页时使用的。默认是跳过0条结果。
Parameters:
{Number} n
跳过的数目。
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} startsWith(key, prefix)
检查某个值是否以特殊的字符串开头。 这查询使用了backend index,因此在大数据中也很快。
Parameters:
{String} key
需要查找的值
{String} prefix
需要匹配子串
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Object} toJSON()
返回json的结局
Returns:
{Object}

{Bmob.Query} withinGeoBox(key, southwest, northeast)
在一个四边形范围内,查找某个点附近的对象
Parameters:
{String} key
The key to be constrained.
{Bmob.GeoPoint} southwest
这个四边形的南西方向
{Bmob.GeoPoint} northeast
这个四边形的东北方向
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} withinKilometers(key, point, maxDistance)
添加用于查找附近的对象,并基于千米给出最大距离内的点。
Parameters:
{String} key
Bmob.GeoPoint的key
{Bmob.GeoPoint} point
指向一个 Bmob.GeoPoint
maxDistance
返回的最大距离,基于弧度.
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} withinMiles(key, point, maxDistance)
添加用于查找附近的对象,并基于米给出最大距离内的点。
Parameters:
{String} key
Bmob.GeoPoint的key
{Bmob.GeoPoint} point
指向一个 Bmob.GeoPoint
maxDistance
返回的最大距离,基于弧度.
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

{Bmob.Query} withinRadians(key, point, maxDistance)
添加用于查找附近的对象,并基于弧度给出最大距离内的点。
Parameters:
{String} key
Bmob.GeoPoint的key
{Bmob.GeoPoint} point
指向一个 Bmob.GeoPoint
maxDistance
返回的最大距离,基于弧度.
Returns:
{Bmob.Query} 返回查询对象,因此可以使用链式调用。

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Jun 16 2014 15:31:23 GMT+0800 (CST)