/ /

クエリビルダ

Overview

このガイドでは、Lambda クエリビルダの Lambda 統合拡張機能を使用して MongoDB database を操作する方法を学習できます。クエリビルダを使用すると、単一の構文とスムーズなインターフェースを使用して、サポートされている任意のデータベースのクエリを作成できます。

注意

Lambel 統合は、Lambel のクエリビルダと Eloqueent ORM を拡張し、同様のデータベース操作を実行できます。効率モデルを使用してドキュメントを取得する方法の詳細については、「読み取り操作」を参照してください。

Lambda はクエリビルダクラスDBにアクセスするためのファサードを提供し、データベース操作を実行できるようにします。クラスへの静的インターフェースであるファサードは、構文をより簡潔にし、ランタイムエラーを回避し、テスト可能性を向上させます。

Lambda 統合では、コレクションにアクセスするためのDBメソッドtable()が提供されます。コマンドと制約を指定するためのチェーンメソッド。次に、最後にget()メソッドをチェーンしてメソッドを実行し、結果を取得します。次の例は、クエリビルダを呼び出す構文を示しています。

DB::table('<collection name>')
    // chain methods by using the "->" object operator
    ->get();

Tip

DB::table()メソッドを使用する前に、アプリケーションのデフォルトのデータベース接続として MongoDB を指定していることを確認してください。データベース接続を設定する手順については、クイックスタートの「 MongoDB 接続の構成」の手順を参照してください。

MongoDB がアプリケーションのデフォルトのデータベースでない場合は、 DB::connection()メソッドを使用して MongoDB 接続を指定できます。次のコードに示すように、 connection()メソッドに接続名を渡します。

$connection = DB::connection('mongodb');

このガイドでは、次のタイプのクエリビルダ操作の例を取り上げます。

一致するドキュメントの取得
クエリレベルのオプションを設定する
クエリ結果の変更
MongoDB 操作を使用したデータの取得
MongoDB 書込み操作を使用したデータの書込み

始める前に

このガイドのコード例を実行するには、クイックスタートチュートリアルを完了して、Web アプリケーションを構成し、サンプルデータセットを MongoDB 配置にロードして、コントローラーメソッドからサンプルコードを実行します。期待されるコード出力を JSON ドキュメントとして確認するには、クイックスタートのオプションの「 JSON ドキュメントとして結果を表示する」ステップに示されているtoJson()メソッドを使用します。

クエリビルダを使用して読み取りおよび書込み操作を実行するには、 Illuminate\Support\Facades\DBファサードをインポートしてクエリを作成します。

一致するドキュメントの取得

このセクションには、次の演算子カテゴリの読み取り操作のクエリビルダの例が含まれています。

where メソッド
論理条件
範囲とタイプのチェック
パターン検索
Retrieve distinct values
集計

メソッドの例

次の例は、 where()クエリビルダメソッドを使用して、 imdb.ratingフィールド値が正確に9.3であるドキュメントをmoviesコレクションから検索する方法を示しています。クエリによって返される結果を確認するには、[ VIEW OUTPUT ] ボタンをクリックします。

$result = DB::connection('mongodb')
    ->table('movies')
    ->where('imdb.rating', 9.3)
    ->get();

[
   { "title": "Cosmos",
     "year": 1980,
     "runtime": 60,
     "imdb": {
       "rating": 9.3,
       "votes": 17174,
       "id": 81846
     },
     "plot": "Astronomer Carl Sagan leads us on an engaging guided tour of the various elements and cosmological theories of the universe.",
     ...
   },
   { "title": "The Shawshank Redemption",
     "year": 1994,
     "runtime": 142,
     "imdb": {
       "rating": 9.3,
       "votes": 1521105,
       "id": 111161
     },
     "plot": "Two imprisoned men bond over a number of years, finding solace and eventual redemption through acts of common decency.",
     ...
   },
   { "title": "The Real Miyagi",
     "year": 2015,
     "runtime": 90,
     "imdb": {
       "rating": 9.3,
       "votes": 41,
       "id": 2313306
     },
     "plot": "The life of the greatest karate master of a generation.",
      ...
   }
]

論理条件演算

このセクションの例では、次の論理条件操作を実行するために使用できるクエリビルダの構文を示します。

1 つ以上の条件に一致する論理和
すべての条件に一致する論理 AND
条件の否定に一致する論理ではない
ネストされた論理演算子グループ

論理和の例

次の例は、 orWhere()クエリビルダメソッドを連鎖させて、 1955のyear値に一致する、またはtitle値"Back to the Future"に一致するドキュメントをmoviesコレクションから検索する方法を示しています。

$result = DB::connection('mongodb')
    ->table('movies')
    ->where('year', 1955)
    ->orWhere('title', 'Back to the Future')
    ->get();

論理 AND の例

次の例は、 where()クエリビルダメソッドを連鎖させて、 8.5より大きいimdb.rating値と1940より小さいyear値の両方に一致するドキュメントをmoviesコレクションから検索する方法を示しています。

$result = DB::connection('mongodb')
    ->table('movies')
    ->where('imdb.rating', '>', 8.5)
    ->where('year', '<', 1940)
    ->get();

論理和の例

次の例では、 whereNot()クエリビルダメソッドを呼び出して、 imdb.ratingの値が2より大きくないドキュメントに一致するドキュメントをmoviesコレクションから検索する方法を示します。これは、 imdb.ratingが2以下であるすべてのドキュメントをマッチングすることと同じです。

$result = DB::connection('mongodb')
    ->table('movies')
    ->whereNot('imdb.rating', '>', 2)
    ->get();

ネストされた論理演算子グループの例

次の例では、 where()クエリビルダメソッドを連鎖させて、次の条件の両方に一致するドキュメントをmoviesコレクションから検索する方法を示します。この例では、論理 OR グループをグループ化するために、 where()クエリビルダメソッドの最初のパラメータとして包含を渡します。

imdb.rating の値がより大きい 8.5
year 値は1986または1996のいずれかです

$result = DB::connection('mongodb')
    ->table('movies')
    ->where('imdb.rating', '>', 8.5)
    ->where(function (Builder $query) {
        return $query
            ->where('year', 1986)
            ->orWhere('year', 1996);
    })->get();

範囲とタイプのチェック

このセクションの例は、次の範囲クエリと型チェック操作を使用して値を一致させるために使用できるクエリビルダの構文を示しています。

数値範囲内の値
NULL または欠損値
セットの 1 つ以上の値
一致日付
テキストパターンに一致する

数値範囲の例

次の例は、 whereBetween()クエリビルダメソッドを使用して、 9と9.5の間のimdb.rating値を含むドキュメントをmoviesコレクションから検索する方法を示しています。

$result = DB::connection('mongodb')
    ->table('movies')
    ->whereBetween('imdb.rating', [9, 9.5])
    ->get();

[
   { "title" "The Godfather", "imdb": { "rating": 9.2, "votes": 1038358, "id": 68646 }, ... },
   { "title": "Hollywood", "imdb": { "rating": 9.1, "votes": 511,"id": 80230 }, ... },
   { "title": "Cosmos", "imdb": { "rating": 9.3, "votes": 17174, "id": 81846 }, ... },
   ...
]

NULL または欠損値の例

次の例は、 whereNull()クエリビルダメソッドを使用して、 runtime値またはフィールドを省略するドキュメントをmoviesコレクションから検索する方法を示しています。

$result = DB::connection('mongodb')
    ->table('movies')
    ->whereNull('runtime')
    ->get();

セットの 1 つ以上の値の例

次の例は、 whereIn()クエリビルダメソッドを使用して、指定されたセット内のtitle値の少なくとも 1 つと一致するドキュメントをmoviesコレクションから検索する方法を示しています。

$result = DB::table('movies')
    ->whereIn('title', ['Toy Story', 'Shrek 2', 'Johnny English'])
    ->get();

[
   { "title": "Toy Story", "year": 1995, "runtime": 81, ... },
   { "title": "Johnny English", "year": 2003, "runtime": 87, ... },
   { "title": "Shrek 2", "year" 2004, "runtime": 93, ... },
   ...
]

一致日付の例

次の例は、 whereDate()クエリビルダメソッドを使用して、 releasedフィールド内の2010-1-15の指定された日付に一致するドキュメントをmoviesコレクションから検索する方法を示しています。

$result = DB::connection('mongodb')
    ->table('movies')
    ->whereDate('released', '2010-1-15')
    ->get();

テキストパターン一致の例

次の例は、 where()クエリビルダメソッドでlikeクエリ演算子を使用し、指定されたテキストパターンを使用してmoviesコレクションからドキュメントを検索する方法を示しています。

テキストパターンには、次のワイルドカード文字と混合したテキストを含めることができます。

% 0 文字以上の文字に一致する
_ 単一の文字に一致する

$result = DB::table('movies')
    ->where('title', 'like', '%spider_man%')
    ->get();

[
   { "title": "Kiss of the Spider Woman", ... },
   { "title": "Spider-Man", ... },
   { "title": "Spider-Man 2", ...},
   ...
]

whereLike() メソッドと whereNotLike() メソッド

次のメソッドは、パターンを一致させるためにクエリ演算子を使用するのと同じ機能を提供します。

whereLike(): 指定されたパターンに一致します。デフォルトでは、このメソッドは大文字と小文字を区別しない一致を実行します。メソッドの最後のパラメータとしてtrueを渡すことで、大文字と小文字の区別を有効にすることができます。
whereNotLike(): フィールド値に指定されたstringパターンが含まれていないドキュメントと一致します。

次の例は、 whereLike()メソッドを使用して、大文字と小文字の区別が有効になっているパターン'Start%'と一致する値がtitleフィールドにあるドキュメントを一致させる方法を示しています。

$result = DB::connection('mongodb')
    ->table('movies')
    ->whereLike('title', 'Start%', true)
    ->get();

[
   { "title": "Start-Up", ... },
   { "title": "Start the Revolution Without Me", ... },
   ...
]

Retrieve Distinct Values

次の例は、 distinct()クエリビルダーメソッドを使用して、 moviesコレクション内のドキュメントのyearフィールドのさまざまな値をすべて検索する方法を示しています。

$result = DB::table('movies')
    ->distinct('year')->get();

集計

このセクションの例では、集計を実行するために使用できるクエリビルダの構文を示します。集計は、クエリ結果データのセットから値を計算する操作です。集計を使用して、次の情報を計算して返すことができます。

共通のフィールド値でグループ化された結果
結果の数を数える
フィールドの最大値
フィールドの最小値
フィールドの平均値
フィールドの合計値
一致した結果の集計

一般的なフィールド値でグループ化された結果の例

次の例は、 groupBy()クエリビルダメソッドを使用して、 runtimeフィールドの共有値でグループ化されたドキュメントデータを取得する方法を示しています。この例では、次の操作を連鎖させて、 Gのrated値を含み、かつ個別のruntime値ごとに 1 つの映画のtitleフィールドを含むmoviesコレクションのドキュメントを照合します。

where()メソッドを使用して、 ratedフィールド値が"G"であるドキュメントのみをマッチングする
groupBy()メソッドを使用して、 _idフィールドに割り当てられているruntimeフィールドの個別の値でデータをグループ化します
orderBy()メソッドを使用して、 runtimeフィールドでグループを並べ替えます
グループ化された結果内の最後のドキュメントのtitleデータを、 get()メソッドで指定して返します

Tip

groupBy()メソッドは MongoDB $group集計演算子と$lastアキュムレータ演算子を呼び出します。これらの演算子の詳細については、サーバーマニュアルの$group（集計）を参照してください。

$result = DB::table('movies')
   ->where('rated', 'G')
   ->groupBy('runtime')
   ->orderBy('runtime', 'asc')
   ->get(['title']);

[
  ...
  {
    "_id": { "runtime": 64 },
    "runtime": 64,
    "title": "Stitch! The Movie"
  },
  {
     "_id": { "runtime": 67 },
     "runtime": 67,
     "title": "Bartok the Magnificent"
   },
   {
     "_id": { "runtime":68 },
     "runtime": 68,
     "title": "Mickey's Twice Upon a Christmas"
   },
   ...
]

結果数の例

次の例は、 count()クエリビルダメソッドを使用してmoviesコレクションに含まれるドキュメントの数を返す方法を示しています。

$result = DB::table('movies')
    ->count();

フィールド例の最大値

次の例は、 max()クエリビルダメソッドを使用して、 moviesコレクション全体からruntimeフィールドの最大の数値を返す方法を示しています。

$result = DB::table('movies')
    ->max('runtime');

フィールドの例の最小値

次の例は、 min()クエリビルダメソッドを使用して、 moviesコレクション全体からyearフィールドの最小の数値を返す方法を示しています。

$result = DB::table('movies')
    ->min('year');

フィールド例の平均値

次の例は、 avg()クエリビルダメソッドを使用して、 moviesコレクション全体からimdb.rating値の数値平均または算術平均を返す方法を示しています。

$result = DB::table('movies')
    ->avg('imdb.rating');

フィールドの合計値の例

次の例は、 sum()クエリビルダメソッドを使用して、 moviesコレクション全体からimdb.votes値の数値合計を返す方法を示しています。

$result = DB::table('movies')
    ->sum('imdb.votes');

一致した結果の集計の例

次の例では、クエリに一致する結果からデータを集計する方法を示しています。クエリは、 2000年以降のすべての映画に一致しており、 avg()メソッドを使用して、それらの一致のimdb.ratingの平均値を計算します。

$result = DB::table('movies')
    ->where('year', '>', 2000)
    ->avg('imdb.rating');

クエリレベルのオプションを設定する

クエリビルダでオプションを設定することで、Lambda 統合が操作を実行する方法を変更できます。オプションの配列を options() クエリビルダメソッドに渡して、クエリのオプションを指定できます。

次のコードは、クエリにコメントを添付する方法を示しています。

$result = DB::connection('mongodb')
    ->table('movies')
    ->where('year', 2000)
    ->options(['comment' => 'hello'])
    ->get();

The query builder accepts the same options that you can set for the find() method in the MongoDB PHP Library. Some of the options to modify query results, such as skip, sort, and limit, are settable directly as query builder methods and are described in the Modify Query Results section of this guide. We recommend that you use these methods instead of passing them as options.

クエリ結果の変更

このセクションには、クエリ結果の順序と形式を変更する次の関数のクエリビルダの例が含まれています。

フィールドの値で結果を並べ替える
指定された数の結果を省略する
結果にフィールドと配列値のサブセットを表示する
結果のページ分割

注文結果の例

次の例は、 orderBy()クエリビルダメソッドを使用して、 titleフィールドに指定されたフィルターに一致する結果をimdb.ratingの値で降順に配置する方法を示しています。

$result = DB::table('movies')
    ->where('title', 'like', 'back to the future%')
    ->orderBy('imdb.rating', 'desc')
    ->get();

[
  { "title": "Back to the Future", "imdb": { "rating":8.5,"votes":636511,"id":88763 }, ... },
  { "title": "Back to the Future Part II", "imdb": { "rating":7.8,"votes":292539,"id":96874 }, ... },
  { "title": "Back to the Future Part III", "imdb": {"rating":7.4,"votes":242390,"id":99088 }, ... },
  ...
]

指定した数の結果を省略する例

次の例では、 skip()クエリビルダメソッドを使用して、 titleフィールドに指定されたフィルターに一致する最初の 4 つの結果を除外する方法を示します。 year値の昇順でソートします。

$result = DB::table('movies')
    ->where('title', 'like', 'star trek%')
    ->orderBy('year', 'asc')
    ->skip(4)
    ->get();

結果の例に含まれるフィールドと配列値のサブセットの表示

次の例では、 project()クエリビルダメソッドを使用して、 8.5よりも高いimdb.rating値を含むドキュメントを照合し、次のフィールド値のみを返す方法を示します。

内の映画のタイトル title
cast配列フィールドの 2 番目から 4 番目の値（存在する場合）
ドキュメント_idフィールド（自動的に含まれる）

$result = DB::table('movies')
    ->where('imdb.rating', '>', 8.5)
    ->project([
        'title' => 1,
        'cast' => ['$slice' => [1, 3]],
    ])
    ->get();

[
  {
    "_id": { ... },
    "title": "City Lights"
    "cast": [
      "Florence Lee",
      "Harry Myers",
      "Al Ernest Garcia"
    ],
  },
  {
    "_id": { ... },
    "title": "Modern Times",
    "cast": [
      "Paulette Goddard",
      "Henry Bergman",
      "Tiny Sandford"
    ]
  },
  {
    "_id": { ... },
    "title": "Casablanca"
    "cast": [
      "Ingrid Bergman",
      "Paul Henreid",
      "Claude Rains"
    ],
  },
  ...
]

結果のページ分割の例

次の例では、 paginate()クエリビルダーメソッドを使用して、 movieコレクション全体を15ドキュメントの個別の結果セットに分割する方法を示します。この例には、 imdb.votesフィールドの結果を降順で配置するための並べ替え順序と、結果に特定のフィールドのみを含むプロジェクションも含まれています。

$resultsPerPage = 15;
$projectionFields = ['title', 'runtime', 'imdb.rating'];
$result = DB::table('movies')
    ->orderBy('imdb.votes', 'desc')
    ->paginate($resultsPerPage, $projectionFields);

ページネーションの詳細については、Lambda ドキュメントの「クエリビルダの結果のページ分割」を参照してください。

MongoDB 操作を使用したデータの取得

このセクションには、次の MongoDB 固有のクエリ操作の使用方法を示すクエリビルダの例が含まれています。

フィールドを含むドキュメントの一致
指定されたすべてのフィールドを含むドキュメントとの一致
配列内の特定の数の要素を含むドキュメントの一致
フィールドに特定のデータ型を含むドキュメントと一致させます。
計算された剰余値を含むドキュメントの一致
正規表現に一致するドキュメントの一致
MongoDB Query API 操作の実行
配列要素を含むドキュメントの一致
カーソルのタイムアウトを指定する
地理空間検索を使用してロケーションを照合します

フィールドの例が含まれています

次の例は、 exists()クエリビルダメソッドを使用して、フィールドrandom_reviewを含むドキュメントを一致させる方法を示しています。

$result = DB::table('movies')
    ->exists('random_review', true);

このクエリ演算子の詳細については、サーバーマニュアルの$existsを参照してください。

すべてのフィールドの例を含む

次の例は、 allクエリ演算子とwhere()クエリビルダメソッドを使用して、指定されたすべてのフィールドを含むドキュメントを照合する方法を示しています。

$result = DB::table('movies')
    ->where('movies', 'all', ['title', 'rated', 'imdb.rating'])
    ->get();

このクエリ演算子の詳細については、サーバーマニュアルの$allを参照してください。

配列サイズに一致する例

次の例は、 where()クエリビルダメソッドでsizeクエリ演算子を渡し、5 つの要素だけの配列を含むdirectorsフィールドを含むドキュメントを一致させる方法を示しています。

$result = DB::table('movies')
    ->where('directors', 'size', 5)
    ->get();

To learn more about this query operator, see $size in the Server manual.

一致データ型の例

次の例では、 where()クエリビルダメソッドでtypeクエリ演算子を渡し、 releasedフィールドに配列データ型に対応するタイプ4の値を含むドキュメントを照合する方法を示します。

$result = DB::table('movies')
    ->where('released', 'type', 4)
    ->get();

型コードとクエリ演算子の詳細については、サーバーマニュアルの$typeを参照してください。

剰余の例えで計算された値に一致

次の例は、 where()クエリビルダメソッドでmodクエリ演算子を渡し、 yearフィールドの偶数値に一致する式year % 2 == 0を使用してドキュメントを照合する方法を示しています。

$result = DB::table('movies')
    ->where('year', 'mod', [2, 0])
    ->get();

このクエリ演算子の詳細については、サーバーマニュアルの$modを参照してください。

正規表現に一致する

次の例は、 where()クエリビルダメソッドでREGEXクエリ演算子を渡し、指定された正規表現に一致するtitleフィールドを含むドキュメントを照合する方法を示しています。

$result = DB::connection('mongodb')
    ->table('movies')
    ->where('title', 'REGEX', new Regex('^the lord of .*', 'i'))
    ->get();

To learn more about regular expression queries in MongoDB, see $regex in the Server manual.

MongoDB Query API 操作の実行例

次の例は、 whereRaw()クエリビルダーメソッドを使用して、MongoDB Query API 構文を使用して記述されたクエリ操作を実行する方法を示しています。

$result = DB::table('movies')
    ->whereRaw([
        'imdb.votes' => ['$gte' => 1000 ],
        '$or' => [
            ['imdb.rating' => ['$gt' => 7]],
            ['directors' => ['$in' => [ 'Yasujiro Ozu', 'Sofia Coppola', 'Federico Fellini' ]]],
        ],
    ])->get();

次のコードは、同等の MongoDB Query API 構文を示しています。

db.movies.find({
  "imdb.votes": { $gte: 1000 },
  $or: [{
    imdb.rating: { $gt: 7 },
    directors: { $in: [ "Yasujiro Ozu", "Sofia Coppola", "Federico Fellini" ] }
}]});

To learn more about the MongoDB Query API, see MongoDB Query API in the Server manual.

配列要素の一致の例

次の例は、 where()クエリビルダメソッドでelemMatchクエリ演算子を渡し、指定されたクエリ内の条件の 1 つ以上に一致する配列要素を含むドキュメントを検索する方法を示しています。

$result = DB::table('movies')
    ->where('writers', 'elemMatch', ['$in' => ['Maya Forbes', 'Eric Roth']])
    ->get();

To learn more about regular expression queries in MongoDB, see the $elemMatch operator in the Server manual.

カーソルタイムアウトの指定の例

次の例では、 timeout()メソッドを使用してカーソル操作の完了まで待機する最大期間を指定する方法を示します。

$result = DB::table('movies')
    ->timeout(2) // value in seconds
    ->where('year', 2001)
    ->get();

注意

この設定では、ミリ秒ではなく秒単位でmaxTimeMS値を指定します。 maxTimeMS値の詳細については、PHP ライブラリのドキュメントのMongoDBCollection::find()を参照してください。

地理空間操作を使用したロケーションの一致

このセクションの例では、クエリビルダの構文を使用して GeoJSON または座標ペアデータに対して地理空間クエリを実行し、次のタイプのロケーションを検索できます。

位置の近く
GeoJSON オブジェクトの境界内
GeoJSON オブジェクトの交差
近くの一致の近接データ

重要

MongoDB で GeoJSON クエリを実行するには、コレクションに2dまたは2dsphereインデックスのいずれかを作成する必要があります。地理空間インデックスの作成方法については、「スキーマビルダ」のガイドの「地理空間インデックスの作成」セクションを参照してください。

To learn more about GeoJSON objects that MongoDB supports, see GeoJSON Objects in the Server manual.

位置の例えに近い

次の例は、 nearクエリ演算子とwhere()クエリビルダメソッドを使用して、GeoJSON ポイントオブジェクトから最大50メートルのロケーションを含むドキュメントを一致させる方法を示しています。

$results = DB::table('theaters')
    ->where('location.geo', 'near', [
        '$geometry' => [
            'type' => 'Point',
            'coordinates' => [
                -86.6423,
                33.6054,
            ],
        ],
        '$maxDistance' => 50,
    ])->get();

この演算子の詳細については、サーバーマニュアルの「 $near 演算子」を参照してください。

エリア内の例

次の例は、 geoWithinクエリ演算子とwhere()クエリビルダメソッドを使用して、指定されたPolygon GeoJSON オブジェクトの境界内のロケーションを含むドキュメントを照合する方法を示しています。

$results = DB::table('theaters')
    ->where('location.geo', 'geoWithin', [
        '$geometry' => [
            'type' => 'Polygon',
            'coordinates' => [
                [
                    [-72, 40],
                    [-74, 41],
                    [-72, 39],
                    [-72, 40],
                ],
            ],
        ],
    ])->get();

ジオメトリの交差の例

次の例は、 geoInstersectsクエリ演算子とwhere()クエリビルダメソッドを使用して、指定されたLineString GeoJSON オブジェクトと交差するロケーションを含むドキュメントを照合する方法を示しています。

$results = DB::table('theaters')
    ->where('location.geo', 'geoIntersects', [
        '$geometry' => [
            'type' => 'LineString',
            'coordinates' => [
                [-73.600525, 40.74416],
                [-72.600525, 40.74416],
            ],
        ],
    ])->get();

近傍一致の近接データの例

次の例では、 geoNear集計演算子とraw()クエリビルダメソッドを組み合わせて、各一致の近接性情報などのメタデータを返す集計を実行する方法を示します。

$results = DB::table('theaters')->raw(
    function (Collection $collection) {
        return $collection->aggregate([
            [
                '$geoNear' => [
                    'near' => [
                        'type' => 'Point',
                        'coordinates' => [-118.34, 34.10],
                    ],
                    'distanceField' => 'dist.calculated',
                    'maxDistance' => 500,
                    'includeLocs' => 'dist.location',
                    'spherical' => true,
                ],
            ],
        ]);
    },
)->toArray();

To learn more about this aggregation operator, see $geoNear operator in the Server manual.

MongoDB 書込み操作を使用したデータの書込み

このセクションには、次の MongoDB 固有の書込み操作の使用方法を示すクエリビルダの例が含まれています。

ドキュメントをアップサートする
数値の増加
数値の減算
配列要素を追加する
配列から値を削除する
ドキュメントからフィールドを削除する

ドキュメントのアップサートの例

v 4.7以降、次のクエリビルダのメソッドのいずれかを使用して、アップサート操作を実行できます。

upsert(): このメソッドを使用すると、バッチアップサートを実行して 1 回の操作で複数のドキュメントを変更または挿入できます。
update(): このメソッドを使用する場合、クエリフィルターに一致するすべてのドキュメントを更新するか、一致するドキュメントがない場合は 1 つのドキュメントを挿入するために、 upsertオプションを指定する必要があります。このアップサートメソッドのみが v 4.6以前のバージョンではサポートされています。

アップサートの方法

upsert(array $values, array|string $uniqueBy, array|null $update)クエリビルダのメソッドは次のパラメータを受け入れます。

$values: 更新または挿入するドキュメントを指定するフィールドと値の配列。
$uniqueBy: 最初の配列パラメータでドキュメントを一意に識別するフィールドのリスト。
$update: 一致するドキュメントが存在する場合に更新するフィールドの任意のリスト。このパラメーターを省略すると、Lambda 統合によってすべてのフィールドが更新されます。

以下の例では、 upsert()クエリビルダメソッドを使用して、次の手順に基づいてドキュメントを更新または挿入する方法を示しています。

titleフィールドの値が'Inspector Maigret' 、 recommendedフィールドの値がfalse 、 runtimeフィールドの値が128であるドキュメントを指定します。
titleフィールドの値が'Petit Maman' 、 recommendedフィールドの値がtrue 、 runtimeフィールドの値が72であるドキュメントを指定します。
titleフィールドが操作範囲内のドキュメントを一意に識別することを示します。
一致したドキュメントのrecommendedフィールドのみをアップデートします。

$result = DB::table('movies')
    ->upsert(
        [
            ['title' => 'Inspector Maigret', 'recommended' => false, 'runtime' => 128],
            ['title' => 'Petit Maman', 'recommended' => true, 'runtime' => 72],
        ],
        'title',
        'recommended',
    );

upsert()クエリビルダメソッドは、操作によって更新、挿入、変更されたドキュメントの数を返します。

注意

upsert() メソッドはイベントをtriggerしません。アップサート操作からイベントをtriggerするには、代わりに createOrFirst() メソッドを使用できます。

更新方法

次の例は、 update()クエリビルダーメソッドとupsertオプションを使用して一致するドキュメントをアップデートするか、存在しない場合は指定されたデータでドキュメントを挿入する方法を示しています。 upsertオプションをtrueに設定し、かつドキュメントが存在しない場合、コマンドはデータとwhere()クエリ操作で指定されたtitleフィールドと値の両方を挿入します。

$result = DB::table('movies')
    ->where('title', 'Will Hunting')
    ->update(
        [
            'plot' => 'An autobiographical movie',
            'year' => 1998,
            'writers' => [ 'Will Hunting' ],
        ],
        ['upsert' => true],
    );

update()クエリビルダメソッドは、操作によって更新または挿入されたドキュメントの数を返します。

数値の増加の例

次の例は、 increment()クエリビルダメソッドを使用して、一致したドキュメントのimdb.votesフィールドの値に3000を追加する方法を示しています。

$result = DB::table('movies')
    ->where('title', 'Field of Dreams')
    ->increment('imdb.votes', 3000);

increment()クエリビルダメソッドは、操作によって更新されたドキュメントの数を返します。

Lambda 統合 v 4.8以降また、 incrementEach()クエリビルダメソッドを使用して、1 回の操作で複数の値を増加させることもできます。 incrementEach()次の例では、awards.wins imdb.votesメソッドを使用して、一致したドキュメントのフィールドとフィールドの値を増やします。

$result = DB::table('movies')
    ->where('title', 'Lost in Translation')
    ->incrementEach([
        'awards.wins' => 2,
        'imdb.votes' => 1050,
    ]);

注意

値がないフィールド、または一致したドキュメントに存在しないフィールドをincrement()メソッドまたはincrementEach()メソッドに渡すと、これらのメソッドは指定されたフィールドを増分値に初期化します。

数値の減算の例

次の例は、 decrement()クエリビルダメソッドを使用して、一致したドキュメントのimdb.ratingフィールドの値から0.2を減算する方法を示しています。

$result = DB::table('movies')
    ->where('title', 'Sharknado')
    ->decrement('imdb.rating', 0.2);

decrement()クエリビルダメソッドは、操作によって更新されたドキュメントの数を返します。

Lambda 統合 v 4.8以降また、 decrementEach()クエリビルダメソッドを使用して、1 回の操作で複数の値を減算することもできます。 decrementEach()次の例では、metacritic imdb.ratingメソッドを使用して、一致したドキュメントのフィールドとフィールドの値を減らします。

$result = DB::table('movies')
    ->where('title', 'Dunkirk')
    ->decrementEach([
        'metacritic' => 1,
        'imdb.rating' => 0.4,
    ]);

注意

値がないフィールド、または一致したドキュメントに存在しないフィールドをdecrement()メソッドまたはdecrementEach()メソッドに渡すと、これらのメソッドは指定されたフィールドを減算値に初期化します。

配列要素を追加する例

次の例は、 push()クエリビルダメソッドを使用して、一致したドキュメントのcast配列フィールドに"Gary Cole"を追加する方法を示しています。

$result = DB::table('movies')
    ->where('title', 'Office Space')
    ->push('cast', 'Gary Cole');

push()クエリビルダメソッドは、操作によって更新されたドキュメントの数を返します。

配列要素の削除の例

次の例は、 pull()クエリビルダメソッドを使用して、クエリに一致するドキュメントのgenresフィールドから"Adventure"値を削除する方法を示しています。

$result = DB::table('movies')
    ->where('title', 'Iron Man')
    ->pull('genres', 'Adventure');

pull()クエリビルダメソッドは、操作によって更新されたドキュメントの数を返します。

フィールドを削除する例

次の例は、 unset()クエリビルダメソッドを使用して、クエリに一致するドキュメントからtomatoes.viewerフィールドと値を削除する方法を示しています。

$result = DB::table('movies')
    ->where('title', 'Final Accord')
    ->unset('tomatoes.viewer');

unset()クエリビルダメソッドは、操作によって更新されたドキュメントの数を返します。

戻る

スキーマビルダ

データベースとコレクション

クエリ ビルダ

Overview

始める前に

一致するドキュメントの取得

メソッドの例

論理条件演算

論理和の例

論理 AND の例

論理和の例

ネストされた論理演算子グループの例

範囲とタイプのチェック

数値範囲の例

NULL または欠損値の例

セットの 1 つ以上の値の例

一致日付の例

テキストパターン一致の例

whereLike() メソッドと whereNotLike() メソッド

Retrieve Distinct Values

集計

一般的なフィールド値でグループ化された結果の例

結果数の例

フィールド例の最大値

フィールドの例の最小値

フィールド例の平均値

フィールドの合計値の例

一致した結果の集計の例

クエリレベルのオプションを設定する

クエリ結果の変更

注文結果の例

指定した数の結果を省略する例

結果の例に含まれるフィールドと配列値のサブセットの表示

結果のページ分割の例

MongoDB 操作を使用したデータの取得

フィールドの例が含まれています

すべてのフィールドの例を含む

配列サイズに一致する例

一致データ型の例

剰余の例えで計算された値に一致

正規表現に一致する

MongoDB Query API 操作の実行例

配列要素の一致の例

カーソル タイムアウトの指定の例

地理空間操作を使用したロケーションの一致

位置の例えに近い

エリア内の例

ジオメトリの交差の例

近傍一致の近接データの例

MongoDB 書込み操作を使用したデータの書込み

ドキュメントのアップサートの例

アップサートの方法

更新方法

数値の増加の例

数値の減算の例

配列要素を追加する例

配列要素の削除の例

フィールドを削除する例

クエリビルダ

カーソルタイムアウトの指定の例