-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for schema pluggability and schema references #1280
Merged
Conversation
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
tuvtran
approved these changes
Jan 7, 2020
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! LGTM!
This was referenced Jan 8, 2020
Closed
rayokota
changed the title
Add support for schema imports/references
Add support for schema pluggability and schema references
Jan 8, 2020
This was referenced Jan 13, 2020
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR add supports for pluggability and schema references.
The notion of a schema has been abstracted into a new interface in Schema Registry called ParsedSchema. Implementing a ParsedSchema and a SchemaProvider are all that is needed to add new a schema type to Schema Registry.
In order to add further schema types, the following property should be set in the Schema Registry properties file:
schema.providers=my.package.MySchemaProvider
Avro, JSON Schema, and Protobuf all have the notion of schema references (also sometimes referred to as schema imports or schema includes). This feature is less important for Avro since the feature is associated with their protocol functionality, which is not used by Schema Registry. However, for JSON Schema and especially Protobuf, the use of schema references is more prevalent. Therefore Schema Registry now supports the notion of schema references. A schema reference is comprised of
A name for the reference.
For Avro, it would be a fully qualified schema name.
For JSON Schema, it would be a URL.
For Protobuf, it would be the name of another Protobuf file.
A subject, representing the subject under which the referenced schema is registered.
A version, representing the exact version of the schema under the registered subject.
When registering a schema, the associated references, if any, need to be passed. Typically the referenced schemas would be first registered, then their subjects and versions can be used when registering the schema that references them.
When a schema that has references is retrieved from Schema Registry, the referenced schemas will also be retrieved if needed.