Sincronización filtrada

Sintaxis de filtro

El start punto final de la API acepta dos campos que configuran la sincronización filtrada: includeNamespaces y excludeNamespaces. Cada campo acepta un arreglo de filtros que especifican las bases de datos y colecciones a incluir o excluir de la sincronización.

Los filtros tienen la siguiente sintaxis:

"includeNamespaces": [
    {
       "database": "<database-name>",
       "collections": [
          "<collection-name>"
       ]
       "databaseRegex": {
          "pattern": "<regex-pattern>",
          "options": "<options>"
       },
       "collectionsRegex": {
          "pattern": "<regex-pattern>",
          "options": "<options>"
       }
    }
 ],
 "excludeNamespaces": [
    {
       "database": "<database-name>",
       "collections": [
          "<collection-name>"
       ]
       "databaseRegex": {
          "pattern": "<regex-pattern>",
          "options": "<options>"
       },
       "collectionsRegex": {
          "pattern": "<regex-pattern>",
          "options": "<options>"
       }
    }
 ]

Para obtener más información sobre la pattern sintaxis de las options expresiones regulares y, consulte Expresiones regulares en filtros.

Los filtros deben incluir el campo database o el campo databaseRegex.

Si necesitas que el filtro haga coincidir colecciones específicas, puedes usar tanto el arreglo collections para especificar colecciones individualmente como definir una expresión regular con el campo collectionsRegex.

Configurar un filtro

"includeNamespaces": [
   {
      "database": "sales",
      "collectionsRegex": {
         "pattern": "^accounts_.+?$",
         "options": "ms"
      }
],
"excludeNamespaces": [
    {
        "database": "sales",
        "collections": [
            "accounts_old"
        ]
    }
]

curl -X POST "http://localhost:27182/api/v1/start" --data '
   {
      "source": "cluster0",
      "destination": "cluster1",
      "includeNamespaces": [
         {
             "database": "sales",
             "collectionsRegex": {
                "pattern": "^accounts_.+$",
                "options": "i"
             }
         }, {
            "database": "marketing"
         }
      ]
   } '

Para una configuración de ejemplo, consulta: Comienza mongosync con un filtro.

Sustituir un filtro existente

No se puede actualizar un filtro existente. Debes detener el proceso de sincronización en curso, preparar el clúster de destino y reiniciar mongosync con un nuevo filtro. Para reiniciar mongosync, consulta: Reiniciar Mongosync.

Añadir y renombrar colecciones

Puede, con algunas restricciones, añadir o rename a collection durante una sincronización filtrada.

Filtrado con mapReduce y $out

Para utilizar la $out etapa de agregación o el comando (cuando mapReduce se configura para crear o reemplazar una colección) con filtrado, debe filtrar toda la base de datos y no solo la colección especificada.

Por ejemplo, considere esta canalización de agregación:

use library
db.books.aggregate( [
   { $group : { _id : "$author", titles: { $push: "$title" } } },
   { $out : "authors" }
] )

La etapa $out crea la colección authors en la base de datos library. Si deseas sincronizar la colección authors, debes especificar toda la base de datos library en tu filtro. El filtro no funcionará si solo especificas la colección authors.

Este filtro funciona:

"includeNamespaces": [
  {
    "database": "library"
  }
]

Este filtro no funciona:

"includeNamespaces": [
  {
    "database": "library",
    "collections": [ "authors", "books" ]  // DOES NOT WORK WITH $OUT
  }
]

Limitaciones

• El filtrado no es compatible con la sincronización reversible.

• El clúster de destino no debe contener datos de usuario antes de comenzar a menos que establezca el parámetro preExistingDestinationData en true al llamar a /start.

• El clúster de destino no debe contener la base de datos del sistema mongosync_reserved_for_internal_use antes de comenzar.

• No puede modificar un filtro que esté en uso. Para crear un nuevo filtro, consulta: Reemplazar un filtro existente.

• Solo puedes renombrar las colecciones en ciertas situaciones. Para más detalles, consulta: Agregar y renombrar colecciones.

• Si un filtro incluye una vista pero no la colección base, sólo los metadatos de la vista se sincronizan con el clúster de destino. Para incluir los documentos de vista, también debe sincronizar la colección base.

• No puedes especificar colección del sistema ni base de datos del sistema en un filtro.

• Para usar la $out etapa de agregación o el comando (cuando mapReduce se configura para crear o reemplazar una colección) con filtrado, debe configurar el filtro para que use toda la base de datos. No puede limitar el filtro a colecciones dentro de la base de datos.

  Para obtener más información, consulta Filtrado con mapReduce y $out.

• El filtrado no admite el bloqueo de escritura dual. Puede usar el bloqueo de escritura solo en el destino.

Ejemplos

"includeNamespaces" : [
      {
          "database" : "sales",
          "collections": [ "EMEA", "APAC" ]
      },
      {
          "database" : "marketing"
      }
   ]

{
   "source": "cluster0",
   "destination": "cluster1",
   "includeNamespaces":
      [
         { "database" : "students", "collections": ["undergrad", "graduate", "adjuncts"] },
         { "database" : "staff" }
      ]
}

// This code works 
use admin
db.runCommand( { renameCollection: "staff.employees", to: "staff.salaried" } )

// This code works 
use admin
db.runCommand( { renameCollection: "students.graduate", to: "students.adjuncts" } )

// This code produces an error and mongosync stops syncing 
use admin
db.runCommand( { renameCollection: "students.graduate", to: "students.notAFilteredCollection" } )

use admin
db.runCommand( { renameCollection: "staff.employees", to: "staff.onPayroll" } )