forked from jlandersen/vscode-kafka
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support for local Avro schema in CONSUMER/PRODUCER of kafka-file
Fixes jlandersen#114 Signed-off-by: azerr <[email protected]>
- Loading branch information
1 parent
632c49f
commit bc7439e
Showing
21 changed files
with
623 additions
and
112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| # Serialization | ||
|
|
||
| * A PRODUCER can serialize `key/value` by declaring the proper serializer with `key-format/value-format` property. | ||
| * A CONSUMER can deserialize `key/value` by declaring the proper deserializer for `key-format/value-format` property. | ||
|
|
||
| ## Basic serialization | ||
|
|
||
| ### Basic serializer | ||
|
|
||
| The serializers can have the following value: | ||
|
|
||
| * `string`: similar serializer to the Kafka Java client [org.apache.kafka.common.serialization.StringSerializer](https://github.com/apache/kafka/blob/master/clients/src/main/java/org/apache/kafka/common/serialization/StringSerializer.java). By default it supports `UTF-8` encoding, but you can specify the encoding as parameter like this `string(base64)`. The valid encoding values are defined in [Node.js' buffers and character encodings](https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings). | ||
| * `double`: similar serializer to the Kafka Java client [org.apache.kafka.common.serialization.DoubleSerializer](https://github.com/apache/kafka/blob/master/clients/src/main/java/org/apache/kafka/common/serialization/DoubleSerializer.java). | ||
| * `float`: similar serializer to the Kafka Java client [org.apache.kafka.common.serialization.FloatSerializer](https://github.com/apache/kafka/blob/master/clients/src/main/java/org/apache/kafka/common/serialization/FloatSerializer.java). | ||
| * `integer`: similar serializer to the Kafka Java client [org.apache.kafka.common.serialization.IntegerSerializer](https://github.com/apache/kafka/blob/master/clients/src/main/java/org/apache/kafka/common/serialization/IntegerSerializer.java). | ||
| * `long`: similar serializer to the Kafka Java client [org.apache.kafka.common.serialization.LongSerializer](https://github.com/apache/kafka/blob/master/clients/src/main/java/org/apache/kafka/common/serialization/LongSerializer.java). | ||
| * `short`: similar serializer to the Kafka Java client [org.apache.kafka.common.serialization.ShortSerializer](https://github.com/apache/kafka/blob/master/clients/src/main/java/org/apache/kafka/common/serialization/ShortSerializer.java). | ||
|
|
||
| ### Basic deserializer | ||
|
|
||
| The deserializers can have the following value: | ||
|
|
||
| * `none`: no deserializer (ignores content). | ||
| * `string`: similar deserializer to the Kafka Java client [org.apache.kafka.common.serialization.StringDeserializer](https://github.com/apache/kafka/blob/master/clients/src/main/java/org/apache/kafka/common/serialization/StringDeserializer.java). By default it supports `UTF-8` encoding, but you can specify the encoding as parameter like this `string(base64)`. The valid encoding values are defined in [Node.js' buffers and character encodings](https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings). | ||
| * `double`: similar deserializer to the Kafka Java client [org.apache.kafka.common.serialization.DoubleDeserializer](https://github.com/apache/kafka/blob/master/clients/src/main/java/org/apache/kafka/common/serialization/DoubleDeserializer.java). | ||
| * `float`: similar deserializer to the Kafka Java client [org.apache.kafka.common.serialization.FloatDeserializer](https://github.com/apache/kafka/blob/master/clients/src/main/java/org/apache/kafka/common/serialization/FloatDeserializer.java). | ||
| * `integer`: similar deserializer to the Kafka Java client [org.apache.kafka.common.serialization.IntegerDeserializer](https://github.com/apache/kafka/blob/master/clients/src/main/java/org/apache/kafka/common/serialization/IntegerDeserializer.java). | ||
| * `long`: similar deserializer to the Kafka Java client [org.apache.kafka.common.serialization.LongDeserializer](https://github.com/apache/kafka/blob/master/clients/src/main/java/org/apache/kafka/common/serialization/LongDeserializer.java). | ||
| * `short`: similar deserializer to the Kafka Java client [org.apache.kafka.common.serialization.ShortDeserializer](https://github.com/apache/kafka/blob/master/clients/src/main/java/org/apache/kafka/common/serialization/ShortDeserializer.java). | ||
|
|
||
| ## Avro serialization | ||
|
|
||
| Serialization can be done too with [Apache Avro Schema](http://avro.apache.org/docs/current/spec.html) with a local Avro Schema `*.avsc` | ||
|
|
||
| For instance you can create an [Apache Avro](http://avro.apache.org/docs/current/spec.html) Schema `animals.avsc`: | ||
|
|
||
|
|
||
| ```json | ||
| { | ||
| "type": "record", | ||
| "fields": [ | ||
| { | ||
| "name": "kind", | ||
| "type": { | ||
| "name": "animals_type", | ||
| "type": "enum", | ||
| "symbols": [ | ||
| "CAT", | ||
| "DOG" | ||
| ] | ||
| } | ||
| }, | ||
| { | ||
| "name": "name", | ||
| "type": "string" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| and bind it with `avro(path/of/animals.avsc)` in `key-format` / `value-format`. Path is resolved following those strategies: | ||
|
|
||
| * `file:///` a given file path (ex : `avro(file:///C:/path/of/animals.avsc)`. | ||
| * `/` relative path to the kafka file (ex : `avro(/path/of/animals.avsc)`. | ||
| * otherwise relative path to the workspace folder of kafka file (ex : `avro(path/of/animals.avsc)`. | ||
|
|
||
| ### Avro Schema support | ||
|
|
||
| `*.avsc` files benefit with completion, validation for Avro specification. | ||
|
|
||
| ### Avro serializer | ||
|
|
||
| You can serialize value of produced message by using the Avro schema `animals.avsc` like this: | ||
|
|
||
| ``` | ||
| PRODUCER json-output | ||
| topic: topic_name | ||
| value-format: avro(animals.avsc) | ||
| {"kind": "CAT", "name": "Albert"} | ||
| ### | ||
| ``` | ||
|
|
||
| ### Avro deserializer | ||
|
|
||
| You can deserialize value of consummed message by using the Avro schema `animals.avsc` like this: | ||
|
|
||
| ``` | ||
| CONSUMER consumer-group-id | ||
| topic: topic_name | ||
| from: earliest | ||
| value-format: avro(animals.avsc) | ||
| ``` |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
|
|
||
| { | ||
| "$schema": "http://json-schema.org/draft-06/schema#", | ||
| "title": "Avro Schema Definition", | ||
| "description": "Json-Schema definition for Avro AVSC files.", | ||
| "definitions": { | ||
| "avroSchema": { | ||
| "title": "Avro Schema", | ||
| "description": "Root Schema", | ||
| "oneOf": [ | ||
| { "$ref": "#/definitions/types" } | ||
| ] | ||
| }, | ||
| "types": { | ||
| "title": "Avro Types", | ||
| "description": "Allowed Avro types", | ||
| "oneOf": [ | ||
| { "$ref": "#/definitions/primitiveType" }, | ||
| { "$ref": "#/definitions/primitiveTypeWithMetadata" }, | ||
| { "$ref": "#/definitions/customTypeReference" }, | ||
| { "$ref": "#/definitions/avroRecord" }, | ||
| { "$ref": "#/definitions/avroEnum" }, | ||
| { "$ref": "#/definitions/avroArray" }, | ||
| { "$ref": "#/definitions/avroMap" }, | ||
| { "$ref": "#/definitions/avroFixed" }, | ||
| { "$ref": "#/definitions/avroUnion" } | ||
| ] | ||
| }, | ||
| "primitiveType": { | ||
| "title": "Primitive Type", | ||
| "description": "Basic type primitives.", | ||
| "type":"string", | ||
| "enum": [ | ||
| "null", | ||
| "boolean", | ||
| "int", | ||
| "long", | ||
| "float", | ||
| "double", | ||
| "bytes", | ||
| "string" | ||
| ] | ||
| }, | ||
| "primitiveTypeWithMetadata": { | ||
| "title": "Primitive Type With Metadata", | ||
| "description": "A primitive type with metadata attached.", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": { "$ref": "#/definitions/primitiveType" } | ||
| }, | ||
| "required": ["type"] | ||
| }, | ||
| "customTypeReference": { | ||
| "title": "Custom Type", | ||
| "description": "Reference to a ComplexType", | ||
| "not": { "$ref": "#/definitions/primitiveType" }, | ||
| "type": "string", | ||
| "pattern": "^[A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)*$" | ||
| }, | ||
| "avroUnion": { | ||
| "title": "Union", | ||
| "description": "A Union of types", | ||
| "type": "array", | ||
| "items": { "$ref": "#/definitions/avroSchema" }, | ||
| "minItems": 1 | ||
| }, | ||
| "avroField": { | ||
| "title": "Field", | ||
| "description": "A field within a Record", | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { "$ref": "#/definitions/name" }, | ||
| "type": { "$ref": "#/definitions/types" }, | ||
| "doc": { "type": "string" }, | ||
| "default": { }, | ||
| "order": { "enum": ["ascending", "descending", "ignore"] }, | ||
| "aliases": { "type": "array", "items": { "$ref": "#/definitions/name" } } | ||
| }, | ||
| "required": ["name", "type"] | ||
| }, | ||
| "avroRecord": { | ||
| "title": "Record", | ||
| "description": "A Record", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": {"type":"string", "enum": ["record"]}, | ||
| "name": { "$ref": "#/definitions/name" }, | ||
| "namespace": { "$ref": "#/definitions/namespace" }, | ||
| "doc": { "type": "string" }, | ||
| "aliases": { "type": "array", "items": { "$ref": "#/definitions/name" } }, | ||
| "fields": { "type": "array", "items": { "$ref": "#/definitions/avroField" } } | ||
| }, | ||
| "required": ["type", "name", "fields"] | ||
| }, | ||
| "avroEnum": { | ||
| "title": "Enum", | ||
| "description": "An enumeration", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": {"type":"string", "enum": ["enum"]}, | ||
| "name": { "$ref": "#/definitions/name" }, | ||
| "namespace": { "$ref": "#/definitions/namespace" }, | ||
| "doc": { "type": "string" }, | ||
| "aliases": { "type": "array", "items": { "$ref": "#/definitions/name" } }, | ||
| "symbols": { "type": "array", "items": { "$ref": "#/definitions/name" } } | ||
| }, | ||
| "required": ["type", "name", "symbols"] | ||
| }, | ||
| "avroArray": { | ||
| "title": "Array", | ||
| "description": "An array", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": {"type":"string", "enum": ["array"]}, | ||
| "name": { "$ref": "#/definitions/name" }, | ||
| "namespace": { "$ref": "#/definitions/namespace" }, | ||
| "doc": { "type": "string" }, | ||
| "aliases": { "type": "array", "items": { "$ref": "#/definitions/name" } }, | ||
| "items": { "$ref": "#/definitions/types" } | ||
| }, | ||
| "required": ["type", "items"] | ||
| }, | ||
| "avroMap": { | ||
| "title": "Map", | ||
| "description": "A map of values", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": {"type":"string", "enum": ["map"]}, | ||
| "name": { "$ref": "#/definitions/name" }, | ||
| "namespace": { "$ref": "#/definitions/namespace" }, | ||
| "doc": { "type": "string" }, | ||
| "aliases": { "type": "array", "items": { "$ref": "#/definitions/name" } }, | ||
| "values": { "$ref": "#/definitions/types" } | ||
| }, | ||
| "required": ["type", "values"] | ||
| }, | ||
| "avroFixed": { | ||
| "title": "Fixed", | ||
| "description": "A fixed sized array of bytes", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": {"type":"string", "enum": ["fixed"]}, | ||
| "name": { "$ref": "#/definitions/name" }, | ||
| "namespace": { "$ref": "#/definitions/namespace" }, | ||
| "doc": { "type": "string" }, | ||
| "aliases": { "type": "array", "items": { "$ref": "#/definitions/name" } }, | ||
| "size": {"type":"number"} | ||
| }, | ||
| "required": ["type", "name", "size"] | ||
| }, | ||
| "name": { | ||
| "type": "string", | ||
| "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" | ||
| }, | ||
| "namespace": { | ||
| "type": "string", | ||
| "pattern": "^([A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)*)*$" | ||
| } | ||
| }, | ||
| "oneOf": [ | ||
| { "$ref": "#/definitions/avroSchema" } | ||
| ] | ||
| } |
Oops, something went wrong.