Skip to content

Commit

Permalink
markdown linter
Browse files Browse the repository at this point in the history
  • Loading branch information
hariso committed May 3, 2024
1 parent 4317d34 commit f251376
Showing 1 changed file with 25 additions and 22 deletions.
47 changes: 25 additions & 22 deletions docs/design-documents/20240430-schema-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ the [target collections](https://conduit.io/docs/introduction/vocabulary).

To do so, the following is required:

* collection name
* collection metadata
* schema
- collection name
- collection metadata
- schema

This design document focuses on the schema support in Conduit in the context of
the above.
Expand Down Expand Up @@ -65,26 +65,27 @@ connector developer to write code, since it doesn't require handling of
potentially multiple schema types.

A schema consists of following:
* reference: a string that uniquely identifies a schema in Conduit
* list of fields, where each field is described with following:
* name
* type
* optional (boolean value)
* default value
- reference: a string that uniquely identifies a schema in Conduit
- list of fields, where each field is described with following:
- name
- type
- optional (boolean value)
- default value

The following types are supported:
* basic:
* boolean
* integers: 8, 16, 32, 64-bit
* float: single precision (32-bit) and double precision (64-bit) IEEE 754 floating-point number
* bytes
* string
* timestamp
* complex:
* array
* map
* struct
* union

- basic:
- boolean
- integers: 8, 16, 32, 64-bit
- float: single precision (32-bit) and double precision (64-bit) IEEE 754 floating-point number
- bytes
- string
- timestamp
- complex:
- array
- map
- struct
- union

Every field in a schema can be marked as optional (nullable).

Expand All @@ -99,6 +100,8 @@ connectors with Conduit. Here we have two possibilities:
1. The schema is part of the record (e.g. Debezium records)
2. The schema can be found in a schema registry (e.g. an Avro schema registry)

TBD

## Schema evolution

TBD (this section is about checking if a new version of a schema is compatible
Expand Down Expand Up @@ -275,4 +278,4 @@ remote Conduit instances.
1. **Permissions**: creating a collection generally requires a broader set of
permissions then just writing data to a collection. For some users, the
benefit of having restricted permissions might outweigh the benefit of
auto-creating collections.
auto-creating collections.

0 comments on commit f251376

Please sign in to comment.