Liking cljdoc? Tell your friends :D

seql.helpers

A collection of functions and macros used to help building SEQL schemas conforming to the spec provided in :seql.core/schema

A collection of functions and macros used to help building
SEQL schemas conforming to the spec provided in :seql.core/schema
raw docstring

compoundcljmacro

(compound field source & body)

Create a compound field, which sources one or more fields from the base entity and yields a new computed value.

Create a compound field, which sources one
or more fields from the base entity and
yields a new computed value.
sourceraw docstring

conditionclj

(condition field)
(condition field from-field)
(condition field from-field value)

Build a condition which can be used to filter results at the database layer.

With a single arg, builds a condition bearing the name of a field to test pure equality.

With two args, builds a condition testing equality against the provided field name.

With three args, tests a field name against a provided value.

Build a condition which can be used to filter results
at the database layer.

With a single arg, builds a condition bearing the name
of a field to test pure equality.

With two args, builds a condition testing equality
against the provided field name.

With three args, tests a field name against a provided value.
sourceraw docstring

entityclj

(entity arg & components)

Provide an entity description. Expects either a keyword or a tuple of [entity-name table-name] and a list of details as expressed by field, compound, has-many, condition, and mutation

Provide an entity description. Expects either a keyword or a tuple
of `[entity-name table-name]` and a list of details as expressed by
`field`, `compound`, `has-many`, `condition`, and `mutation`
sourceraw docstring

fieldclj

(field id & details)

Define an entity field, with optional details. Possible detail functions include: transform, ident

Define an entity field, with optional details.
Possible detail functions include: `transform`,
`ident`
sourceraw docstring

has-manyclj

(has-many field [local remote])

Express a one to many relation between the current entity and a remote one, expects a tuple of local ID to (qualified) remote ID.

Express a one to many relation between the current
entity and a remote one, expects a tuple of local
ID to (qualified) remote ID.
sourceraw docstring

has-many-throughclj

(has-many-through field [local left right remote])
sourceraw docstring

has-oneclj

(has-one field [local remote])

Express a one to one relation between the current entity and a remote one, expects a tuple of local ID to (qualified) remote ID.

Express a one to one relation between the current
entity and a remote one, expects a tuple of local
ID to (qualified) remote ID.
sourceraw docstring

identclj

(ident)

Marks the current field as ident, used inside field definitions

Marks the current field as ident, used inside field definitions
sourceraw docstring

inline-conditioncljmacro

(inline-condition field args & body)

Provide a function tail which shall yield a honeysql fragment to express a where condition on a field.

Provide a function tail which shall yield a
honeysql fragment to express a where condition on
a field.
sourceraw docstring

make-schemaclj

(make-schema & entities)

Provide a complete schema of entites

Provide a complete schema of entites
sourceraw docstring

mutationcljmacro

(mutation mutation-name spec bindv & body)

Provide a function tail to perform a mutation against an entity

Provide a function tail to perform a mutation against an entity
sourceraw docstring

mutation-fnclj

(mutation-fn mutation-name spec handler)

Provide a function to perform a named mutation

Provide a function to perform a named mutation
sourceraw docstring

transformcljdeprecated

(transform short-name)
(transform out in)

Provide transformation for the field. Transformations can either be a keyword, pointing to a known transformation (see transforms for details), or a tuple of [deserializer serializer]

Provide transformation for the field. Transformations
can either be a keyword, pointing to a known transformation
(see `transforms` for details), or a tuple of
`[deserializer serializer]`
sourceraw docstring

transformsclj

Commonly needed transforms for transform

Commonly needed transforms for `transform`
sourceraw docstring

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

× close