Liking cljdoc? Tell your friends :D

deercreeklabs.lancaster


array-schemaclj/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.

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

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≠

clj
(child-schema schema)
(child-schema schema field-kw-or-branch-i)
cljs
(child-schema G__13483)
(child-schema G__13487 G__13488)

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

Returns the child schema of the given schema

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

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-map-schemaclj/smacro

(def-fixed-map-schema clj-name key-size values-schema)

Defines a var whose value is an fixed-map-schema object

Defines a var whose value is an fixed-map-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-int-map-schemaclj/smacro

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

Defines a var whose value is an int-map-schema object

Defines a var whose value is an int-map-schema object
raw docstring

def-long-map-schemaclj/smacro

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

Defines a var whose value is an long-map-schema object

Defines a var whose value is an long-map-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)

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

Creates default data that conforms to the given Lancaster schema.

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

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

deserializeclj/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.

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

deserialize-sameclj/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.

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

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

Returns an EDN representation of the given Lancaster schema.

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

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

edn->schemaclj/s

(edn->schema edn)

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

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

enum-schemaclj/s≠

clj
(enum-schema name-kw symbol-keywords)
(enum-schema name-kw docstring symbol-keywords)
cljs
(enum-schema G__13356 G__13357)
(enum-schema G__13361 G__13362 G__13363)

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.

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

fingerprint128clj/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.

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

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

fingerprint256clj/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.

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

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

fingerprint64clj/s

(fingerprint64 schema)

Inputs: [schema :- LancasterSchema] Returns: Long

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

Inputs: [schema :- LancasterSchema]
Returns: Long

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

fixed-map-schemaclj/s

(fixed-map-schema name-kw key-size values-schema)

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

Creates a Lancaster schema object representing a map of `long` keys
to values described by the given `values-schema`.
Differs from map-schema, which only allows string keys.
raw docstring

fixed-schemaclj/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.

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

float-schemaclj/s

Lancaster schema object representing an Avro float.

Lancaster schema object representing an Avro float.
raw docstring

int-map-schemaclj/s

(int-map-schema name-kw values-schema)

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

Creates a Lancaster schema object representing a map of `int` keys
to values described by the given `values-schema`.
Differs from map-schema, which only allows string keys.
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)

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

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

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

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

json->schemaclj/s

(json->schema json)

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

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

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

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

keyword-schemaclj/s

Lancaster schema object representing a (possibly namespaced) Clojure keyword.

Lancaster schema object representing a (possibly namespaced)
Clojure keyword.
raw docstring

long-map-schemaclj/s

(long-map-schema name-kw values-schema)

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

Creates a Lancaster schema object representing a map of `long` keys
to values described by the given `values-schema`.
Differs from map-schema, which only allows string keys.
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)

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

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

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

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

maybeclj/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.

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

member-schema-at-branchclj/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.

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

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

member-schemasclj/s

(member-schemas union-schema)

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

Returns the member schemas of the given union schema.

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

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

name-kwclj/s

(name-kw schema)

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

Returns the name keyword for the given Lancaster schema.

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

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)

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

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

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

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

plumatic-schemaclj/s

(plumatic-schema schema)

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

Returns a Plumatic schema for the given Lancaster schema.

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

Returns a Plumatic schema for the given Lancaster schema.
raw docstring

record-schemaclj/s≠

clj
(record-schema name-kw fields)
(record-schema name-kw docstring fields)
cljs
(record-schema G__13342 G__13343)
(record-schema G__13347 G__13348 G__13349)

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.

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

schema-at-pathclj/s≠

clj
(schema-at-path schema path)
(schema-at-path schema path {:keys [branches?] :as opts})
cljs
(schema-at-path G__13495 G__13496)
(schema-at-path G__13500 G__13501 G__13502)

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)

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

schema-typeclj/s

(schema-type schema)

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

Returns the Avro type of the given schema

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

Returns the Avro type of the given schema
raw docstring

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.

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

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)

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.

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

serializeclj/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.

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

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)

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

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

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

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