/ /

Contabilizar documentos

Overview

En esta guía, aprenderá a usar la biblioteca PHP de MongoDB para obtener un recuento preciso y estimado del número de documentos en una colección. Los siguientes métodos cuentan los documentos en una colección:

MongoDB\Collection::countDocuments(): Devuelve el número exacto de documentos que coinciden con un filtro de consulta o que existen en una colección
MongoDB\Collection::estimatedDocumentCount(): Devuelve el número estimado de documentos en una colección

Datos de muestra

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.

Recupera un recuento preciso

Utiliza el método MongoDB\Collection::countDocuments() para contar la cantidad de documentos en una colección. Para contar la cantidad de documentos que cumplen con criterios de búsqueda específicos, pasa un filtro de query al método countDocuments().

Para obtener más información sobre cómo especificar una query, consulte el Guía 'Especificar una query' .

Contar todos los documentos

Para devolver un recuento de todos los documentos de la colección, pase una matriz de filtro de consulta vacía al método countDocuments(), como se muestra en el siguiente ejemplo:

$result = $collection->countDocuments([]);
echo 'Number of documents: ', $result;

Number of documents: 9500

Documentos específicos del recuento

Para devolver un recuento de documentos que coinciden con criterios de búsqueda específicos, pasa un filtro de query al método countDocuments().

El siguiente ejemplo cuenta la cantidad de documentos en los que el valor del campo founded_year es 2010:

$result = $collection->countDocuments(['founded_year' => 2010]);
echo 'Number of companies founded in 2010: ', $result;

Number of companies founded in 2010: 33

Personalizar el comportamiento del conteo

Puedes modificar el comportamiento del método countDocuments() pasando un arreglo que especifique valores de opciones. La siguiente tabla describe algunas opciones que puedes configurar para personalizar la operación de conteo:

Opción	Descripción
`collation`	The collation to use for the operation. To learn more, see the Collation section of this page. Type: `array\|object`
`hint`	The index to use for the operation. Type: `string\|array\|object`
`comment`	The comment to attach to the operation. Type: any valid BSON type
`limit`	The maximum number of documents to count. This value must be a positive integer. Type: `integer`
`maxTimeMS`	The maximum amount of time in milliseconds that the operation can run. Type: `integer`
`skip`	The number of documents to skip before counting documents. Type: `integer`
`readPreference`	The read preference to use for the operation. To learn more, see Read Preference in the Server manual. Type: `MongoDB\Driver\ReadPreference`

El siguiente ejemplo utiliza el método countDocuments() para contar el número de documentos en los que el campo number_of_employees tiene el valor 50 e instruye a la operación a contar un máximo de 100 resultados:

$result = $collection->countDocuments(
    ['number_of_employees' => 50],
    ['limit' => 100],
);
echo 'Number of companies with 50 employees: ', $result;

Number of companies with 50 employees: 100

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
`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`	(Optional) Specifies the level of comparison to perform, as defined in the ICU documentation. 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.

Recuperar un conteo estimado

Puede recuperar una estimación de la cantidad de documentos en una colección llamando al método MongoDB\Collection::estimatedDocumentCount(). El método estima la cantidad de documentos en función de los metadatos de la colección, lo que podría ser más rápido que realizar un recuento exacto.

El siguiente ejemplo estima el número de documentos en una colección:

$result = $collection->estimatedDocumentCount();
echo 'Estimated number of documents: ', $result;

Estimated number of documents: 9500

Personalizar el comportamiento del recuento estimado

Puede modificar el comportamiento del método estimatedDocumentCount() al pasar un arreglo que especifique valores de opción como parámetro. La siguiente tabla describe las opciones que puedes establecer en el arreglo:

Opción	Descripción
`comment`	The comment to attach to the operation. Type: any valid BSON type
`maxTimeMS`	The maximum amount of time in milliseconds that the operation can run. Type: `integer`
`readConcern`	The read concern to use for the operation. To learn more, see Read Concern in the Server manual. Type: `MongoDB\Driver\ReadConcern`
`readPreference`	The read preference to use for the operation. To learn more, see Read Preference in the Server manual. Type: `MongoDB\Driver\ReadPreference`
`session`	The client session to associate with the operation. Type: `MongoDB\Driver\Session`

El siguiente ejemplo usa el método estimatedDocumentCount() para devolver una estimación del número de documentos en la colección y establece un tiempo de espera de 1000 milisegundos en la operación:

$result = $collection->estimatedDocumentCount(['maxTimeMS' => 1000]);
echo 'Estimated number of documents: ', $result;

Estimated number of documents: 9500

Documentación de la API

Para aprender más sobre cualquiera de los métodos o tipos analizados en esta guía, consulta la siguiente documentación de API:

Volver

Especifica un query

Valores únicos de campo