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.
Todas las propiedades de configuración del conector Sink
Overview
En esta página, puedes ver todas las propiedades de configuración disponibles para tu conector sink de MongoDB Kafka. Esta página duplica el contenido de las otras páginas de propiedades de configuración del conector de destino.
IMPORTANTE: Para evitar exponer tus credenciales de autenticación en tu configuración de connection.uri, utiliza un ConfigProvider y establece los parámetros de configuración adecuados.
Por defecto: mongodb://localhost:27017 Valores aceptados: una string URI de conexión de MongoDB
servidor.api.version
Tipo: string
Descripción: La versión de Stable API que desea utilizar con su servidor MongoDB. Para obtener más información sobre Stable API y las versiones del servidor que la admiten, consulte la guía del manual del servidor MongoDB de Stable API.
Por defecto: "" Valores aceptados: una string vacía o una versión válida de Stable API
servidor.api.deprecationErrors
Tipo: booleano
Descripción: Cuando se establece en true, si el conector llama a un comando en su instancia de MongoDB que está obsoleto en la versión declarada de Stable API, genera una excepción.
Puede establecer la versión de la API con la opción de configuración server.api.version. Para obtener más información sobre Stable API, consulte la entrada del manual de MongoDB sobre Stable API.
Por defecto: false Valores aceptados: true o false
servidor.api.strict
Tipo: booleano
Descripción: Cuando se establece en true, si el conector llama a un comando en su instancia de MongoDB que no está cubierto en la versión declarada de Stable API, genera una excepción.
Puede establecer la versión de la API con la opción de configuración server.api.version. Para obtener más información sobre Stable API, consulte la entrada del manual de MongoDB sobre Stable API.
Por defecto: false Valores aceptados: true o false
csfle.enabled
Tipo: booleano
Descripción: Indicador que, cuando se establece en true, habilita el cifrado a nivel de campo del lado del cliente (CSFLE) para la conexión de MongoDB.
Por defecto: false Valores aceptados: true o false
csfle.key.vault.namespace
Tipo: string
Descripción: Namespace de Key Vault para CSFLE en el formato database.collection. Por ejemplo: encryption.__keyVault. Obligatorio cuando csfle.enabled se establece en true.
Por defecto: "" Valores aceptados: un namespace de MongoDB válido en el formato database.collection
csfle.local.master.key
Tipo: string
Descripción: Clave maestra local de 96bytes codificada en Base64para CSFLE con el proveedor de KMS local. El conector utiliza la clave para cifrar y descifrar las claves de cifrado de datos almacenadas en el almacén de claves. Obligatorio cuando csfle.enabled está configurado en true.
Por defecto: "" Valores aceptados: una string de 96bytes codificada en Base64
csfle.schema.map
Tipo: string
Descripción: Documento JSON que define el mapa de esquema de cifrado para CSFLE. Esto asigna namespaces a esquemas JSON que especifican qué campos cifrar y qué algoritmo y clave de cifrado usar.
Por defecto: "" Valores aceptados: un documento JSON válido
csfle.bypass.query.analysis
Tipo: booleano
descripción: Indicador que indica si se debe omitir o no el análisis automático de query para CSFLE. Cuando se establece en true, el conector deshabilita el cifrado automático basado en mapas de esquemas y debe usar el cifrado explícito. Cuando se establece en false, el conector habilita el cifrado automático, pero requiere mongocryptd o la librería crypt_shared. por defecto a true para evitar dependencias externas.
por defecto: true Valores aceptados: true o false
Espacio de nombres de MongoDB
Use la siguiente configuración para especificar a qué base de datos y colección de MongoDB su conector de sink de MongoDB Kafka guardar datos. Puedes utilizar el valor por defecto DefaultNamespaceMapper o especificar una clase personalizada.
Descripción: El nombre de clase completo de la clase que especifica en qué base de datos o colección se deben hundir los datos. El DefaultNamespaceMapper por defecto utiliza los valores especificados en las propiedades database y collection.
El conector incluye una clase alternativa para especificar la base de datos y la colección llamada FieldPathNamespaceMapper. Consulte Configuración de FieldPathNamespaceMapper para obtener más información.
Valores aceptados: un nombre de clase Java totalmente calificado de una clase que implemente la interfaz NamespaceMapper.
database
Requerido
Tipo: string
Descripción: El nombre de la base de datos de MongoDB en la que escribe el conector de receptor.
Valores aceptados: Un nombre de base de datos de MongoDB
Colección
Tipo: string
Descripción: El nombre de la colección de MongoDB a la que escribe el conector de receptor. Si el conector de receptor sigue varios temas, esta es la colección por defecto para cualquier guardados que no se especifique de otro modo.
Por defecto: el nombre del tema.
Valores aceptados: Un nombre de colección de MongoDB
Configuración de FieldPathNamespaceMapper
Si configuras tu conector de sumidero para utilizar el FieldPathNamespaceMapper, puedes especificar a qué base de datos y colección enviar un documento en función de los valores de los campos de los datos.
Para habilitar este comportamiento de mapeo, establezca la propiedad de configuración del conector para sumidero namespace.mapper en el nombre de clase completamente calificado como se muestra a continuación:
FieldPathNamespaceMapper requiere que especifiques los siguientes ajustes:
Una o ambas propiedades de mapeo a una base de datos y colección
Uno de los mapeos key o value a una base de datos
Una de las asignaciones de key o value a una colección
Puedes usar los siguientes ajustes para personalizar el comportamiento del FieldPathNamespaceMapper:
Nombre
Descripción
namespace.mapper.key.base de datos.campo
Tipo: string
Descripción: El nombre del campo del documento clave que especifica el nombre de la base de datos en la que se debe guardar.
namespace.mapper.key.colección.campo
Tipo: string
Descripción: El nombre del campo de documento clave que especifica el nombre de la colección en la que se va a guardar.
namespace.mapper.value.base de datos.campo
Tipo: string
Descripción: El nombre del campo del documento de valor que especifica el nombre de la base de datos en la que se va a guardar.
namespace.mapper.value.collection.field
Tipo: string
descripción: El nombre del campo del documento de valor que especifica el nombre de la colección en la que se va a guardar.
error inválido de mapeo de namespace
Tipo: booleano
Descripción: Si se debe lanzar una excepción cuando el documento no tiene el campo asignado o tiene un tipo BSON no válido.
Cuando se establece en true, el conector no procesa los documentos a los que les falta el campo asignado o que contienen un tipo BSON no válido. El conector puede detener o omitir el procesamiento según la configuración de manejo de errores relacionada.
Cuando se establece en false, si a un documento le falta el campo asignado o si tiene un tipo BSON no válido, el conector por defecto escribe en la configuración database y collection especificada.
Por defecto: false Valores aceptados: true o false
Connector Tema
Utiliza la siguiente configuración para especificar qué temas de Kafka debe monitorear el conector de sink de MongoDB Kafka en busca de datos.
Descripción: Una lista de temas de Kafka que el conector de receptor observa.
Puede definir la configuración topics o topics.regex, pero no ambas.
Valores aceptados: Una lista de temas válidos de Kafka separados por comas
regex
Requerido
Tipo: string
Descripción: Una expresión regular que coincide con los temas de Kafka que observa el conector de receptor.
Por ejemplo, la siguiente expresión regular coincide con nombres de temas como "activity.landing.clicks" y "activity.support.clicks". No coincide con los nombres de los temas "activity.landing.views" y "activity.clicks".
topics.regex=activity\\.\\w+\\.clicks$
Puede definir la configuración topics o topics.regex, pero no ambas.
Valores aceptados: un patrón válido de expresión regular utilizando java.util.regex.Pattern.
Procesamiento de mensajes del Connector
Utilice la configuración de esta página para configurar el comportamiento de procesamiento de mensajes del conector de sumidero de MongoDB Kafka, que incluye lo siguiente:
descripción: Número máximo de registros de sumidero para agrupar para su procesamiento.
Considera el grupo que contiene los siguientes registros:
[ 1, 2, 3, 4, 5 ]
Cuando se establece en 0, el conector realiza una única escritura masiva para todo el lote.
Cuando se establece en 1, el conector realiza una escritura masiva para cada registro del lote, para un total de cinco escrituras masivas como se muestra en el siguiente ejemplo:
[1], [2], [3], [4], [5]
Por defecto: 0 Valores aceptados: un número entero
bulk.guardar.ordered
Tipo: booleano
Descripción: Si el conector guarda un agrupar de registros como una operación de guardar masivo ordenado o no ordenado. Cuando se establece en true, el valor por defecto, el conector guarda un agrupar de registros como una operación de guardar masivo ordenado.
Descripción: Número de lotes de registros que el conector de receptor procesa para activar el tiempo de espera de limitación de velocidad. Un valor de 0 significa que no hay limitación de velocidad.
Por defecto: 0 Valores aceptados: Un número entero
rate.limiting.timeout
Tipo: int
Descripción: Cuánto tiempo (en milisegundos) esperar antes de que el conector de receptor reanude el procesamiento después de alcanzar el umbral de limitación de velocidad.
Por defecto: 0 Valores aceptados: un número entero
tasks.max
Tipo: int
Descripción: El número máximo de tareas que se pueden crear para este conector. El conector puede crear menos tareas de las máximas especificadas si no puede gestionar el nivel de paralelismo que especifique.
IMPORTANTE: Si especifica un valor superior a 1, el conector habilita el procesamiento paralelo de las tareas. Si su tema tiene varios registros de partición, lo que permite al conector leer del tema en paralelo, las tareas pueden procesar los mensajes fuera de orden.
Por defecto: 1 Valores aceptados: Un número entero
Manejo de errores del conector
Utiliza las siguientes configuraciones para especificar cómo el conector MongoDB Kafka sink maneja los errores y para configurar la fila de letra muerta.
Descripción: Si se debe continuar procesando mensajes si el conector encuentra un error. Permite que el conector anule la configuración del clúster de Kafka errors.tolerance.
Cuando se establece en none, el conector informa cualquier error y bloquea el procesamiento posterior del resto de los mensajes.
Cuando se establece en all, el conector ignora cualquier mensaje problemático.
Cuando se establece en data, el conector tolera solo errores de datos y falla en todos los demás errores.
Para obtener más información sobre las estrategias de gestión de errores, consulte la página Gestión de errores.
Esta propiedad anula la propiedad errors.tolerance propiedad del Connect Framework.
Por defecto: Hereda el valor de la configuración errors.tolerance. Valores aceptados: "none" o "all"
mongo.errors.log.enable
Tipo: booleano
Descripción: Si el conector debe guardar los detalles de los errores, incluidas las operaciones fallidas, en el archivo de registro. El conector clasifica los errores como "tolerados" o "no tolerados" utilizando la configuración errors.tolerance o mongo.errors.tolerance.
Cuando se establece en true, el conector registra los errores "tolerados" y "no tolerados". Cuando se establece en false, el conector registra los errores "no tolerados".
Esta propiedad anula la errors.log.enable propiedad del Connect Framework.
Por defecto:false Valores aceptados: true o false
Incluir mensajes
Tipo: booleano
Descripción: Si el conector debe incluir el mensaje no válido al registrar un error. Un mensaje no válido incluye datos como claves de registro, valores y encabezados.
Por defecto:false Valores aceptados: true o false
errors.deadletterqueue.tema.name
Tipo: string
Descripción: Nombre del tema que se utilizará como fila de letra muerta. Si está en blanco, el conector no enviará ningún mensaje no válido a la fila de letra muerta.
Descripción: El número de nodos en los que se replica el tema de la fila de letra muerta. Si está ejecutando un clúster de Kafka de un solo nodo, debe establecerlo en 1.
Por defecto:3 Valores aceptados: un número válido de nodos
Post-processors
Utiliza la siguiente configuración para especificar cómo el conector de sink de MongoDB Kafka debe transformar los datos de Kafka antes de insertarlos en MongoDB.
Valores aceptados: una lista separada por comas de nombres de clases Java completamente calificados
campo.renamer.mapping
Tipo: string
Descripción: Una lista de asignaciones de nombres de campo para campos clave y de valor. Defina las asignaciones en un arreglo JSON en línea en el siguiente formato:
Por defecto: [] Valores aceptados: un arreglo JSON válido
field.renamer.regexp
Tipo: string
Descripción: Una lista de asignaciones de nombres de campo para campos clave y de valor mediante expresiones regulares. Defina las asignaciones en un arreglo JSON en línea en el siguiente formato:
Por defecto: [] Valores aceptados: un arreglo JSON válido
campo.value.transformer
Tipo: string
Descripción: Nombre de clase completo de una implementación de FieldValueTransformer. Cuando se configura, el conector aplica el transformador especificado a los campos enumerados en field.value.transformer.fields antes de guardar en MongoDB. La clase debe implementar com.mongodb.kafka.connect.sink.processor.field.transform.FieldValueTransformer y tener un constructor público sin argumentos.
Por defecto: "" Valores aceptados: un nombre de clase Java completo
campo.valor.transformador.campos
Tipo: string
Descripción: Lista de nombres de campo separados por comas a los que el conector aplica el FieldValueTransformer configurado. El conector también transforma los campos anidados en subdocumentos con nombres coincidentes.
Por defecto: "" Valores aceptados: Una lista de nombres de campo separados por comas
key.proyección.list
Tipo: string
Descripción: Una lista de nombres de campo que el conector debe incluir en la proyección de clave.
Por defecto: "" Valores aceptados: Una lista de nombres de campo separados por comas
key.proyección.type
Tipo: string
Descripción: El tipo de proyección de clave que debe usar el conector.
Por defecto: none Valores aceptados: none, BlockList o AllowList (Obsoleto: lista negra, lista blanca)
value.proyección.list
Tipo: string
Descripción: Una lista de nombres de campo que el conector debe incluir en la proyección de valores.
Por defecto: "" Valores aceptados: una lista de nombres de campo separados por comas
value.proyección.type
Tipo: string
Descripción: El tipo de proyección de valor que debe utilizar el conector.
Por defecto: none Valores aceptados: none, BlockList o AllowList (Obsoleto: lista negra, lista blanca)
estrategia.modelo_de_escritura
Tipo: string
Descripción: La clase que especifica el WriteModelStrategy que el conector debe usar para guardar masivamente.
Valores aceptados: un nombre de clase Java completamente calificado
ID Strategy
Utilice la siguiente configuración para especificar cómo el conector MongoDB Kafka sink debe determinar el valor de _id para cada documento que escriba en MongoDB.
Valores aceptados: Una string vacía o un nombre de clase Java totalmente calificado
document.id.strategy.overwrite.existing
Tipo: booleano
Descripción: Si el conector debe sobrescribir los valores existentes en el campo _id cuando aplica la estrategia definida por la propiedad document.id.strategy.
Por defecto: false Valores aceptados: true o false
document.id.estrategia.uuid.formato
Tipo: string
Descripción: Si el conector debe generar el UUID en el campo _id en formato string o en BsonBinary formato.
Por defecto: string Valores aceptados: string o binary
Borrar en valores nulos
Tipo: booleano
Descripción: Si el conector debe borrar documentos cuando el valor clave coincide con un documento en MongoDB y el campo de valor es nulo.
Esta configuración se aplica cuando se especifica una estrategia de generación de ID que opera en el documento clave, como FullKeyStrategy, PartialKeyStrategy y ProvidedInKeyStrategy.
Por defecto: false Valores aceptados: true o false
Guardar Estrategia del modelo
Puedes establecer propiedades de configuración para especificar cómo el conector sink de Kafka de MongoDB escribe datos en MongoDB. Las siguientes secciones describen las propiedades de configuración que se pueden configurar para personalizar este comportamiento.
Modelo de guardar
Establece la propiedad de configuración writemodel.strategy para especificar cómo el conector sink escribe datos cuando recibe un registro sink.
Puede establecer el valor de writemodel.strategy en cualquiera de los nombres de clase totalmente calificados de las estrategias del modelo de guardar descritas en la sección Estrategias de esta página. Puede especificar una estrategia configurando lo siguiente:
writemodel.strategy=<a write model strategy>
Eliminar modelo guardar
Establece la propiedad de configuración delete.writemodel.strategy para especificar cómo el conector del destino escribe datos al recibir un evento tombstone. Un evento tombstone es un registro que contiene una clave pero sin valor, lo que indica un registro borrado.
Puede establecer el valor de delete.writemodel.strategy en cualquiera de los nombres de clase totalmente calificados de las estrategias del modelo de guardar descritas en la sección Estrategias de esta página. Puede especificar una estrategia configurando lo siguiente:
delete.writemodel.strategy=<a write model strategy>
descripción: Esta estrategia utiliza el ReplaceOneDefaultStrategy por defecto y el InsertOneDefaultStrategy si establece la opción timeseries.timefield.
Este es el valor por defecto para la propiedad de configuración writemodel.strategy.
InsertOneDefaultStrategy
descripción: Inserte cada registro de receptor en MongoDB como un documento. Para especificar esta estrategia, establezca la propiedad de configuración en el siguiente nombre de clase:
descripción: Reemplaza como máximo un documento en MongoDB que coincida con un registro de receptor por el campo _id. Si no hay documentos que coincidan, el conector inserta el registro del receptor como un nuevo documento. Para especificar esta estrategia, establezca la propiedad de configuración en el siguiente nombre de clase:
descripción: Reemplaza como máximo un documento que coincide con un registro de receptor mediante una clave comercial especificada. Si no hay documentos que coincidan, el conector inserta el registro del receptor como un nuevo documento. Para especificar esta estrategia, establezca la propiedad de configuración en el siguiente nombre de clase:
descripción: Borra como máximo un documento que coincida con la estructura de clave de su conector de receptor solo por el campo _id cuando el documento contenga una estructura de valor nulo.
Este es el valor por defecto de la propiedad de configuración delete.writemodel.strategy.
Esta estrategia se establece como el valor por defecto de la propiedad writemodel.strategy cuando se establece delete.on.null.values=true. Para especificar esta estrategia, establezca la propiedad de configuración en el siguiente nombre de clase:
descripción: Borra como máximo un documento de MongoDB que coincida con un registro de receptor mediante una clave comercial. Esta estrategia requiere un valueDoc para la generación de claves. Para aprovechar el PartialKeyStrategy para la generación de claves, utilice el DeleteOneTombstoneBusinessKeyStrategy.
Para especificar esta estrategia, establezca la propiedad de configuración en el siguiente nombre de clase:
descripción: Borra como máximo un documento de MongoDB que coincida con un registro de receptor mediante una clave comercial. Esta estrategia aprovecha el PartialKeyStrategy para crear la clave utilizada para la eliminación.
Para especificar esta estrategia, establezca la propiedad de configuración en el siguiente nombre de clase:
descripción: Actualiza como máximo un documento en MongoDB que coincida con un registro de receptor por el campo _id. Si no hay documentos que coincidan, el conector inserta el registro del receptor como un nuevo documento. Para especificar esta estrategia, establezca la propiedad de configuración en el siguiente nombre de clase:
descripción: Agregue los campos _insertedTS (marca de tiempo insertada) y _modifiedTS (marca de tiempo modificada) en los documentos. Para especificar esta estrategia, establezca la propiedad de configuración en el siguiente nombre de clase:
descripción: Agregue los campos _insertedTS (marca de tiempo insertada) y _modifiedTS (marca de tiempo modificada) en los documentos que coincidan con una llave comercial. Para especificar esta estrategia, establezca la propiedad de configuración en el siguiente nombre de clase:
Utilice la siguiente configuración del conector de destino de MongoDB Kafka para reemplazar la configuración global o por defecto de propiedades para temas específicos.
Para ver solo las opciones relacionadas con la anulación de la configuración del tema, consulta la página de Propiedades de anulación de temas.
Nombre
Descripción
tema.override.<topicName>.<propertyName>
Tipo: string
Descripción: Especifica un tema y un nombre de propiedad para anular la configuración de propiedad global o por defecto correspondiente.
Por ejemplo, la topic.override.foo.collection=bar configuración indica al conector de receptor que almacene datos del foo tema en la bar colección.
Puedes especificar cualquier configuración válida en el <propertyName> segmento por tema, excepto connection.uritopicsy.
Por defecto: "" Valores aceptados: Valores aceptados específicos de la propiedad anulada
Captura de cambio de datos
Utiliza las siguientes configuraciones para especificar la clase que el conector de sumidero de MongoDB Kafka utiliza para procesar eventos de captación de datos de cambios (CDC).
Consulta la guía sobre Controladores de captura de cambios de datos para ejemplos utilizando los controladores de funcionalidad incorporada ChangeStreamHandler y los controladores para los productores de eventos Debezium y Qlik Replicate.
Descripción: El nombre de la clase del controlador CDC que se utilizará para convertir los cambios en flujos de eventos. Consulte Controladores CDC disponibles para obtener una lista de controladores CDC.
Por defecto: "" Valores aceptados: Una string vacía o un nombre de clase Java totalmente calificado
Time Series
Utiliza la siguiente configuración para especificar cómo el conector MongoDB Kafka sink debe enviar datos a una colección de series de tiempo de MongoDB.
Para ver solo las opciones relacionadas con colecciones de series de tiempo, consulta la página de Propiedades de Kafka Time Series.
Nombre
Descripción
timeseries.timefield
Tipo: string
descripción: El nombre del campo de nivel superior en los datos de origen que contiene la información de tiempo que desea asociar con el nuevo documento en la colección de series de tiempo.
por defecto: "" Valores aceptados: Una string vacía o el nombre de un campo que contiene un valor BSON DateTime
timeseries.timefield.auto.convert.date.format
Tipo: string
Descripción: El patrón de formato de fecha que el conector debe usar para convertir los datos de origen contenidos en el campo especificado por la configuración timeseries.timefield.
Si el valor de fecha de los datos de origen solo contiene información de fecha, el conector establece la información de hora al inicio del día especificado. Si el valor de fecha no contiene el desplazamiento de zona horaria, el conector establece el desplazamiento en UTC.
Valores aceptados: Un formato válido de DateTimeFormatter
timeseries.timefield.auto.convert
Tipo: booleano
Descripción: Si se deben convertir los datos del campo al formato BSON Date.
Cuando se establece en true, el conector utiliza los milisegundos después de Unix epoch y descarta las partes fraccionarias si el valor es un número. Si el valor es un string, el conector utiliza la configuración siguiente para analizar la fecha:
timeseries.timefield.auto.convert.date.format
Si el conector no puede convertir el valor, envía el valor original a la colección de series de tiempo.
Por defecto: false Valores aceptados: true o false
Etiqueta de lenguaje de conversión automática del campo de hora en serie temporal de localización
Tipo: string
descripción: Qué etiqueta de lenguaje de localización DateTimeFormatter usar con el patrón de formato de fecha (p. ej., "en-US").
Para aprender más sobre las localizaciones, consulte la documentación de Java SE de localización.
por defecto: ROOT Valores aceptados: un formato de etiqueta de lenguaje Locale válido
timeseries.metafield
Tipo: string
Descripción: qué campo de nivel superior leer de los datos de origen para describir un grupo de documentos de serie de tiempo relacionados.
IMPORTANTE: este campo no debe ser el campo _id ni el campo que especificaste en la configuración timeseries.timefield.
Por defecto: "" Valores aceptados: una string vacía o el nombre de un campo que contiene cualquier tipo BSON, excepto BsonArray.
Las series temporales expiran después de segundos
Tipo: int
Descripción: El número de segundos que MongoDB debe esperar antes de eliminar automáticamente los datos de la colección de series de tiempo. El conector deshabilita la caducidad programada cuando el valor de configuración es inferior a 1.