sh.shardCollection() (método mongosh)

Definición

sh.shardCollection(namespace, key, unique, options)

Fragmenta una colección usando key como Clave de fragmento. La clave de fragmento determina cómo MongoDB distribuye los documentos de la colección entre los fragmentos.

Nota

Cambiado en la versión 6.0.

A partir de MongoDB,6.0 para fragmentar una colección no es necesario ejecutar primero el sh.enableSharding() método para configurar la base de datos.

Importante

Método mongosh

Esta página documenta una mongosh Método. Esta no es la documentación para comandos de base de datos ni para controladores específicos del lenguaje, como Node.js.

Para el comando de base de datos, consulta el comando shardCollection.

Para los drivers de API de MongoDB, consulte la documentación del driver de MongoDB específica del lenguaje.

sh.shardCollection() toma los siguientes argumentos:

Parameter	Tipo	Descripción
`namespace`	string	El espacio de nombres de la colección que se va a fragmentar en el `"<database>.<collection>"` formato.
`key`	Documento	El documento que especifica el campo o los campos que se utilizarán como clave de fragmento. `{ <field1>: <1\|"hashed">, ... }` Establezca el valor del campo en: `1` para fragmentación basada en rangos `"hashed"` para especificar una clave de fragmento con hash. La clave defragmento debe ser compatible con un índice. A menos que la colección esté vacía, el índice debe existir antes del `shardCollection` comando. Si la colección está vacía, MongoDB crea el índice antes de fragmentarla si el índice compatible con la clave de fragmento aún no existe. Véase también Índices de claves de fragmentos
`unique`	booleano	Opcional. Especifique `true` para garantizar que el índice subyacente aplique una restricción única. El valor predeterminado es `false`. No se puede especificar `true` cuando se utilizan claves de fragmentos con hash. Para Legacy Mongo Shell, debe especificar explícitamente el valor de `unique` si especifica el `options` documento. no`mongosh` requiere `unique` cuando especifica el `options` documento.
`options`	Documento	Opcional. Un documento que contiene campos opcionales, incluido `collation`.

El argumento options admite las siguientes opciones:

Parameter	Tipo	Descripción
`collation`	Documento	Opcional. Si la colección especificada en `shardCollection` tiene una intercalación predeterminada,debe incluir un documento de intercalación con ``{locale: "simple" }``; de lo contrario, el `shardCollection` comando fallará. Al menos uno de los índices cuyos campos admitan el patrón de clave de fragmento debe tener la intercalación simple.
presplitHashedZones	booleano	Opcional. Especifique `true` para crear y distribuir fragmentos iniciales para una colección vacía o inexistente, según las zonas y los rangos de zonas definidos para la colección. Solo para fragmentación con hash. `shardCollection()` con `presplitHashedZones: true` devuelve un error si alguna de las siguientes condiciones es verdadera: La clave de fragmento no contiene un campo hash (es decir, no es un índice hash de campo único o un índice hash compuesto). La colección no tiene zonas o rangos de zonas definidos. Los rangos de zonas definidos no cumplen los requisitos.
series temporales	Documento	Opcional. Especifique esta opción para crear una nueva colección de series temporales fragmentadas. Para fragmentar una colección de series de tiempo existente, omita este parámetro. Cuando la colección especificada en `shardCollection` es una colección de series de tiempo y no se especifica la opción `timeseries`, MongoDB utiliza los valores que definen la colección de series de tiempo existente para completar el campo `timeseries`. Para conocer la sintaxis detallada, consulte Opciones de series de tiempo.

Opciones de series temporales

Nuevo en la versión 5.1.

Para crear una nueva colección de series temporales fragmentada, especifique la opción de series sh.shardCollection() temporales en.

La opción de serie temporal toma los siguientes campos:

Campo	Tipo	Descripción
`timeField`	string	Requerido. El nombre del campo que contiene la fecha en cada documento de serie de tiempo. Los documentos en una colección de series de tiempo deben tener una fecha BSON válida como valor para el `timeField`.
`metaField`	string	Opcional. El nombre del campo que contiene los metadatos en cada documento de serie de tiempo. Los metadatos del campo especificado deben ser datos que se utilicen para etiquetar una serie única de documentos. Los metadatos difícilmente cambien. El nombre del campo especificado no puede ser `_id` ni el mismo que el `timeseries.timeField`. El campo puede ser de cualquier tipo de dato. Aunque el campo `metaField` es opcional, el uso de metadatos puede mejorar la optimización de query. Por ejemplo, MongoDB crea un índice compuesto automáticamente en los campos `metaField` y `timeField` para las nuevas colecciones. Si no proporcionas un valor para este campo, los datos se agrupan únicamente en función del tiempo.
`granularity`	string	Opcional. Los valores posibles son: `"seconds"` `"minutes"` `"hours"` De forma predeterminada, MongoDB establece `granularity` en `"seconds"` para la ingestión de alta frecuencia. Configure manualmente el parámetro `granularity` para mejorar el rendimiento optimizando el almacenamiento interno de los datos de la colección de series temporales. Para seleccionar un valor para `granularity`, elija la coincidencia más cercana al intervalo de tiempo entre mediciones entrantes consecutivas. Si especifica `timeseries.metaField`, considere el intervalo de tiempo entre mediciones entrantes consecutivas que tengan el mismo valor único en el campo `metaField`. Las mediciones suelen tener el mismo valor único en el campo `metaField` si provienen de la misma fuente. Si no especificas `timeseries.metaField`, considera el intervalo de tiempo entre todas las mediciones que se insertan en la colección. Si configura el parámetro `granularity`, no podrá configurar los parámetros `bucketMaxSpanSeconds` y `bucketRoundingSeconds`.

Compatibilidad

Este método está disponible en implementaciones alojadas en los siguientes entornos:

MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

Importante

Este comando no es compatible con los clústeres M0 y Flex. Para obtener más información, consulta Comandos no compatibles.

MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB
MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Considerations

Claves de partición

Si bien puede cambiar su clave de fragmento más adelante, es importante considerar cuidadosamente su elección de clave de fragmento para evitar problemas de escalabilidad y rendimiento.

Claves de fragmentos en colecciones de series temporales

Al fragmentar colecciones de series temporales, solo puede especificar los siguientes campos en la clave de fragmentación:

El metaField
Subcampos de metaField
El timeField

Puede especificar combinaciones de estos campos en la clave de fragmento. No se permiten otros campos, incluido _id, en el patrón de la clave de fragmento.

Cuando se especifica la clave del fragmento:

metaField Puede ser cualquiera de los dos:
- Clave de fragmento en hash
- Clave de fragmento a distancia
timeField debe ser:
- Una clave de fragmento a distancia
- Al final del patrón de clave de fragmento

Tip

Evite especificar solo timeField como clave de fragmento. Dado que timeField aumenta de forma monótona, es posible que todas las escrituras aparezcan en un solo fragmento dentro del clúster. Idealmente, los datos se distribuyen uniformemente entre los fragmentos.

Para saber cómo elegir mejor una clave de fragmento, consulte:

Tip

Claves de fragmentos con hash

Las claves de fragmento con hash utilizan un índice con hash o un índice con hash compuesto como clave de fragmento.

Utilice el formato field: "hashed" para especificar un campo de clave de fragmento con hash.

Nota

Si se están realizando migraciones de fragmentos mientras se crea una colección de claves de fragmentos con hash, la distribución inicial de fragmentos puede ser desigual hasta que el equilibrador equilibre automáticamente la colección.

Tip

Particionamiento encriptado

Fragmentación de zonas y distribución inicial de fragmentos

La operación de colección de partición (es decir, El shardCollection comando y el sh.shardCollection() asistente pueden realizar la creación inicial de fragmentos y la distribución para una colección vacía o inexistente si zonas y rangos de zonas han sido definidos para la colección. La distribución inicial de fragmentos permite una configuración más ágil del particionado por zonas. Tras la distribución inicial, el balanceador se encarga de la distribución de fragmentos siguiendo el procedimiento habitual.

Para fragmentar una colección utilizando un índice hash compuesto, consulte Distribución de fragmentos iniciales con índices hash compuestos.

Distribución de fragmentos iniciales con índices hash compuestos

MongoDB admite la fragmentación de colecciones en índices con hash compuesto. Al fragmentar una colección vacía o inexistente mediante una clave de fragmento con hash compuesto, se aplican requisitos adicionales para que MongoDB pueda crear y distribuir fragmentos iniciales.

Consulte Zonas predefinidas y rangos de zonas para una colección vacía o inexistente para ver un ejemplo.

Tip

Fragmentos iniciales

Unicidad

Si se especifica unique: true:

Si la colección está vacía, sh.shardCollection() crea el índice único en la clave de partición si dicho índice no existe ya.
Si la colección no está vacía, debe crear el índice antes de usar sh.shardCollection().

Aunque se puede tener un índice compuesto único donde la clave de fragmentación es un prefijo, si se utiliza el parámetro unique, la colección debe tener un índice único que esté en la clave de partición.

Véase también Colección fragmentada e índices únicos

Intercalación

Si la colección tiene una intercalación predeterminada, el comando debe incluir sh.shardCollection() un collation parámetro con el { locale: "simple" } valor. Para colecciones no vacías con una intercalación predeterminada, debe tener al menos un índice con la intercalación simple cuyos campos admitan el patrón de clave de fragmento.

No es necesario especificar la opción collation para colecciones sin intercalación. Si se especifica la opción de intercalación para una colección sin intercalación, no tendrá efecto.

Nivel de confirmación de escritura

mongosutiliza"majority"para la preocupación de escritura del comandoshardCollection, su ayudantesh.shardCollection()y el métodosh.shardAndDistributeCollection().

Se pueden redistribuir los fragmentos para equilibrar

Al sh.shardCollection() ejecutar el método, el balanceador comienza a distribuir los datos de la colección a otros fragmentos del clúster. Un fragmento solo puede participar en una migración de fragmentos a la vez. Cuando MongoDB copia correctamente un rango de datos de un fragmento a otro, el eliminador de rangos marca el rango del fragmento donante para su eliminación. Este proceso es lento y consume muchos recursos.

A partir de MongoDB 8.0, si la implementación cumple los requisitos de recursos, se recomienda usar el método sh.shardAndDistributeCollection() para particionar la colección. Este método encapsula los comandos shardCollection y reshardCollection para particionar la colección y redistribuirla de inmediato con la misma clave. Esto hace que MongoDB vuelva a equilibrar los datos entre las particiones sin esperar al balanceador.

Para obtener más información, se puede consultar Redistribuir con la misma clave de partición.

Ejemplos

Uso simple

Dada una colección llamada people en una base de datos llamada records, el siguiente comando fragmenta la colección por el campo zipcode:

sh.shardCollection("records.people", { zipcode: 1 } )

Uso con opciones

La base de datos phonebook tiene una colección contacts sin una intercalación predeterminada. El siguiente ejemplo utiliza sh.shardCollection() para crear una partición para el phonebook.contacts con:

una clave de fragmento con hash en el last_name campo,
5 trozos iniciales, y
una intercalación de simple.

sh.shardCollection(
  "phonebook.contacts",
  { last_name: "hashed" },
  false,
  {
    collation: { locale: "simple" }
  }
)

Tip

Volver

Colección sh.shardAndDistribute

sh.splitAt