Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.
Docs Menu

Retrieve Data

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.

The examples in this guide use the companies collection in the sample_training database from the Atlas sample datasets. To access this collection from your PHP application, instantiate a MongoDB\Client that connects to an Atlas cluster and assign the following value to your $collection variable:

$collection = $client->sample_training->companies;

Para aprender a crear una implementación gratuita de MongoDB y cargar los conjuntos de datos de muestra, consulta la guía Introducción de MongoDB.

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.

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;

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;
}

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

El número máximo de documentos dentro de cada agrupar devuelto en un resultado de query. Por defecto, el comando find tiene un tamaño de agrupar inicial de 101 documento y un tamaño máximo de 16 mebibytes (MiB) para cada agrupar posterior. Esta opción puede aplicar un límite menor que 16 MiB, pero no uno mayor. Si establece batchSize en un límite que da como resultado agrupar más grandes que 16 MiB, esta opción no tiene ningún efecto.
Tipo: integer

collation

La intercalación que se utilizará para la operación. El valor predeterminado es la intercalación especificada para la colección. Para obtener más información, consulte la sección Intercalación de esta página.
Tipo: array|object

comment

El comentario que se va a adjuntar a la operación.
Tipo: cualquier tipo BSON

cursorType

El tipo de cursor a utilizar para la operación. El valor por defecto es MongoDB\Operation\Find::NON_TAILABLE.
Tipo: MongoDB\Operation\Find

limit

El número máximo de documentos que la operación puede devolver.
Tipo: integer

skip

El número de documentos que se deben omitir antes de devolver resultados.
Tipo: integer

sort

El orden en que la operación devuelve los documentos coincidentes.
Tipo: array|object

typeMap

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.
Tipo: array

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().

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

(Opcional) Especifica si se debe incluir la comparación de mayúsculas y minúsculas.

Cuando se establece en true, el comportamiento de comparación depende del valor del campo strength:

- Si strength es 1, la librería PHP compara los caracteres base
y las mayúsculas y minúsculas.

- Si strength es 2, la librería PHP compara los caracteres base,
los signos diacríticos, otras diferencias secundarias y las mayúsculas y minúsculas.

- Si strength es cualquier otro valor, este campo se ignora.

Cuando se establece en false, la librería PHP no incluye la comparación de mayúsculas y minúsculas en el nivel de intensidad 1 o 2.

Tipo de dato: bool
Por defecto: false

caseFirst

(Opcional) Especifica el orden de clasificación de las diferencias de mayúsculas y minúsculas durante las comparaciones de nivel terciario.

Tipo de dato: string
Por defecto: "off"

strength

(Optional) Specifies the level of comparison to perform, as defined in the ICU documentation.

Data Type: int
Default: 3

numericOrdering

(Opcional) Especifica si el controlador compara las cadenas numéricas como números.

Si true se establece en, la biblioteca PHP compara las cadenas numéricas como números. Por ejemplo, al comparar las cadenas ""10y2 "", la biblioteca utiliza los valores numéricos de las cadenas y trata10 "" como mayor que2 "".

Si false se establece en, la biblioteca PHP compara las cadenas numéricas como cadenas. Por ejemplo, al comparar las cadenas10 "" y2 "", la biblioteca compara un carácter a la vez y trata10 "" como menor que2 "".

Para obtener más información, consulte Restricciones de intercalación en el manual del servidor MongoDB.

Tipo de datos: bool
Predeterminado: false

alternate

(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.

Tipo de dato: string
Por defecto: "non-ignorable"

maxVariable

(Opcional) Especifica qué caracteres considera la librería ignorables cuando el campo alternate se establece en "shifted".

Tipo de dato: string
Por defecto: "punct"

backwards

(Opcional) Especifica si las strings que contienen diacríticos se ordenan de atrás hacia adelante en la string.

Tipo de dato: bool
Por defecto: 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: