mBaaSではデータの取得時にクエリストリングを使ってデータの絞り込みを行います。例えば絞り込み条件であればwhereを使います。ドキュメント「REST API リファレンス : クエリの指定方法 | ニフクラ mobile backend」に記載されている他にも複数あるので、この記事で紹介します。
キーの種類
クエリストリングのパラメータは以下があります。なお、この順番は昇順で、署名を作る際の並びになります。
- count
- include
- limit
- order
- skip
- where
count
データ取得時に指定することで、検索結果の数を取得します。ページネーションで最大何件あるかといった情報を取得する際に使います。
include
ポインターで指定されたクラスのデータも取得する際に指定します。クラス名を文字列で指定します。
limit
データを何件取得するか指定します。数字で指定し、最大数は1,000となっています。
order
データの並び順を指定します。複数のカラムを指定する場合にはフィールド名を「,(カンマ)」で繋ぎます。基本は昇順ですが、-カラム名
とダッシュを頭に付けることで降順にできます。デフォルトはcreateDateの降順です。
skip
データを何件読み飛ばすか指定します。ページネーションで利用します。
where
データの絞り込み条件を指定します。様々なオペレータが用意されています。
REST API リファレンス : クエリの指定方法 | ニフクラ mobile backend
まとめ
クエリストリングはこれが全てです。つまり、これらのパラメータがデータ取得時に指定できます。より効率的なデータストアの使い方を目指して、クエリパラメータを覚えてください。