main-concepts

No menu items for this category
OpenMetadata Documentation

KafkaConnection

Kafka Connection Config

  • type: Service Type. Refer to #/definitions/kafkaType. Default: Kafka.
  • bootstrapServers (string): Kafka bootstrap servers. add them in comma separated values ex: host1:9092,host2:9092.
  • schemaRegistryURL (string): Confluent Kafka Schema Registry URL.
  • saslUsername (string): sasl.username consumer config property.
  • saslPassword (string): sasl.password consumer config property.
  • securityProtocol (string): security.protocol consumer config property. Must be one of: ['PLAINTEXT', 'SASL_PLAINTEXT', 'SASL_SSL', 'SSL']. Default: PLAINTEXT.
  • saslMechanism: sasl.mechanism Consumer Config property. Refer to saslMechanismType.json. Default: PLAIN.
  • basicAuthUserInfo (string): basic.auth.user.info schema registry config property, Client HTTP credentials in the form of username:password.
  • consumerConfig (object): Confluent Kafka Consumer Config. From https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md. Can contain additional properties. Default: {}.
  • schemaRegistryConfig (object): Confluent Kafka Schema Registry Config. From https://docs.confluent.io/5.5.1/clients/confluent-kafka-python/index.html#confluent_kafka.schema_registry.SchemaRegistryClient. Can contain additional properties. Default: {}.
  • schemaRegistryTopicSuffixName (string): Schema Registry Topic Suffix Name. The suffix to be appended to the topic name to get topic schema from registry. Default: -value.
  • consumerConfigSSL: Consumer Config SSL Config. Configuration for enabling SSL for the Consumer Config connection. Refer to ../../../../security/ssl/verifySSLConfig.json#/definitions/sslConfig.
  • schemaRegistrySSL: Schema Registry SSL Config. Configuration for enabling SSL for the Schema Registry connection. Refer to ../../../../security/ssl/verifySSLConfig.json#/definitions/sslConfig.
  • topicFilterPattern: Regex to only fetch topics that matches the pattern. Refer to ../../../../type/filterPattern.json#/definitions/filterPattern.
  • supportsMetadataExtraction: Refer to ../connectionBasicType.json#/definitions/supportsMetadataExtraction.
  • kafkaType (string): Kafka service type. Must be one of: ['Kafka']. Default: Kafka.

Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.