Liking cljdoc? Tell your friends :D

deercreeklabs.lancaster


array-schemaclj/s

(array-schema items-schema)

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

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

boolean-schemaclj/s

Lancaster schema object representing an Avro boolean.

Lancaster schema object representing an Avro boolean.
raw docstring

bytes-schemaclj/s

Lancaster schema object representing an Avro bytes.

Lancaster schema object representing an Avro bytes.
raw docstring

child-schemaclj/s

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

Returns the child schema of the given schema

Returns the child schema of the given schema
raw docstring

def-array-schemaclj/smacro

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

Defines a var whose value is a Lancaster array schema object

Defines a var whose value is a Lancaster array schema object
raw docstring

def-enum-schemaclj/smacro

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

Defines a var whose value is a Lancaster enum schema object

Defines a var whose value is a Lancaster enum schema object
raw docstring

def-fixed-schemaclj/smacro

(def-fixed-schema clj-name size)

Defines a var whose value is a Lancaster fixed schema object

Defines a var whose value is a Lancaster fixed schema object
raw docstring

def-map-schemaclj/smacro

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

Defines a var whose value is a Lancaster map schema object

Defines a var whose value is a Lancaster map schema object
raw docstring

def-maybe-schemaclj/smacro

(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.

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

def-record-schemaclj/smacro

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

Defines a var whose value is a Lancaster record schema object

Defines a var whose value is a Lancaster record schema object
raw docstring

def-union-schemaclj/smacro

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

Defines a var whose value is a Lancaster union schema object

Defines a var whose value is a Lancaster union schema object
raw docstring

default-dataclj/s

(default-data schema)

Creates default data that conforms to the given Lancaster schema.

Creates default data that conforms to the given Lancaster schema.
raw docstring

deserializeclj/s

(deserialize reader-schema writer-schema ba)
(deserialize reader-schema writer-schema ba opts)

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

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

deserialize-sameclj/s

(deserialize-same schema ba)
(deserialize-same schema ba opts)

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.

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.
raw docstring

double-schemaclj/s

Lancaster schema object representing an Avro double.

Lancaster schema object representing an Avro double.
raw docstring

ednclj/s

(edn schema)

Returns an EDN representation of the given Lancaster schema.

Returns an EDN representation of the given Lancaster schema.
raw docstring

edn->schemaclj/s

(edn->schema edn)

enum-schemaclj/s

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

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.

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.
raw docstring

fingerprint128clj/s

(fingerprint128 schema)

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

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

fingerprint256clj/s

(fingerprint256 schema)

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

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

fingerprint64clj/s

(fingerprint64 schema)

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

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

fixed-schemaclj/s

(fixed-schema name-kw size)

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.

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.
raw docstring

float-schemaclj/s

Lancaster schema object representing an Avro float.

Lancaster schema object representing an Avro float.
raw docstring

int-schemaclj/s

Lancaster schema object representing an Avro int.

Lancaster schema object representing an Avro int.
raw docstring

jsonclj/s

(json schema)

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

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

json->schemaclj/s

(json->schema json)

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

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

long-schemaclj/s

Lancaster schema object representing an Avro long.

Lancaster schema object representing an Avro long.
raw docstring

map-schemaclj/s

(map-schema values-schema)

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

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

maybeclj/s

(maybe schema)

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.

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.
raw docstring

member-schema-at-branchclj/s

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

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

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

member-schemasclj/s

(member-schemas union-schema)

Returns the member schemas of the given union schema.

Returns the member schemas of the given union schema.
raw docstring

name-kwclj/s

(name-kw schema)

Returns the name keyword for the given Lancaster schema.

Returns the name keyword for the given Lancaster schema.
raw docstring

null-schemaclj/s

Lancaster schema object representing an Avro null.

Lancaster schema object representing an Avro null.
raw docstring

pcfclj/s

(pcf schema)

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

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

record-schemaclj/s

(record-schema name-kw fields)
(record-schema name-kw docstring fields)

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.

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.
raw docstring

schema-at-pathclj/s

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

schema-typeclj/s

(schema-type schema)

Returns the Avro type of the given schema

Returns the Avro type of the given schema
raw docstring

schema?clj/s

(schema? arg)

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

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

schemas-match?clj/s

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

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

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

serializeclj/s

(serialize writer-schema data)

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

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

string-schemaclj/s

Lancaster schema object representing an Avro string.

Lancaster schema object representing an Avro string.
raw docstring

string-set-schemaclj/s

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

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

union-schemaclj/s

(union-schema member-schemas)

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

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

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close