scribe.avro.core — vise890/scribe 2018.12.01

Functions for Clojure Spec to Avro schema conversion, encoding and decoding.

->avro-schema clj

(->avro-schema spec-k)

Generates an Avro schema for spec-k.

spec-k: the key of the Spec to convert

->avro-schema* clj multimethod

Returns a tuple: [::spec->avro-ref ::avro-schema].

The ::spec->avro-ref map is updated in any calls that define Avro named types, so that schemas are only defined on the first instance and then referred to by fully qualified name.

NOTE: you shouldn't need to call this directly, but you can extend this multimethod to implement schema generation for specs that aren't included here.

binary-encoded clj

(binary-encoded spec-k & records)

See abracad.avro/binary-encoded.

decode clj

(decode spec-k source)

See abracad.avro/decode.

enum? clj

(enum? x)

Specs defined as non-empty, keyword-only sets are ::enums.

::enums are used for defining a finite set of choices and are converted to Avro :enums. An example would be:

`(s/def ::color #{:red :green :blue})'

post-deserialize clj

(post-deserialize spec-k v)

Processes a deserailized value v from Avro.

For example, it converts bytes to a BigDecimal for an Avro :decimal, integers to Instants for :timestamp-millis and so on, according to the Avro specification.

post-deserialize* clj multimethod

See post-deserialize.

NOTE: you shouldn't need to call this directly, but you can extend this multimethod to implement value post-deserialization for specs that aren't included here.

pre-serialize clj

(pre-serialize spec-k v)

Prepares a value v for encoding to Avro.

For example, it converts BigDecimals to bytes for Avro :decimals, :timestamp-millis to integers and so on, according to the Avro specification.

pre-serialize* clj multimethod

See pre-serialize.

NOTE: you shouldn't need to call this directly, but you can extend this multimethod to implement value pre-serialization for specs that aren't included here.