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 un método mongosh. Esta no es la documentación para los comandos de base de datos ni para los drivers específicos de lenguajes, como Nodo.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 clasificado por 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. Si se especifica el documento options, se debe especificar explícitamente el valor para unique.
options	Documento	opcional. Un documento que contiene campos opcionales, incluidos numInitialChunks y collation.

La opción options admite las siguientes opciones:

Parameter	Tipo	Descripción
numInitialChunks	entero	opcional. Especifica la cantidad mínima de fragmentos a crear inicialmente al fragmentar una colección vacía con una clave de partición con hash. MongoDB luego crea y distribuye fragmentos en todo el clúster. El parámetro numInitialChunks debe ser menor que 8192 fragmentos por partición. El valor por defecto es 2 fragmentos por partición. Si la colección no está vacía o la clave de partición no contiene un campo con hash, la operación devuelve un error. Si se fragmenta con presplitHashedZones: true, MongoDB intenta distribuir uniformemente la cantidad especificada de fragmentos entre las zonas del clúster. Si se utiliza particionamiento con presplitHashedZones: false o se omite y no se definen zonas ni rangos de zonas para la colección vacía, MongoDB intenta distribuir uniformemente el número especificado de fragmentos entre las particiones del clúster. Si se realiza particionado con presplitHashedZones: false o se omiten y se han definido zonas y rangos de zonas para la colección vacía, numInitChunks no tiene efecto.
collation	Documento	opcional. Si la colección especificada para shardCollection tiene una intercalación por defecto, se 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.

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

• 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

Una vez que una colección ha sido particionada, MongoDB no proporciona ningún método para desfragmentar una colección particionada.

Ejemplos

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

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