kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gwens...@apache.org
Subject kafka git commit: KAFKA-2941: Clarify docs for key and value Converters
Date Mon, 11 Jul 2016 04:23:23 GMT
Repository: kafka
Updated Branches:
  refs/heads/trunk 2dfbf4b5f -> f8a7ace9d


KAFKA-2941: Clarify docs for key and value Converters

Author: Ewen Cheslack-Postava <me@ewencp.org>

Reviewers: Gwen Shapira

Closes #1599 from ewencp/kafka-2941-explain-converter-configs


Project: http://git-wip-us.apache.org/repos/asf/kafka/repo
Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/f8a7ace9
Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/f8a7ace9
Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/f8a7ace9

Branch: refs/heads/trunk
Commit: f8a7ace9d4e508d29d664418446c37783a82cb3b
Parents: 2dfbf4b
Author: Ewen Cheslack-Postava <me@ewencp.org>
Authored: Sun Jul 10 21:23:14 2016 -0700
Committer: Gwen Shapira <cshapi@gmail.com>
Committed: Sun Jul 10 21:23:14 2016 -0700

----------------------------------------------------------------------
 .../kafka/connect/runtime/WorkerConfig.java     | 24 ++++++++++++++++----
 1 file changed, 20 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/f8a7ace9/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/WorkerConfig.java
----------------------------------------------------------------------
diff --git a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/WorkerConfig.java
b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/WorkerConfig.java
index 354da9b..c9c4e60 100644
--- a/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/WorkerConfig.java
+++ b/connect/runtime/src/main/java/org/apache/kafka/connect/runtime/WorkerConfig.java
@@ -45,19 +45,35 @@ public class WorkerConfig extends AbstractConfig {
 
     public static final String KEY_CONVERTER_CLASS_CONFIG = "key.converter";
     public static final String KEY_CONVERTER_CLASS_DOC =
-            "Converter class for key Connect data that implements the <code>Converter</code>
interface.";
+            "Converter class used to convert between Kafka Connect format and the serialized
form that is written to Kafka." +
+                    " This controls the format of the keys in messages written to or read
from Kafka, and since this is" +
+                    " independent of connectors it allows any connector to work with any
serialization format." +
+                    " Examples of common formats include JSON and Avro.";
 
     public static final String VALUE_CONVERTER_CLASS_CONFIG = "value.converter";
     public static final String VALUE_CONVERTER_CLASS_DOC =
-            "Converter class for value Connect data that implements the <code>Converter</code>
interface.";
+            "Converter class used to convert between Kafka Connect format and the serialized
form that is written to Kafka." +
+                    " This controls the format of the values in messages written to or read
from Kafka, and since this is" +
+                    " independent of connectors it allows any connector to work with any
serialization format." +
+                    " Examples of common formats include JSON and Avro.";
 
     public static final String INTERNAL_KEY_CONVERTER_CLASS_CONFIG = "internal.key.converter";
     public static final String INTERNAL_KEY_CONVERTER_CLASS_DOC =
-            "Converter class for internal key Connect data that implements the <code>Converter</code>
interface. Used for converting data like offsets and configs.";
+            "Converter class used to convert between Kafka Connect format and the serialized
form that is written to Kafka." +
+                    " This controls the format of the keys in messages written to or read
from Kafka, and since this is" +
+                    " independent of connectors it allows any connector to work with any
serialization format." +
+                    " Examples of common formats include JSON and Avro." +
+                    " This setting controls the format used for internal bookkeeping data
used by the framework, such as" +
+                    " configs and offsets, so users can typically use any functioning Converter
implementation.";
 
     public static final String INTERNAL_VALUE_CONVERTER_CLASS_CONFIG = "internal.value.converter";
     public static final String INTERNAL_VALUE_CONVERTER_CLASS_DOC =
-            "Converter class for offset value Connect data that implements the <code>Converter</code>
interface. Used for converting data like offsets and configs.";
+            "Converter class used to convert between Kafka Connect format and the serialized
form that is written to Kafka." +
+                    " This controls the format of the values in messages written to or read
from Kafka, and since this is" +
+                    " independent of connectors it allows any connector to work with any
serialization format." +
+                    " Examples of common formats include JSON and Avro." +
+                    " This setting controls the format used for internal bookkeeping data
used by the framework, such as" +
+                    " configs and offsets, so users can typically use any functioning Converter
implementation.";
 
     public static final String TASK_SHUTDOWN_GRACEFUL_TIMEOUT_MS_CONFIG
             = "task.shutdown.graceful.timeout.ms";


Mime
View raw message