Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.
Docs Menu
Docs Home
/
Desarrollo
/
Métodos mongosh
Docs Home
/
Desarrollo
/
Métodos mongosh
Docs Home
/
Desarrollo
/
Métodos mongosh

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 MongoDB distribuye 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 comandos de base de datos ni controladores específicos de 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:

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 Legacy mongo Shell, debe especificar explícitamente el valor para unique si especifica el options documento. nomongosh requiere unique cuando especifica el options documento.

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:

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 información detallada sobre la sintaxis, consulte Opciones de series temporales.

Opciones de series de tiempo

Nuevo en la versión 5.1.

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

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 se pueden 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:

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, consultar:

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 recolección de fragmentos (esshardCollection decir, el comando y la función sh.shardCollection() auxiliar) puede realizar la creación y distribución inicial de fragmentos para una colección vacía o inexistente si se han definido zonas y rangos de zonas para la colección. La distribución inicial de fragmentos permite una configuración más rápida de la fragmentación por zonas. Después de la distribución inicial, el balanceador gestiona la distribución de fragmentos en adelante como de costumbre.

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, crea el índice único en la clave de fragmento si dicho índice no existesh.shardCollection() ya.

  • Si la colección no está vacía, primero debe crear el índice antes de sh.shardCollection() usar.

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 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 fragmentació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 para "majority" la preocupación de escritura del shardCollection comando, su sh.shardCollection() auxiliar sh.shardAndDistributeCollection() y el método.

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. Cada fragmento solo puede participar en una migración de fragmento a la vez. Cuando MongoDB logra copiar un rango de datos de un fragmento a otro, el eliminador de rangos marca dicho rango en el 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 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 phonebook base de datos tiene una colección contacts sin intercalación predeterminada. El siguiente ejemplo utiliza para dividir sh.shardCollection() la colección phonebook.contacts con:

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

Tip

Volver
sh.shardAndDistributeCollection
Next
sh.splitAt
Califique esta página

En esta página