dawidwys closed pull request #6078: [FLINK-9438] Add documentation for
AvroDeserializationSchema
URL: https://github.com/apache/flink/pull/6078
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/docs/dev/connectors/kafka.md b/docs/dev/connectors/kafka.md
index 47a6651a5de..b9dbd8fe07f 100644
--- a/docs/dev/connectors/kafka.md
+++ b/docs/dev/connectors/kafka.md
@@ -166,6 +166,39 @@ For convenience, Flink provides the following schemas:
The KeyValue objectNode contains a "key" and "value" field which contain
all fields, as well as
an optional "metadata" field that exposes the offset/partition/topic for
this message.
+3. `AvroDeserializationSchema` which reads data serialized with Avro format
using a statically provided schema. It can
+ infer the schema from Avro generated classes
(`AvroDeserializationSchema.forSpecific(...)`) or it can work with
`GenericRecords`
+ with a manually provided schema (with
`AvroDeserializationSchema.forGeneric(...)`). This deserialization schema
expects that
+ the serialized records DO NOT contain embedded schema.
+
+ - There is also a version of this schema available that can lookup the
writer's schema (schema which was used to write the record) in
+ [Confluent Schema
Registry](https://docs.confluent.io/current/schema-registry/docs/index.html).
Using these deserialization schema
+ record will be read with the schema that was retrieved from Schema
Registry and transformed to a statically provided( either through
+ `ConfluentRegistryAvroDeserializationSchema.forGeneric(...)` or
`ConfluentRegistryAvroDeserializationSchema.forSpecific(...)`).
+
+ <br>To use this deserialization schema one has to add the following
additional dependency:
+
+<div class="codetabs" markdown="1">
+<div data-lang="AvroDeserializationSchema" markdown="1">
+{% highlight xml %}
+<dependency>
+ <groupId>org.apache.flink</groupId>
+ <artifactId>flink-avro</artifactId>
+ <version>{{site.version }}</version>
+</dependency>
+{% endhighlight %}
+</div>
+<div data-lang="ConfluentRegistryAvroDeserializationSchema" markdown="1">
+{% highlight xml %}
+<dependency>
+ <groupId>org.apache.flink</groupId>
+ <artifactId>flink-avro-confluent-registry</artifactId>
+ <version>{{site.version }}</version>
+</dependency>
+{% endhighlight %}
+</div>
+</div>
+
When encountering a corrupted message that cannot be deserialized for any
reason, there
are two options - either throwing an exception from the `deserialize(...)`
method
which will cause the job to fail and be restarted, or returning `null` to allow
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
With regards,
Apache Git Services
