abracad.avro — curbside/abracad 0.4.19

Functions for de/serializing data with Avro.

*avro-readers* clj

Like clojure.core/*data-readers*, but for reading Avro records. Initializes with merged contents of avro_readers.clj resources. Whenever an Avro record is deserialized, the Clojure datum reader will check this map for a key matching the Avro record name represented as a namespace-qualified symbol. When found, the datum reader will invoke the associated value as a function on the deserialized record's fields as positional arguments. The datum reader will use the return value as the deserialization result.

AvroSerializable clj protocol

Protocol for customizing Avro serialization.

field-get clj

(field-get this field)

Value of keyword field for Avro serialization of object.

field-list clj

(field-list this)

List of keyword fields this object provides.

schema-name clj

(schema-name this)

Full package-/namespace-qualified name for Avro purposes.

binary-decoder clj

(binary-decoder source)

Return a binary-encoding decoder for source. The source may be an input stream, a byte array, or a vector of [bytes off len].

binary-encoded clj

(binary-encoded schema & records)

Return bytes produced by binary-encoding records with schema via encode.

binary-encoder clj

(binary-encoder sink)

Return a binary-encoding encoder for sink.

compare clj

(compare schema x y)

Compare x and y according to schema.

data-file-reader clj

(data-file-reader source)

(data-file-reader expected source)

Return an Avro DataFileReader which produces Clojure data structures.

data-file-stream clj

(data-file-stream source)

(data-file-stream expected source)

Return an Avro DataFileStream which produces Clojure data structures.

data-file-writer clj

(data-file-writer)

(data-file-writer sink)

(data-file-writer schema sink)

(data-file-writer codec schema sink)

Return an Avro DataFileWriter which consumes Clojure data structures.

datum-reader clj

(datum-reader)

(datum-reader schema)

(datum-reader expected actual)

Return an Avro DatumReader which produces Clojure data structures.

datum-writer clj

(datum-writer)

(datum-writer schema)

Return an Avro DatumWriter which consumes Clojure data structures.

decode clj

(decode schema source)

Decode and return one object from source using schema. The source may be an existing Decoder object or anything on which a (binary-encoding) Decoder may be opened.

decode-seq clj

(decode-seq schema source)

As per decode, but decode and return a sequence of all objects decoded serially from source.

deflogical clj macro

(deflogical type name read-impl write-impl)

Declare a new logical type.

direct-binary-decoder clj

(direct-binary-decoder source)

Return a non-buffered binary-encoding decoder for source.

direct-binary-encoder clj

(direct-binary-encoder sink)

Return an unbuffered binary-encoding encoder for sink.

encode clj

(encode schema sink & records)

Serially encode each record in records to sink using schema. The sink may be an existing Encoder object, or anything on which a (binary-encoding) Encoder may be opened.

grouping-schema clj

(grouping-schema n schema)

Produce a grouping schema version of record schema schema which ignores all but the first n fields when sorting.

json-decoder clj

(json-decoder schema source)

Return a JSON-encoding decoder for source using schema.

json-encoded clj

(json-encoded schema & records)

Return string produced by JSON-encoding records with schema via encode.

json-encoder clj

(json-encoder schema sink)

Return a JSON-encoding encoder for sink using schema.

mslurp clj

(mslurp f & opts)

Like Avro slurp, but produces a sequence of records.

mspit clj

(mspit schema f content & opts)

Like Avro spit, but emits content as a sequence of records.

parse-schema clj

(parse-schema source)

(parse-schema source & sources)

Parse Avro schemas in source and sources. Each schema source may be a JSON string, an input stream containing a JSON schema, a Clojure data structure which may be converted to a JSON schema, or an already-parsed Avro schema object. The schema for each subsequent source may refer to the types defined in the previous schemas. The parsed schema from the final source is returned.

PSeekableInput clj protocol

Protocol for coercing to an Avro SeekableInput.

-seekable-input clj

(-seekable-input x opts)

Attempt to util/coerce x to an Avro SeekableInput.

schema? clj

(schema? schema)

True iff schema is an Avro Schema instance.

seekable-input clj

(seekable-input x)

(seekable-input opts x)

Attempt to util/coerce x to an Avro SeekableInput.

slurp clj

(slurp f & opts)

Like core slurp, but reads Avro content from f.

spit clj

(spit schema f content & opts)

Like core spit, but emits content to f as Avro with schema.

tuple-schema clj

(tuple-schema types)

(tuple-schema name types)

Return Clojure-data Avro schema for record consisting of fields of the provided types, and optionally named name.

unparse-schema clj

(unparse-schema schema)

Return Avro-normalized Clojure data version of schema. If schema is not already a parsed schema, will first normalize and parse it.