deercreeklabs.lancaster — deercreeklabs/lancaster 0.11.0

array-schema clj/s

(array-schema items-schema)

Inputs: [items-schema :- LancasterSchemaOrNameKW] Returns: LancasterSchema

Creates a Lancaster schema object representing an Avro array with the given items schema.

boolean-schema clj/s

Lancaster schema object representing an Avro boolean.

bytes-schema clj/s

Lancaster schema object representing an Avro bytes.

child-schema clj/s≠

clj

(child-schema schema)

(child-schema schema field-kw-or-branch-i)

cljs

(child-schema G__13480)

(child-schema G__13484 G__13485)

Inputs: ([schema] [schema field-kw-or-branch-i]) Returns: LancasterSchema

Returns the child schema of the given schema

def-array-schema clj/s macro

(def-array-schema clj-name items-schema)

Defines a var whose value is a Lancaster array schema object

def-enum-schema clj/s macro

(def-enum-schema clj-name & args)

Defines a var whose value is a Lancaster enum schema object

def-fixed-schema clj/s macro

(def-fixed-schema clj-name size)

Defines a var whose value is a Lancaster fixed schema object

def-map-schema clj/s macro

(def-map-schema clj-name values-schema)

Defines a var whose value is a Lancaster map schema object

def-maybe-schema clj/s macro

(def-maybe-schema clj-name schema)

Defines a var whose value is a Lancaster union schema whose members are l/null-schema and the given schema. Makes a schema nillable.

def-record-schema clj/s macro

(def-record-schema clj-name & args)

Defines a var whose value is a Lancaster record schema object

def-union-schema clj/s macro

(def-union-schema clj-name & member-schemas)

Defines a var whose value is a Lancaster union schema object

default-data clj/s

(default-data schema)

Inputs: [schema :- LancasterSchema] Returns: s/Any

Creates default data that conforms to the given Lancaster schema.

deserialize clj/s≠

clj

(deserialize reader-schema writer-schema ba)

(deserialize reader-schema writer-schema ba opts)

cljs

(deserialize G__13381 G__13382 G__13383)

(deserialize G__13387 G__13388 G__13389 G__13390)

Inputs: ([reader-schema :- LancasterSchema writer-schema :- LancasterSchema ba :- ba/ByteArray] [reader-schema :- LancasterSchema writer-schema :- LancasterSchema ba :- ba/ByteArray opts :- DeserOptions]) Returns: s/Any

Deserializes Avro-encoded data from a byte array, using the given reader and writer schemas.

deserialize-same clj/s≠

clj

(deserialize-same schema ba)

(deserialize-same schema ba opts)

cljs

(deserialize-same G__13401 G__13402)

(deserialize-same G__13406 G__13407 G__13408)

Inputs: ([schema :- LancasterSchema ba :- ba/ByteArray] [schema :- LancasterSchema ba :- ba/ByteArray opts :- DeserOptions]) Returns: s/Any

Deserializes Avro-encoded data from a byte array, using the given schema as both the reader and writer schema. Note that this is not recommended, since the original writer's schema should always be used to deserialize. The writer's schema (in Parsing Canonical Form) should always be stored or transmitted with encoded data.

double-schema clj/s

Lancaster schema object representing an Avro double.

edn clj/s

(edn schema)

Inputs: [schema :- LancasterSchema] Returns: s/Any

Returns an EDN representation of the given Lancaster schema.

edn->schema clj/s

(edn->schema edn)

Inputs: [edn :- s/Any] Returns: LancasterSchema

enum-schema clj/s≠

clj

(enum-schema name-kw symbol-keywords)

(enum-schema name-kw docstring symbol-keywords)

cljs

(enum-schema G__13334 G__13335)

(enum-schema G__13339 G__13340 G__13341)

Inputs: ([name-kw :- s/Keyword symbol-keywords :- [s/Keyword]] [name-kw :- s/Keyword docstring :- s/Str symbol-keywords :- [s/Keyword]]) Returns: LancasterSchema

Creates a Lancaster schema object representing an Avro enum with the given symbol keywords. For a more concise way to declare an enum schema, see def-enum-schema.

fingerprint128 clj/s

(fingerprint128 schema)

Inputs: [schema :- LancasterSchema] Returns: ba/ByteArray

Returns the 128-bit MD5 digest of the Parsing Canonical Form of the given Lancaster schema.

fingerprint256 clj/s

(fingerprint256 schema)

Inputs: [schema :- LancasterSchema] Returns: ba/ByteArray

Returns the 256-bit SHA-256 hash of the Parsing Canonical Form of the given Lancaster schema.

fingerprint64 clj/s

(fingerprint64 schema)

Inputs: [schema :- LancasterSchema] Returns: Long

Returns the 64-bit Rabin fingerprint of the Parsing Canonical Form of the given Lancaster schema.

fixed-schema clj/s

(fixed-schema name-kw size)

Inputs: [name-kw :- s/Keyword size :- s/Int] Returns: LancasterSchema

Creates a Lancaster schema object representing an Avro fixed with the given size. For a more concise way to declare a fixed schema, see def-fixed-schema.

float-schema clj/s

Lancaster schema object representing an Avro float.

int-schema clj/s

Lancaster schema object representing an Avro int.

json clj/s

(json schema)

Inputs: [schema :- LancasterSchema] Returns: s/Str

Returns an Avro-compliant JSON representation of the given Lancaster schema.

json->schema clj/s

(json->schema json)

Inputs: [json :- s/Str] Returns: LancasterSchema

Creates a Lancaster schema object from an Avro schema in JSON format.

long-schema clj/s

Lancaster schema object representing an Avro long.

map-schema clj/s

(map-schema values-schema)

Inputs: [values-schema :- LancasterSchemaOrNameKW] Returns: LancasterSchema

Creates a Lancaster schema object representing an Avro map with the given values schema. Keys are always strings.

maybe clj/s

(maybe schema)

Inputs: [schema :- LancasterSchemaOrNameKW] Returns: LancasterSchema

Creates a Lancaster union schema whose members are l/null-schema and the given schema. Makes a schema nillable. If the given schema is a union, returns a schema with l/null-schema in the first postion. If the given union schema already has l/null-schema as a member, it is returned unchanged. Similarly, if the given schema is l/null-schema, it is returned unchanged.

member-schema-at-branch clj/s

(member-schema-at-branch union-schema branch-index)

Inputs: [union-schema :- LancasterSchema branch-index :- s/Int] Returns: LancasterSchema

Returns the member schema at the given union schema branch index.

member-schemas clj/s

(member-schemas union-schema)

Inputs: [union-schema :- LancasterSchema] Returns: [LancasterSchema]

Returns the member schemas of the given union schema.

name-kw clj/s

(name-kw schema)

Inputs: [schema :- LancasterSchema] Returns: s/Keyword

Returns the name keyword for the given Lancaster schema.

null-schema clj/s

Lancaster schema object representing an Avro null.

pcf clj/s

(pcf schema)

Inputs: [schema :- LancasterSchema] Returns: s/Str

Returns a JSON string containing the Avro Parsing Canonical Form of the given Lancaster schema.

plumatic-schema clj/s

(plumatic-schema schema)

Inputs: [schema :- LancasterSchema] Returns: s/Any

Returns a Plumatic schema for the given Lancaster schema.

record-schema clj/s≠

clj

(record-schema name-kw fields)

(record-schema name-kw docstring fields)

cljs

(record-schema G__13320 G__13321)

(record-schema G__13325 G__13326 G__13327)

Inputs: ([name-kw :- s/Keyword fields :- s/Any] [name-kw :- s/Keyword docstring :- s/Str fields :- s/Any]) Returns: LancasterSchema

Creates a Lancaster schema object representing an Avro record with the given field definitions. For a more concise way to declare a record schema, see def-record-schema.

schema-at-path clj/s≠

clj

(schema-at-path schema path)

(schema-at-path schema path {:keys [branches?] :as opts})

cljs

(schema-at-path G__13492 G__13493)

(schema-at-path G__13497 G__13498 G__13499)

Inputs: ([schema :- LancasterSchema path :- [s/Any]] [schema :- LancasterSchema path :- [s/Any] {:keys [branches?], :as opts} :- {(s/optional-key :branches?) s/Bool, s/Keyword s/Any}]) Returns: (s/maybe LancasterSchema)

schema-type clj/s

(schema-type schema)

Inputs: [schema :- LancasterSchema] Returns: s/Keyword

Returns the Avro type of the given schema

schema? clj/s

(schema? arg)

Inputs: [arg :- s/Any] Returns: s/Bool

Returns a boolean indicating whether or not the argument is a Lancaster schema object.

schemas-match? clj/s

(schemas-match? reader-schema writer-schema)

Inputs: [reader-schema :- LancasterSchema writer-schema :- LancasterSchema] Returns: s/Bool

Returns a boolean indicating whether or not the given reader and writer schemas match, according to the Avro matching rules.

serialize clj/s

(serialize writer-schema data)

Inputs: [writer-schema :- LancasterSchema data :- s/Any] Returns: ba/ByteArray

Serializes data to a byte array, using the given Lancaster schema.

string-schema clj/s

Lancaster schema object representing an Avro string.

string-set-schema clj/s

Lancaster schema object representing a Clojure set with string members. Implemented using an Avro map with null values.

union-schema clj/s

(union-schema member-schemas)

Inputs: [member-schemas :- [LancasterSchemaOrNameKW]] Returns: LancasterSchema

Creates a Lancaster schema object representing an Avro union with the given member schemas.