API Docs for:
Show:

Query Class

Defined in: lib/query.js:6

オブジェクトの検索を行うモジュールです。

DataStore, User, Role, Fileクラスから呼び出し、それぞれのクラスメソッドとして利用します。 検索条件を設定するメソッドに続けてfetch/fetchAllをメソッドチェーンで実行して利用します。

Constructor

Query

()

Defined in lib/query.js:6

Methods

allInArray

(
  • key
  • values
)

Defined in lib/query.js:194

指定したキーの配列内の値が、条件の配列内のすべての値を含むオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • values Array

    比較する値

Returns:

this

count

()

Defined in lib/query.js:437

検索結果の配列と共に、検索結果の件数を取得します。 検索結果の配列は最大100件までしか取得しませんが、countは検索結果の総件数を表示します。 検索結果配列にcountプロパティとして付加されます。

Returns:

this

equalTo

(
  • key
  • value
)

Defined in lib/query.js:42

指定したキーの値が条件と等しいオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • value Object

    比較する値

Returns:

this

exists

(
  • key
  • exist
)

Defined in lib/query.js:140

指定したキーに値が存在するオブジェクトを検索します。 existにfalseが設定されている場合、指定したキーに値が存在しないオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • exist Boolean

    falseを設定した場合、値が存在しないオブジェクトを検索する。省略可能。

Returns:

this

fetch

(
  • callback
)
Object

Defined in lib/query.js:542

検索条件に合致するオブジェクトのうち、先頭の一つだけを取得します。

Parameters:

  • callback Function

    コールバック関数

Returns:

Object:

検索結果に合致したオブジェクト

fetchAll

(
  • callback
)
Array

Defined in lib/query.js:564

検索条件に合致するオブジェクトをすべて取得します。

Parameters:

  • callback Function

    コールバック関数

Returns:

Array:

検索結果に合致したオブジェクトの配列

fetchById

(
  • id
  • callback
)

Defined in lib/query.js:507

objectIdから一意のオブジェクトを取得します。

Parameters:

  • id String

    取得したいオブジェクトのobjectId

  • callback Function

    コールバック関数

Returns:

オブジェクト

greaterThan

(
  • key
  • value
)

Defined in lib/query.js:90

指定したキーの値が条件より大きいオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • value Object

    比較する値

Returns:

this

greaterThanOrEqualTo

(
  • key
  • value
)

Defined in lib/query.js:102

指定したキーの値が条件以上のオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • value Object

    比較する値

Returns:

this

in

(
  • key
  • values
)

Defined in lib/query.js:114

指定したキーの値が、条件の配列内のいずれかと等しいオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • values Array

    比較する値

Returns:

this

inArray

(
  • key
  • values
)

Defined in lib/query.js:168

指定したキーの配列内の値のいずれかが、条件の配列内のいずれかと等しいオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • values Array

    比較する値

Returns:

this

include

(
  • key
)

Defined in lib/query.js:423

指定したキーに設定されているポインタの中身ごと検索結果を取得します。 複数回実行した場合、最後に設定したキーが反映されます。複数のキーを指定することはできません。

Parameters:

  • key String

    ポインタの中身を取得するキー

Returns:

this

inQuery

(
  • key
  • subquery
)

Defined in lib/query.js:385

サブクエリの検索結果のいずれかを、指定したキーにポインタで持つオブジェクトを検索します。 objectはmobile backend に保存済みである必要がある。

Parameters:

  • key String

    ポインタを保存したキー

  • subquery Query

    検索条件

Returns:

this

lessThan

(
  • key
  • value
)

Defined in lib/query.js:66

指定したキーの値が条件より小さいオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • value Object

    比較する値

Returns:

this

lessThanOrEqualTo

(
  • key
  • value
)

Defined in lib/query.js:78

指定したキーの値が条件以下のオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • value Object

    比較する値

Returns:

this

limit

(
  • limit
)

Defined in lib/query.js:475

検索結果の最大取得数を設定します。最小設定値は1、最大設定値は1000です。

Parameters:

  • limit Number

    最大取得件数

Returns:

this

near

(
  • key
  • location
)

Defined in lib/query.js:207

指定したキーの位置情報が指定した位置に近い順でオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • location ncmb.GeoPoint

    原点とする位置情報

Returns:

this

notEqualTo

(
  • key
  • value
)

Defined in lib/query.js:54

指定したキーの値が条件と等しくないオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • value Object

    比較する値

Returns:

this

notIn

(
  • key
  • values
)

Defined in lib/query.js:127

指定したキーの値が、条件の配列内のいずれとも等しくないオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • values Array

    比較する値

Returns:

this

notInArray

(
  • key
  • values
)

Defined in lib/query.js:181

指定したキーの配列内の値が、条件の配列内のいずれとも等しくないオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • values Array

    比較する値

Returns:

this

or

(
  • subqueries
)

Defined in lib/query.js:294

複数の検索条件を設定し、いずれかに合致するオブジェクトを検索します。 配列で複数の条件を一度に設定でき、複数回実行することで検索条件を追加できます。

Parameters:

  • subqueries Array/Query

    検索条件

Returns:

this

order

(
  • key
  • descending
)

Defined in lib/query.js:450

指定したキーの昇順にソートして検索結果を取得します。 複数回実行することで、複数のキーを指定できます。その場合、先に指定したキーが優先的にソートされます。 フラグによって降順ソートも可能です。降順フラグはキーごとに設定できます。

Parameters:

  • key String

    ソートするキー

  • descending Object

    trueを指定した場合、降順でソートされる。省略可能。

Returns:

this

regularExpressionTo

(
  • key
  • regex
)

Defined in lib/query.js:155

指定したキーの値が指定した正規表現に合致する存在するオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • regex String

    検索する正規表現

Returns:

this

relatedTo

(
  • object
  • key
)

Defined in lib/query.js:355

入力したオブジェクトの指定したキーに関連づけられているオブジェクトを検索します。 objectはmobile backend に保存済みである必要があります。

Parameters:

  • object Object
  • key String

    オブジェクトが関連づけられているキー

Returns:

this

select

(
  • key
  • subkey
  • subqueries
)

Defined in lib/query.js:315

サブクエリの検索結果が指定したサブキーに持つ値のいずれかと、指定したキーが合致するオブジェクトを検索します。

Parameters:

  • key String

    メインクエリのクラスで値を比較するキー

  • subkey String

    サブクエリの検索結果で値を比較するキー

  • subqueries Array/Query

    検索条件

Returns:

this

skip

(
  • skip
)

Defined in lib/query.js:493

検索結果の最初から指定した件数だけ除いた結果を取得するようにします。

Parameters:

  • skip Number

    検索結果から除く件数

Returns:

this

where

(
  • where
)

Defined in lib/query.js:24

クエリを自分で記述して設定します。

Parameters:

  • where Object

    JSON形式のクエリオブジェクト

Returns:

this

withinKilometers

(
  • key
  • location
  • maxDistance
)

Defined in lib/query.js:222

検索範囲内(Km)で、指定したキーの位置情報が指定した位置に近い順でオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • location ncmb.GeoPoint

    原点とする位置情報

  • maxDistance Number

    原点からの検索範囲(Km)

Returns:

this

withinMiles

(
  • key
  • location
  • maxDistance
)

Defined in lib/query.js:240

検索範囲内(ml)で、指定したキーの位置情報が指定した位置に近い順でオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • location ncmb.GeoPoint

    原点とする位置情報

  • maxDistance Number

    原点からの検索範囲(ml)

Returns:

this

withinRadians

(
  • key
  • location
  • maxDistance
)

Defined in lib/query.js:258

検索範囲内(rad)で、指定したキーの位置情報が指定した位置に近い順でオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • location ncmb.GeoPoint

    原点とする位置情報

  • maxDistance Number

    原点からの検索範囲(rad)

Returns:

this

withinSquare

(
  • key
  • southWestVertex
  • northEastVertex
)

Defined in lib/query.js:276

検索範囲を南西と北東の位置情報から矩形で設定し、指定したキーの位置情報が指定した位置に近い順でオブジェクトを検索します。

Parameters:

  • key String

    値を比較するキー

  • southWestVertex ncmb.GeoPoint

    検索矩形の南西側の頂点

  • northEastVertex ncmb.GeoPoint

    検索矩形の北東側の頂点

Returns:

this