Overview
En esta guía, puede aprender cómo usar la librería PHP de MongoDB para recuperar datos de una colección de MongoDB utilizando operaciones de lectura. Se puede llamar al método MongoDB\Collection::find() o MongoDB\Collection::findOne() en una colección para recuperar documentos que coincidan con un conjunto de criterios.
Datos de muestra
Los ejemplos de esta guía utilizan la colección companies en la base de datos sample_training de los conjuntos de datos de muestra de Atlas. Para acceder a esta colección desde tu aplicación PHP, instancia un MongoDB\Client que se conecte a un clúster Atlas y asigna el siguiente valor a tu variable $collection:
$collection = $client->sample_training->companies;
Para saber cómo crear una implementación gratuita de MongoDB y cargar los conjuntos de datos de ejemplo, consulta la guía MongoDB Primeros Pasos.
Buscar documentos
La librería PHP de MongoDB incluye dos métodos para recuperar documentos de una colección: MongoDB\Collection::findOne() y MongoDB\Collection::find(). Estos métodos usan un filtro de query y devuelven uno o más documentos coincidentes. Un filtro de query especifica los criterios de búsqueda que utiliza el driver para recuperar documentos en tu query.
Tip
Para obtener más información sobre los filtros de query, consulta la guía Especificar una consulta.
Encuentre un documento
Para encontrar un solo documento en una colección, llama al método MongoDB\Collection::findOne() y pasa un filtro de query que especifique los criterios del documento que desea encontrar.
El método findOne() devuelve un valor array, object o null. Si el filtro de query coincide con un documento, el método devuelve una instancia array|object que contiene el documento. El tipo de retorno depende del valor de la opción typeMap. Si el filtro de query no coincide con ningún documento, el método devuelve null.
Tip
Para obtener más información sobre las opciones de findOne(), con cosas como typeMap, consulte la sección Modificar comportamiento de búsqueda de esta guía.
Si el filtro de query coincide con más de un documento, el método findOne() retorna el primer documento coincidente entre los resultados recuperados.
El siguiente ejemplo utiliza el método findOne() para encontrar el primer documento en el que el campo name tiene el valor 'LinkedIn':
$document = $collection->findOne(['name' => 'LinkedIn']); echo json_encode($document), PHP_EOL;
{"_id":{"$oid":"..."},"name":"LinkedIn","permalink":"linkedin","crunchbase_url": "http:\/\/www.crunchbase.com\/company\/linkedin","homepage_url":"http:\/\/linkedin.com", ... }
Tip
Orden de clasificación
El método findOne() devuelve el primer documento en orden natural en el disco si no se especifica ningún criterio de ordenación.
Encuentra varios documentos
Para encontrar varios documentos en una colección, pasar un filtro de query al método MongoDB\Collection::find() que especifique los criterios de los documentos que desea recuperar.
El siguiente ejemplo utiliza el método find() para encontrar todos los documentos en los que el campo founded_year tiene el valor 1970:
$results = $collection->find(['founded_year' => 1970]);
El método find() devuelve una instancia de MongoDB\Driver\Cursor, la cual puedes iterar para ver los documentos coincidentes. Un cursor es un mecanismo que permite a una aplicación iterar sobre los resultados de una base de datos mientras mantiene en memoria solo un subconjunto de ellos en un momento dado. Los cursores son útiles cuando tu método find() devuelve una gran cantidad de documentos.
Puedes iterar sobre los documentos en un cursor utilizando un bucle foreach, como se muestra en el siguiente ejemplo:
foreach ($results as $doc) { echo json_encode($doc), PHP_EOL; }
{"_id":{"$oid":"..."},"name":"Mitsubishi Motors","permalink":"mitsubishi-motors", "crunchbase_url":"http:\/\/www.crunchbase.com\/company\/mitsubishi-motors", ... } {"_id":{"$oid":"..."},"name":"Western Digital","permalink":"western-digital", "crunchbase_url":"http:\/\/www.crunchbase.com\/company\/western-digital", ... } {"_id":{"$oid":"..."},"name":"Celarayn","permalink":"celarayn","crunchbase_url": "http:\/\/www.crunchbase.com\/company\/celarayn", ... }
Nota
Encuentre todos los documentos
Para encontrar todos los documentos en una colección, pasa un filtro vacío al método find():
$cursor = $collection->find([]);
Modificar el comportamiento de búsqueda
Puedes modificar el comportamiento de los métodos MongoDB\Collection::find() y MongoDB\Collection::findOne() pasando un arreglo que especifique los valores de opciones como parámetro. La siguiente tabla describe algunas opciones que puedes configurar en el arreglo:
Opción | Descripción |
|---|---|
| El número máximo de documentos dentro de cada agrupar devuelto en un resultado de query. Por defecto, el comando |
| La intercalación que se utilizará para la operación. El valor por defecto es la intercalación especificada para la colección. Para aprender más, consulte la sección Intercalación de esta página. |
| El comentario que se adjuntará a la operación. |
| El tipo de cursor a utilizar para la operación. El valor por defecto es |
| Número máximo de documentos que puede devolver la operación. |
| El número de documentos que se deben omitir antes de devolver resultados. |
| El orden en que la operación devuelve los documentos coincidentes. |
| El mapa de tipos que se debe aplicar a los cursores, lo que determina cómo se convierten los documentos BSON en valores PHP. El valor por defecto es el mapa de tipos de la colección. |
El siguiente ejemplo usa el método find() para encontrar todos los documentos en los que el campo number_of_employees tiene el valor 1000. El ejemplo utiliza la opción limit para devolver un máximo de 5 resultados:
$results = $collection->find( ['number_of_employees' => 1000], ['limit' => 5], ); foreach ($results as $doc) { echo json_encode($doc), PHP_EOL; }
Para obtener una lista completa de opciones, consulte la documentación de la API de los parámetros findOne() y find().
Intercalación
Para especificar una intercalación para tu operación, pasa un parámetro arreglo $options que establezca la opción collation en el método de la operación. Asigna la opción collation a un arreglo que configure las reglas de intercalación.
La siguiente tabla describe los campos que se pueden configurar para la intercalación:
Campo | Descripción |
|---|---|
| (Obligatorio) Especifica la configuración regional de Componentes Internacionales para Unicode (ICU). Para obtener una lista de las configuraciones regionales compatibles, consulte Configuraciones regionales de intercalación y parámetros predeterminados en el manual del servidor MongoDB. |
| (Opcional) Especifica si se debe incluir la comparación de mayúsculas y minúsculas. |
| (Opcional) Especifica el orden de clasificación de las diferencias entre casos durante las comparaciones de nivel terciario. |
| (Opcional) Especifica el nivel de comparación a realizar, tal como se define en la documentación de la UCI. |
| (Opcional) Especifica si el driver compara las strings numéricas como números. |
| (Opcional) Especifica si la librería considera los espacios en blanco y la puntuación como caracteres base a los efectos de la comparación. |
| (Opcional) Especifica qué caracteres considera la biblioteca ignorables cuando el |
| (Opcional) Especifica si las cadenas que contienen diacríticos se ordenan desde el final de la cadena hacia el principio. |
Para obtener más información sobre la intercalación y los posibles valores de cada campo, consulta la entrada Collation en el manual del servidor de MongoDB.
Información Adicional
Para obtener más información sobre los filtros de query, consulta la guía Especificar una consulta.
Documentación de la API
Para obtener más información sobre cualquiera de los métodos mencionados en esta guía, consulta la siguiente documentación de la API: