Join us at MongoDB.local London on 7 May to unlock new possibilities for your data. Use WEB50 to save 50%.
Register now >
Docs Menu
Docs Home
/ /

Retrieve Data

En esta guía, puedes aprender a utilizar la Biblioteca PHP de MongoDB para recuperar datos de una colección de MongoDB utilizando operaciones de lectura. Puedes llamar a la MongoDB\Collection::find() o el método MongoDB\Collection::findOne() en una colección para recuperar documentos que coincidan con un conjunto de criterios.

Los ejemplos de esta guía usan la colección companies en la base de datos sample_training de la Conjuntos de datos de muestra de Atlas. Para acceder a esta colección desde tu aplicación PHP, instancie un MongoDB\Client que se conecte a un clúster de Atlas y asigne 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.

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 acerca de los filtros de query, consulte la Guía 'Especificar una query' .

Para encontrar un solo documento en una colección, llame al método MongoDB\Collection::findOne() y pase un filtro de consulta 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 consulta coincide con más de un documento, el findOne() método devuelve el primer documento coincidente de 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.

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([]);

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

batchSize

The maximum number of documents within each batch returned in a query result. By default, the find command has an initial batch size of 101 documents and a maximum size of 16 mebibytes (MiB) for each subsequent batch. This option can enforce a smaller limit than 16 MiB, but not a larger one. If you set batchSize to a limit that results in batches larger than 16 MiB, this option has no effect.
Type: integer

collation

The collation to use for the operation. The default value is the collation specified for the collection. To learn more, see the Collation section of this page.
Type: array|object

comment

The comment to attach to the operation.
Type: any BSON type

cursorType

The type of cursor to use for the operation. The default value is MongoDB\Operation\Find::NON_TAILABLE.
Type: MongoDB\Operation\Find

limit

The maximum number of documents the operation can return.
Type: integer

skip

The number of documents to skip before returning results.
Type: integer

sort

The order in which the operation returns matching documents.
Type: array|object

typeMap

The type map to apply to cursors, which determines how BSON documents are converted to PHP values. The default value is the collection's type map.
Type: array

El siguiente ejemplo utiliza el método find() para buscar todos los documentos cuyo campo number_of_employees tenga 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 para los parámetros findOne() y find().

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

locale

(Required) Specifies the International Components for Unicode (ICU) locale. For a list of supported locales, see Collation Locales and Default Parameters in the MongoDB Server manual.

Data Type: string

caseLevel

(Optional) Specifies whether to include case comparison.

When set to true, the comparison behavior depends on the value of the strength field:

- If strength is 1, the PHP library compares base
characters and case.

- If strength is 2, the PHP library compares base
characters, diacritics, other secondary differences, and case.

- If strength is any other value, this field is ignored.

When set to false, the PHP library doesn't include case comparison at strength level 1 or 2.

Data Type: bool
Default: false

caseFirst

(Optional) Specifies the sort order of case differences during tertiary level comparisons.

Data Type: string
Default: "off"

strength


Data Type: int
Default: 3

numericOrdering

(Optional) Specifies whether the driver compares numeric strings as numbers.

If set to true, the PHP library compares numeric strings as numbers. For example, when comparing the strings "10" and "2", the library uses the strings' numeric values and treats "10" as greater than "2".

If set to false, the PHP library compares numeric strings as strings. For example, when comparing the strings "10" and "2", the library compares one character at a time and treats "10" as less than "2".

For more information, see Collation Restrictions in the MongoDB Server manual.

Data Type: bool
Default: false

alternate

(Optional) Specifies whether the library considers whitespace and punctuation as base characters for comparison purposes.

Data Type: string
Default: "non-ignorable"

maxVariable

(Optional) Specifies which characters the library considers ignorable when the alternate field is set to "shifted".

Data Type: string
Default: "punct"

backwards

(Optional) Specifies whether strings containing diacritics sort from the back of the string to the front.

Data Type: bool
Default: false

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.

Para obtener más información sobre los filtros de query, consulta la guía Especificar una consulta.

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:

Volver

Insertar documentos

En esta página