データの検索

概要

検索 は、データまたは結果のセットを返すモデルの読取操作です。 次の表に示すように、フィルタ を使用して、Node APIとREST APIでLoopBackモデルを検索することができます。フィルタは、戻されるデータセットの基準を指定します。 2つのAPIの機能とオプションは同じですが、唯一の違いはHTTPリクエストとNode関数呼び出しで使用される構文です。 いずれの場合も、LoopBackモデルはJSONを返します。

LoopBackは、次の種類のフィルタをサポートしています。

• Fields filter
• Include filter
• Limit filter
• Order filter
• Skip filter
• Where filter

詳細は以下のフィルタ を参照してください。

例

フィルタに関する追加の例は、各種類のフィルタの記事を参照してください（例：Whereフィルタ）。

find()メソッドで where と limit フィルタの両方を使用する例：

Account.find({where: {name: 'John'}, limit: 3}, function(err, accounts) { /* ... */ });

RESTを使った等価な例：

/accounts?filter[where][name]=John&filter[limit]=3

フィルタ

RESTとNode APIの両方で、任意の数のフィルタを使用して検索を定義できます。

LoopBackは、特定のフィルタ構文をサポートしています。SQLによく似ていますが、インジェクションなしで安全にシリアル化でき、JavaScriptネイティブであるように特別に設計されています。 以前は、この構文をサポートしていたのはPersistedModel.find()メソッド（および関連するメソッド）のみでした。

The following table describes LoopBack’s filter types:

REST 構文

HTTP クエリ文字列にフィルタを指定するには以下のようにします。

?filter_filterType_=_spec_&_filterType_=_spec_....

１回のリクエストに適用できるフィルタの数は、URLの最大長によってのみ、制限されます。これは一般的に使用するクライアントに依存します。

Node 構文

find() や findOne()の最初の引数としてフィルタを指定するには以下のようにします。

{ filterType: spec, filterType: spec, ... }

適用できるフィルタの数に理論的な限界はありません。

ここで、

• filterType はフィルタの種類： where・include・order・ limit・skip・fieldsのいずれかです。
• spec  はフィルタの仕様です。例えば where フィルタなら、 結果が一致しなければならない条件を書きます。 include フィルタなら、結果に含める関連フィールドを指定します。

REST 検索で「文字列化した」JSON を使う

上記の標準的なREST構文の代わりに、REST検索で「文字列化されたJSON」を使用することもできます。 これを行うには、次のようにNode構文用のJSONを使用します。

?filter={ Stringified-JSON }

Stringified-JSON はNode構文に沿った文字列化したJSONです。ただし、JSONではすべてのテキストキー/文字列を引用符（”）で囲む必要があります。

例： GET /api/activities/findOne?filter={"where":{"id":1234}}

オブジェクトの配列をフィルタリングする

loopback-filters モジュールは、LoopBackのフィルタ構文を実装します。 このモジュールを使用すると、MyModel.find(filter)でサポートされているのと同じフィルタ構文を使用して、オブジェクトの配列をフィルタリングできます。

ここでは、新しいモジュールを使用した基本的な例を示します。

var data = [{n: 1}, {n: 2}, {n: 3, id: 123}];
var filter = {where: {n: {gt: 1}}, skip: 1, fields: ['n']};
var filtered = require('loopback-filters')(data, filter);
console.log(filtered); // => [{n: 3}]

もう少し詳しく説明すると、コンマ区切り値（CSV）ファイルを解析して、価格列が10〜100のすべての値を出力する必要があるとします。 LoopBackフィルタ構文を使用するには、CSVコネクタか、メモリコネクタを使用する必要があります。両方とも、実際の目的には関係ない余分な作業が必要です。

CSVを（node-csvのようなモジュールを使って）解析すると、次のようなオブジェクトの配列が得られます（ユニークなアイテムは10,000個あるとします）。

[
  {price: 85, id: 79},
  {price: 10, id: 380},
  //...
]

これらの行をフィルタするには、以下のように一般的なJavaScriptを使うこともできます。

data.filter(function(item) {
  return item.price < 100 && item.price >= 10
});

これはフィルタリングには非常に簡単ですが、ソート、フィールド選択、さらに高度な操作はややこしくなります。 さらに、通常は入力としてパラメータを受け入れます。

例えば以下のようなものです。

var userInput = {min: 10, max: 100}

data.filter(function(item) {
  return item.price < userInput.min && item.price >= userInput.max
});

これを簡単にループバックフィルタとして書き直すことができます。

filter(data, {where: {input: {gt: userInput.min, lt: userInput.max}}})

または、フィルタオブジェクト構文をユーザー入力として採用するだけの場合は、次のようにします。

filter(data, userInput)

しかし loopback-filter、単に除外したり、含めたりするだけではありません。 フィールドの選択（フィールドを含む/除外する）・並べ替え・位置情報/距離の並べ替え・制限とスキップをサポートしています。 すべてがユーザー入力から簡単に作成できる宣言構文です。

LoopBackユーザーにとって、これは非常に強力なものです。 find() フィルタ構文を使用して複雑なクエリを作成する典型的な方法を学びました。前提として、JavaScriptで（underscore.jsなどのライブラリを使用して）同じことを行う方法を理解する必要があります。一方、loopback-filters モジュールを使えば、LoopBackサーバーと全く対話することなく、データベースをフィルタするためにサーバーに送信したのと正確に同じフィルタオブジェクトを、クライアントアプリケーションで再利用することができます。

入れ子になったプロパティのフィルタリング

Loopbackは、Mongodb、Cloudant、Memoryの3つのNoSQLコネクタで、入れ子になったプロパティをフィルタリングすることをサポートしています。

For example, model User contains a nested property user.address.tags.tag:

db.define('User', {
  name: {type: String, index: true},
  email: {type: String, index: true},
  address: {
    street: String,
    city: String,
    tags: [
      {
        tag: String,
      }
    ]
  }
});

users can do a nested query like User.find({where: {'address.tags.tag': 'business'}}.

リレーショナル・データベースのコネクタは、入れ子になったプロパティのフィルタリングをサポートしていません。