Desarrollador de query

Ejemplo de método Where

El siguiente ejemplo muestra cómo usar el método de creación de consultas where() para recuperar documentos de la colección movies que contienen un valor de campo imdb.rating de exactamente 9.3. Haga clic en el botón VIEW OUTPUT Botón para ver los resultados devueltos por la consulta:

$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.",
      ...
   }
]

Operaciones condicionales lógicas

Los ejemplos de esta sección muestran la sintaxis del generador de consultas que puede utilizar para realizar las siguientes operaciones condicionales lógicas:

• OR lógico para que coincida con una o más condiciones

• AND lógico para que coincida con todas las condiciones

• NO lógico para que coincida con la negación de la condición

• Grupos de operadores lógicos anidados

$result = DB::connection('mongodb')
    ->table('movies')
    ->where('id', new ObjectId('573a1398f29313caabce9682'))
    ->orWhere('title', 'Back to the Future')
    ->get();

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

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

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

Rangos y comprobaciones de tipo

Los ejemplos de esta sección muestran la sintaxis del generador de consultas que puede utilizar para hacer coincidir valores mediante las siguientes consultas de rango y operaciones de verificación de tipo:

• Valores dentro de un rango numérico

• Valores nulos o ausentes

• Uno o más valores de un conjunto

• Fechas de los partidos

• Coincidir con un patrón de texto

$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 }, ... },
   ...
]

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

$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, ... },
   ...
]

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

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

Ejemplo de coincidencia de patrones de texto

El siguiente ejemplo muestra cómo utilizar el operador de consulta like con el método de generación de consultas where() para recuperar documentos de la colección movies mediante un patrón de texto especificado.

Los patrones de texto pueden contener texto mezclado con los siguientes caracteres comodín:

• % que coincide con cero o más caracteres

• _ que coincide con un solo carácter

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

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

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

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

Retrieve Distinct Values

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas distinct() para recuperar todos los diferentes valores del campo year para los documentos en las colecciones movies.

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

Ejemplo de resultados agrupados por valores de campo comunes

El siguiente ejemplo muestra cómo usar el método del generador de consultas groupBy() para recuperar datos de documentos agrupados por valores compartidos del campo runtime. Este ejemplo encadena las siguientes operaciones para buscar documentos de la colección movies que contengan un valor rated de G e incluyan el campo title de una película por cada valor runtime distinto:

• Coincidir únicamente con documentos que contengan un valor de campo rated de "G" mediante el método where()

• Agrupe los datos por los valores distintos del campo runtime, al que se le asigna el campo _id, utilizando el método groupBy()

• Ordene los grupos por el campo runtime utilizando el método orderBy()

• Devuelve title datos del último documento en el resultado agrupado especificándolo en el método get()

$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"
   },
   ...
]

Ejemplo de número de resultados

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas count() para devolver la cantidad de documentos contenidos en la colección movies:

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

Ejemplo de valor máximo de un campo

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas max() para devolver el valor numérico más alto del campo runtime de toda la colección movies:

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

Ejemplo de valor mínimo de un campo

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas min() para devolver el valor numérico más bajo del campo year de toda la colección movies:

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

Ejemplo de valor promedio de un campo

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas avg() para devolver el promedio numérico, o media aritmética, de los valores imdb.rating de toda la colección movies.

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

Ejemplo de valor sumado de un campo

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas sum() para devolver el total numérico de los valores imdb.votes de toda la colección movies:

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

Ejemplo de resultados coincidentes agregados

El siguiente ejemplo muestra cómo agregar datos de los resultados que coinciden con una consulta. La consulta busca todas las películas posteriores al año 2000 y calcula el valor promedio de imdb.rating de esas coincidencias mediante el método avg():

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

Ejemplo de resultados de pedidos

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas orderBy() para organizar los resultados que coinciden con el filtro especificado en el campo title por el valor imdb.rating en orden descendente:

$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 }, ... },
  ...
]

Ejemplo de omitir un número específico de resultados

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas skip() para omitir los primeros cuatro resultados que coinciden con el filtro especificado en el campo title, ordenados por el valor year en orden ascendente:

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

Mostrar un subconjunto de campos y valores de matriz en el ejemplo de resultados

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas project() para hacer coincidir documentos que contienen un valor imdb.rating mayor que 8.5 y devolver solo los siguientes valores de campo:

• Título de la película en el title

• Del segundo al cuarto valor del campo de matriz cast, si existen

• Campo de documento _id, que se incluye automáticamente

$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"
    ],
  },
  ...
]

Ejemplo de paginación de resultados

El siguiente ejemplo muestra cómo utilizar el método generador de consultas paginate() para dividir toda la colección movie en conjuntos de resultados independientes de 15 documentos. El ejemplo también incluye un orden de clasificación para organizar los resultados por el campo imdb.votes en orden descendente y una proyección que incluye sólo campos específicos en los resultados.

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

Para obtener más información sobre la paginación, consulte Paginar los resultados del generador de consultas en la documentación de Laravel.

Contiene un ejemplo de campo

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas exists() para hacer coincidir documentos que contienen el campo random_review:

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

Para obtener más información sobre este operador de consulta, consulte $exists en el manual del servidor.

Contiene ejemplo de todos los campos

El siguiente ejemplo muestra cómo utilizar el operador de consulta all con el método de generación de consultas where() para hacer coincidir documentos que tienen un campo de matriz writers que contiene todos los valores especificados:

$result = DB::table('movies')
    ->where('writers', 'all', ['Ben Affleck', 'Matt Damon'])
    ->get();

Para obtener más información sobre este operador de consulta, consulte $all en el manual del servidor.

Ejemplo de tamaño de matriz coincidente

El siguiente ejemplo muestra cómo pasar el operador del query size con el método de generador de query where() para hacer coincidir documentos que contengan un campo directors que contenga un arreglo de exactamente cinco elementos:

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

Para obtener más información sobre este operador de consulta, consulte $size en el manual del servidor.

Ejemplo de tipo de datos de coincidencia

El siguiente ejemplo muestra cómo pasar el operador de consulta type con el método de generación de consultas where() para hacer coincidir documentos que contienen un valor de tipo 4, que corresponde a un tipo de datos de matriz, en el campo released.

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

Para obtener más información sobre los códigos de tipo y el operador de consulta, consulte $type en el manual del servidor.

Ejemplo de coincidencia de un valor calculado con módulo

El siguiente ejemplo muestra cómo pasar el operador del query mod con el método where() del generador de query para coincidir documentos utilizando la expresión year % 2 == 0, que coincide con los valores pares del campo year:

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

Para aprender más sobre este operador del query, consulta $mod en el manual del servidor.

Coincidir una expresión regular

El siguiente ejemplo muestra cómo pasar el operador de consulta REGEX con el método de generación de consultas where() para hacer coincidir documentos que contienen un campo title que coincide con la expresión regular especificada:

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

Para obtener más información sobre las consultas de expresiones regulares en MongoDB, consulte $regex en el manual del servidor.

Ejemplo de ejecución de operaciones de la API de consulta de MongoDB

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas whereRaw() para ejecutar una operación de consulta escrita mediante la sintaxis de la API de consultas de MongoDB:

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

El siguiente código muestra la sintaxis equivalente de la API de consulta de MongoDB:

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

Para obtener más información sobre la API de consulta de MongoDB, consulte API de consulta de MongoDB en el manual del servidor.

Ejemplo de elementos de una matriz de coincidencias

El siguiente ejemplo muestra cómo pasar el operador de consulta elemMatch con el método de generación de consultas where() para hacer coincidir documentos que contienen un elemento de matriz que coincide con al menos una de las condiciones en la consulta especificada:

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

Para obtener más información sobre las consultas de expresiones regulares en MongoDB, consulte el operador $elemMatch en el manual del servidor.

Ejemplo de especificación del tiempo de espera del cursor

El siguiente ejemplo muestra cómo utilizar el método timeout() para especificar una duración máxima de espera para que se completen las operaciones del cursor.

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

Ejemplo de especificar una preferencia de lectura

Puede controlar cómo la integración de Laravel dirige las operaciones de lectura a los miembros del conjunto de réplicas configurando una preferencia de lectura.

El siguiente ejemplo consulta la colección movies para encontrar documentos cuyo valor runtime sea mayor que 240. El ejemplo pasa el valor ReadPreference::SECONDARY_PREFERRED al método readPreference(), que envía la consulta a los miembros secundarios del conjunto de réplicas o al miembro principal si no hay secundarios disponibles:

$result = DB::table('movies')
    ->where('runtime', '>', 240)
    ->readPreference(ReadPreference::SECONDARY_PREFERRED)
    ->get();

Coincidir ubicaciones mediante operaciones geoespaciales

Los ejemplos de esta sección muestran la sintaxis del generador de consultas que puede utilizar para realizar consultas geoespaciales en GeoJSON o datos de pares de coordenadas para recuperar los siguientes tipos de ubicaciones:

• Cerca de una posición

• Dentro del límite de un objeto GeoJSON

• Intersección de un objeto GeoJSON

• Datos de proximidad para coincidencias cercanas

Para obtener más información sobre los objetos GeoJSON que admite MongoDB, consulte Objetos GeoJSON en el manual del servidor.

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

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

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

$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();

Ejemplo de insertar un documento

A partir de la versión v4.7, puede realizar una operación de upsert utilizando cualquiera de los siguientes métodos de generación de consultas:

• upsert():Cuando utiliza este método, puede realizar una inserción y actualización por lotes para cambiar o insertar varios documentos en una sola operación.

• update()Al usar este método, debe especificar la opción upsert para actualizar todos los documentos que coincidan con el filtro de consulta o insertar un documento si no hay coincidencias. Este método upsert solo es compatible con las versiones v4.6 y anteriores.

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

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

Ejemplo de multiplicar y dividir valores numéricos

A partir de Laravel Integration v5.5, puede realizar operaciones de multiplicación y división en valores numéricos utilizando los métodos de generación de consultas multiply() y divide().

El siguiente ejemplo muestra cómo utilizar los métodos multiply() y divide() para manipular los valores de los campos imdb.votes y runtime:

$result = DB::table('movies')
    ->where('year', 2001)
    ->multiply('imdb.votes', 5);
$result = DB::table('movies')
    ->where('year', 2001)
    ->divide('runtime', 2);

Opcionalmente, puede pasar un parámetro de matriz para realizar una actualización $set en la misma operación, como se muestra en el siguiente ejemplo:

$result = DB::table('movies')
    ->where('year', 1958)
    ->multiply('runtime', 1.5, ['note' => 'Adds recovered footage.']);

Ejemplo de incremento de un valor numérico

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas increment() para agregar 3000 al valor del campo imdb.votes en el documento coincidente:

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

El método de generación de consultas increment() devuelve la cantidad de documentos que la operación actualizó.

A partir de Laravel Integration v4.8, también se puede usar el método incrementEach() del generador de consultas para incrementar varios valores en una sola operación. El siguiente ejemplo usa el método incrementEach() para incrementar los valores de los campos awards.wins y imdb.votes en el documento coincidente:

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

Ejemplo de decremento de un valor numérico

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas decrement() para restar 0.2 del valor del campo imdb.rating en el documento coincidente:

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

El método de generación de consultas decrement() devuelve la cantidad de documentos que la operación actualizó.

A partir de la integración de Laravel v4.8, también se puede utilizar el método generador de consultas decrementEach() para disminuir varios valores en una sola operación. El siguiente ejemplo emplea el método decrementEach() para reducir los valores de los campos metacritic y imdb.rating en el documento emparejado:

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

Ejemplo de agregar un elemento de matriz

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas push() para agregar "Gary Cole" al campo de matriz cast en el documento coincidente:

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

El método de generación de consultas push() devuelve la cantidad de documentos que la operación actualizó.

Ejemplo de eliminar un elemento de matriz

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas pull() para eliminar el valor "Adventure" del campo genres del documento que coincide con la consulta:

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

El método de generación de consultas pull() devuelve la cantidad de documentos que la operación actualizó.

Ejemplo de eliminar un campo

El siguiente ejemplo muestra cómo utilizar el método de generación de consultas unset() para eliminar el campo y el valor tomatoes.viewer del documento que coincide con la consulta:

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

El método de generación de consultas unset() devuelve la cantidad de documentos que la operación actualizó.