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 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 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. Si especifica el documento options, debe especificar explícitamente el valor para unique.
options	Documento	Opcional. Un documento que contiene campos opcionales, incluidos numInitialChunks y collation.

El argumento options admite las siguientes opciones:

Parameter	Tipo	Descripción
numInitialChunks	entero	Opcional. Especifica el número mínimo de fragmentos que se deben crear inicialmente al fragmentar una colección vacía con una clave de fragmento con hash. MongoDB crea y equilibra los fragmentos en el clúster. El numInitialChunks parámetro debe ser inferior a 8192 fragmentos por fragmento. El 2 valor predeterminado es fragmentos por fragmento. Si la colección no está vacía o la clave del fragmento no contiene un campo hash, la operación devuelve un error. Si se realiza la fragmentación con presplitHashedZones: verdadero, MongoDB intenta distribuir de manera uniforme la cantidad especificada de fragmentos entre las zonas del clúster. Si se realiza la fragmentación con presplitHashedZones: falso o se omite y no se definen zonas ni rangos de zonas para la colección vacía, MongoDB intenta distribuir de manera uniforme la cantidad especificada de fragmentos entre los fragmentos del clúster. Si la fragmentación con presplitHashedZones: falso o se omite 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 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.

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 se ha fragmentado una colección, MongoDB no proporciona ningún método para desfragmentar una colección fragmentada.

Ejemplos

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

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