To simplify the complexity of creating schemas in formats such as Avro (
.avsc) or JSON-schemas, a new format has been
created at STRM Privacy, called Simple Schemas. It is a YAML based format1, which allows for readability and
understandability by many people in your organization.
A Simple Schema is composed of only the data fields that you require.
The strmMeta section in
is omitted in the Simple Schema representation, as it is translated into an
avsc definition for you to use when serializing data.
Since Avro is well-equipped for serializing and deserializing data, there was no need to create yet another
Simple Schema is a representation of your schema, it is not a serialization format.
In the quickstart Simple Schema example, you'll be guided through a hands-on interaction that shows the technical details when using Simple Schemas.
A simple schema defines a list of nodes. Each node is an entity with the following attributes:
nameunless it was explicitly set. Only use if you need to override the Avro name; as this needs to be an Avro compatible name, this needs to be correct.
An example of a simple schema:
name: Clicksnodes: - name: SessionId type: STRING doc: the string value that connects events to a single sequence required: true repeated: false - name: User Name type: STRING doc: we use a data contract to define that this is private - name: url type: STRING doc: the URL of the current page - name: mouse positions repeated: true type: NODE nodes: - name: x type: INTEGER - name: "y" type: INTEGER
YAML allows for many variations to indicate the boolean value
true. The reason
"y" is quoted in the example above,
is since YAML otherwise would resolve
1 the shortcomings and challenges of YAML are well-known, though readability and simplicity was the major motivation to use YAML for Simple Schemas.