deercreeklabs.lancaster — deercreeklabs/lancaster 0.6.6

array-schema clj/s

(array-schema items-schema)

Inputs: [items-schema :- LancasterSchema] 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.

data clj/s

(data wrapped-data)

Inputs: [wrapped-data :- schemas/WrappedData] Returns: s/Any

Returns the data portion of wrapped data.

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

clj

(def-enum-schema clj-name & symbol-keywords)

cljs

(def-enum-schema &form &env clj-name & symbol-keywords)

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-flex-map-schema clj/s macro

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

Defines a var whose value is a Lancaster flex-map 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-merged-record-schema clj/s≠ macro

clj

(def-merged-record-schema clj-name & record-schemas)

cljs

(def-merged-record-schema &form &env clj-name & record-schemas)

Defines a var whose value is a Lancaster record schema which contains all the fields of all record schemas passed in.

def-record-schema clj/s≠ macro

clj

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

cljs

(def-record-schema &form &env clj-name & fields)

Defines a var whose value is a Lancaster record schema object

def-union-schema clj/s≠ macro

clj

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

cljs

(def-union-schema &form &env 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

(deserialize reader-schema writer-schema ba)

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

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

deserialize-same clj/s

(deserialize-same schema ba)

Inputs: [schema :- LancasterSchema ba :- ba/ByteArray] 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.

enum-schema clj/s

(enum-schema name-kw symbol-keywords)

Inputs: [name-kw :- s/Keyword symbol-keywords :- [s/Keyword]] Returns: LancasterSchema

Creates a Lancaster schema object representing an Avro enum with the given name and symbol keywords. For a more concise way to declare an enum schema, see def-enum-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 name and size. For a more concise way to declare a fixed schema, see def-fixed-schema.

flex-map-schema clj/s

(flex-map-schema name-kw keys-schema values-schema)

Inputs: [name-kw :- s/Keyword keys-schema :- LancasterSchema values-schema :- LancasterSchema] Returns: LancasterSchema

Creates a Lancaster schema object representing a map of keys to values, with the keys and values being described by the given schemas. Differs from map-schema, which only allows string keys.

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 cljs

long-schema clj/s

Lancaster schema object representing an Avro long.

map-schema clj/s

(map-schema values-schema)

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

Creates a Lancaster schema object representing an Avro map with the given values schema.

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.

merged-record-schema clj/s

(merged-record-schema name-kw schemas)

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

Creates a Lancaster record schema which contains all the fields of all record schemas passed in.

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

(record-schema name-kw fields)

Inputs: [name-kw :- s/Keyword fields :- [schemas/RecordFieldDef]] Returns: LancasterSchema

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

schema-name clj/s

(schema-name wrapped-data)

Inputs: [wrapped-data :- schemas/WrappedData] Returns: s/Keyword

Returns the schema-name portion of wrapped data.

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.

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.

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.

wrap clj/s

(wrap data-schema data)

Inputs: [data-schema :- LancasterSchema data :- s/Any] Returns: schemas/WrappedData

Wraps data for use in an ambiguous union.