sh.shardCollection() (método mongosh)

Definición

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

Fragmenta una colección usando el key como clave de partición. La clave de partición determina cómo distribuye MongoDB los documentos de la colección entre las particiones.

Nota

Cambiado en la versión 6.0.

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

Importante

Método mongosh

Esta página documenta a Método mongosh. Esta no es la documentación de comandos de base de datos ni de 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 namespace de la colección para particionar en la forma `"<database>.<collection>"`.
`key`	Documento	El documento que especifica el campo o campos que se utilizarán como clave de partición. `{ <field1>: <1\|"hashed">, ... }` Establezca el valor del campo en uno de los siguientes: `1` para particionado basado en rango `"hashed"` para especificar una clave de partición con hash. La clave de partición debe estar soportada por un índice. A menos que la colección esté vacía, el índice debe existir antes del comando `shardCollection`. Si la colección está vacía, MongoDB crea el índice antes de fragmentar la colección si el índice que puede soportar la clave de partición no existe todavía. Ver también Índices de claves de fragmento
`unique`	booleano	opcional. Especifique `true` para garantizar que el índice subyacente aplique una restricción de unicidad. Por defecto `false`. No puedes especificar `true` cuando utilizas claves de fragmentación con hash. Para heredado mongo Shell, debes especificar explícitamente el valor de `unique` si especificas el documento `options`. `mongosh` no requiere `unique` al especificar el documento `options`.
`options`	Documento	opcional. Un documento que contiene campos opcionales, incluidos `collation`.

La opción options admite las siguientes opciones:

Parameter	Tipo	Descripción
`collation`	Documento	opcional. Si la colección especificada para `shardCollection` tiene una intercalación predeterminada, debe incluir un documento de intercalación con``{ locale : "simple" }``, o el comando `shardCollection` fallará. Al menos uno de los índices cuyos campos admiten el patrón de clave de partición debe tener la intercalación simple.
presplitHashedZones	booleano	opcional. Especificar `true` para realizar la creación y distribución inicial de fragmentos para una colección vacía o inexistente en función de las zonas definidas y los rangos de zonas para la colección. Solo para particionado con hash. `shardCollection()` con `presplitHashedZones: true` devuelve un error si se cumple alguna de las siguientes condiciones: La clave de partición no contiene un campo indexado con hash (es decir, no es un índice hashed de campo único o un índice hashed compuesto). La colección no tiene zonas ni rangos de zonas definidos. Los rangos de zonas definidos no cumplen con los requisitos.
Series temporales	Documento	opcional. Especifica esta opción para crear una nueva colección de series de tiempo particionadas. Para dividir una colección de series de tiempo existente, omite 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 poblar el campo `timeseries`. Para obtener la sintaxis detallada, consulta Opciones de series de tiempo.

Opciones de series de tiempo

Nuevo en la versión 5.1.

Para crear una nueva colección de series de tiempo que esté particionado, especifica la opción timeseries en sh.shardCollection().

La opción serie temporal requiere 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"` Por defecto, MongoDB establece el `granularity` en `"seconds"` para una ingestión de alta frecuencia. Establece manualmente el parámetro `granularity` para mejorar el rendimiento optimizando cómo se almacena internamente la información en la colección de series de tiempo. Para seleccionar un valor para `granularity`, elige la coincidencia más cercana al intervalo de tiempo entre medidas consecutivas entrantes. Si especificas el `timeseries.metaField`, considera el lapso de tiempo entre mediciones entrantes consecutivas que tienen el mismo valor único para el campo `metaField`. Las mediciones suelen tener el mismo valor único para 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 estableces el parámetro `granularity`, no puedes establecer 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 puedes cambiar tu clave de partición más adelante, es importante considerar cuidadosamente la elección de tu clave de partición para evitar problemas de escalabilidad y rendimiento.

Claves de partición en colecciones de series temporales

Al particionar colecciones de series de tiempo, solo puedes especificar los siguientes campos en la clave de partición:

La metaField
Subcampos de metaField
La timeField

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

Cuando se especifica la clave de partición:

metaField puede ser ya sea un:
- clave de partición con hash
- Clave de partición clasificado por rango
timeField debe ser:
- Una clave de partición clasificada por rango
- Al final del patrón de clave de partición

Tip

Evita especificar solo el timeField como clave de partición. Dado que el timeField aumenta de manera monótona, puede provocar que todas las escrituras aparezcan en un solo fragmento dentro del clúster. Idealmente, los datos se distribuyen uniformemente entre los fragmentos.

Para aprender cómo elegir mejor una clave de partición, consulte:

Tip

clave de partición con hash

Las claves de partición con hash utilizan un índice con hash o un índice compuesto con hash como clave de partición.

Utiliza el formulario field: "hashed" para especificar un campo clave de partición con hash.

Nota

Si las migraciones de fragmentos están en curso mientras se crea una colección de clave de partición con hash, la distribución inicial de fragmentos puede ser desigual hasta que el balanceador equilibre automáticamente la colección.

Tip

Particionamiento encriptado

Particionado 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 encriptada compuesto, vea Distribución inicial de fragmentos con índices encriptadas compuestos.

Distribución inicial de fragmentos con índices con hash compuestos

MongoDB admite particionar colecciones en índices compuestos encriptados. Al fragmentar una colección vacía o inexistente utilizando una clave de fragmento hash compuesta, se aplican requisitos adicionales para que MongoDB pueda realizar la creación y distribución inicial de fragmentos.

Consulta Predefinir zonas 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.

Ver también Colección particionada e índices únicos

Intercalación

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

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

Nivel de confirmación de escritura

mongos utiliza "majority" para el nivel de confirmación de escritura (write concern) del comando shardCollection, su asistente sh.shardCollection(), y el método sh.shardAndDistributeCollection().

Se pueden redistribuir los fragmentos para equilibrar

Cuando se ejecuta el método sh.shardCollection(), el balanceador comienza a distribuir los datos de la colección a otras particiones en el clúster. Una única partición sólo puede participar en una migración de fragmento a la vez. Cuando MongoDB completa la copia de un rango de datos de una partición a otra, el rango en la partición donante se marca para su eliminación mediante el eliminador de rangos. Este proceso es lento y requiere 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 sencillo

Dada una colección llamada people en una base de datos llamada records, el siguiente comando crea particiones en 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 partición con hash en el campo last_name,
5 fragmentos iniciales, y
una intercalación de simple.

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

Tip

Volver

sh.shardAndDistributeCollection

sh.splitAt