Skip to content

Commit

Permalink
Move readme paragraph
Browse files Browse the repository at this point in the history
  • Loading branch information
nicsnoekTW committed Dec 13, 2023
1 parent d182ea8 commit d2c9b54
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,10 @@ By default, AvroTurf will encode data in the Avro data file format. This means t

The Messaging API will automatically register schemas used for encoding data, and will fetch the corresponding schema when decoding. Instead of including the full schema in the output, only a schema id generated by the registry is included. Registering the same schema twice is idempotent, so no coordination is needed.

An optional `schema_context` parameter allows the registry to be scoped to a
[schema context](https://docs.confluent.io/platform/7.5/schema-registry/schema-linking-cp.html#schema-contexts).
If there is a need to access multiple contexts, you will need to use multiple instances of `ConfluentSchemaRegistry`.

**NOTE:** [The Messaging format](https://github.com/confluentinc/schema-registry/blob/master/docs/serializer-formatter.rst#wire-format) is _not_ compatible with the Avro data file API.

The Messaging API is not included by default, so you must require 'avro_turf/messaging' explicitly if you want to use it.
Expand Down Expand Up @@ -252,10 +256,6 @@ registry.update_global_config(compatibility: 'FULL')
registry.update_subject_config("person", compatibility: 'NONE')
```

An optional `schema_context` parameter allows the registry to be scoped to a
[schema context](https://docs.confluent.io/platform/7.5/schema-registry/schema-linking-cp.html#schema-contexts).
If there is a need to access multiple contexts, you will need to use multiple instances of `ConfluentSchemaRegistry`.

### Testing Support

AvroTurf includes a `FakeConfluentSchemaRegistryServer` that can be used in tests. The
Expand Down

0 comments on commit d2c9b54

Please sign in to comment.