grafter.matcha.alpha

Liking cljdoc? Tell your friends :D

Clojure only.

ask^cljmacro

(ask bgps)

(ask bgps db)

Predicate: are there results in a db-or-idx matching bgps patterns?

If called with 1 argument, returns a function of 1 argument: the db-or-idx.

If called with 2 arguments, queries the db-or-idx directly.

Predicate: are there results in a `db-or-idx` matching `bgps` patterns?

If called with 1 argument, returns a function of 1 argument: the `db-or-idx`.

If called with 2 arguments, queries the `db-or-idx` directly.

source raw docstring

build^cljmacro

(build subject construct-pattern bgps)

(build subject construct-pattern bgps db-or-idx)

Query a db-or-idx with bgps patterns, and return data grouped by subject and predicates into resource object maps.

subject can be a concrete value, a value bound in lexical scope, a ?query-var symbol used in the bgps or a 2-tuple key value pair of [:keyword ?query-var] or [:keyword :concrete-value]. If the vector form is used case :keyword will be the key used to identify the subject of the maps in the response. If only ?query-var or a concrete value and no :keyword is specified then the default keyword of :grafter.rdf/uri is used.

NOTE: unlike construct, build will eliminate any unbound variables from the response maps that may arrise from using an optional.

If called with 3 arguments, returns a function of 1 argument: the db-or-idx, which returns a sequence of results in the form of the construct-pattern.

If called with 4 arguments, queries the db-or-idx directly, returning a sequence of results in the form of the construct-pattern.

Query a `db-or-idx` with `bgps` patterns, and return data grouped by
subject and predicates into resource object maps.

`subject` can be a concrete value, a value bound in lexical scope, a
`?query-var` symbol used in the `bgps` or a 2-tuple key value pair
of `[:keyword ?query-var]` or [:keyword :concrete-value]. If the
vector form is used case `:keyword` will be the key used to identify
the subject of the maps in the response. If only `?query-var` or a
concrete value and no `:keyword` is specified then the default
keyword of `:grafter.rdf/uri` is used.

NOTE: unlike `construct`, `build` will eliminate any unbound
variables from the response maps that may arrise from using an
optional.

If called with 3 arguments, returns a function of 1 argument: the `db-or-idx`,
which returns a sequence of results in the form of the `construct-pattern`.

If called with 4 arguments, queries the `db-or-idx` directly, returning a
sequence of results in the form of the `construct-pattern`.

source raw docstring

build-1^cljmacro

(build-1 subject-kv construct-pattern bgps)

(build-1 subject construct-pattern bgps db-or-idx)

Like build but returns only the first resource object.

NOTE: it is not lazy, so to make this efficient you should be selective in your bgps.

Like `build` but returns only the first resource object.

NOTE: it is not lazy, so to make this efficient you should be
selective in your `bgps`.

source raw docstring

clause^cljmacro

(clause name & argspec)

source

collection?^clj

(collection? x)

source

construct^cljmacro

(construct construct-pattern bgps)

(construct construct-pattern bgps db-or-idx)

NOTE: If you want to construct maps, you will likely be better using build instead.

Query a db-or-idx with bgps patterns, and return data in the form of the construct-pattern.

If called with 2 arguments, returns a function of 1 argument: the db-or-idx, which returns a sequence of results in the form of the construct-pattern.

If called with 3 arguments, queries the db-or-idx directly, returning a sequence of results in the form of the construct-pattern.

NOTE: If you want to construct maps, you will likely be better
using `build` instead.

Query a `db-or-idx` with `bgps` patterns, and return data in the
form of the `construct-pattern`.

If called with 2 arguments, returns a function of 1 argument: the `db-or-idx`,
which returns a sequence of results in the form of the `construct-pattern`.

If called with 3 arguments, queries the `db-or-idx` directly, returning a
sequence of results in the form of the `construct-pattern`.

source raw docstring

construct-1^cljmacro

(construct-1 construct-pattern bgps)

(construct-1 construct-pattern bgps db)

Query a db-or-idx with bgps patterns, and return data in the form of the construct-pattern.

If called with 2 arguments, returns a function of 1 argument: the db-or-idx, which returns the first result in the form of the construct-pattern.

If called with 3 arguments, queries the db-or-idx directly, returning the first result in the form of the construct-pattern.

Query a `db-or-idx` with `bgps` patterns, and return data in the form of the
`construct-pattern`.

If called with 2 arguments, returns a function of 1 argument: the `db-or-idx`,
which returns the first result in the form of the `construct-pattern`.

If called with 3 arguments, queries the `db-or-idx` directly, returning the
first result in the form of the `construct-pattern`.

source raw docstring

extract-validation^clj

(extract-validation bound-vars conformed-bgps)

source

find-vars-in-tree^clj

(find-vars-in-tree tree)

source

group-subjects-for-build^clj

(group-subjects-for-build subject-k solutions)

source

group-subjects-for-construct^clj

(group-subjects-for-construct construct-pattern solutions)

source

index-triples^clj

(index-triples db)

Return an indexed database of triples. Indexing a database will result in better performance if you want to run multiple queries over the same database.

All query functions should accept either a sequence of triples or an indexed database.

Return an indexed database of triples. Indexing a database will
result in better performance if you want to run multiple queries
over the same database.

All query functions should accept either a sequence of triples or an
indexed database.

source raw docstring

merge-dbs^clj

(merge-dbs & dbs)

Merges all supplied Matcha databases together into one. Any individual database form can either be indexed already with index-triples, or a sequence of triples, in which case the triples will be indexed before being combined with any other databases.

Merges all supplied Matcha databases together into one.  Any
individual database form can either be indexed already with
index-triples, or a sequence of triples, in which case the triples
will be indexed before being combined with any other databases.

source raw docstring

optional^cljmacro

(optional _bgps)

Makes a graph pattern optional. I.E., the pattern inside (optional [...]) is optional, patterns outside are required. Can be arbitrarily nested. MUST be used inside a (select|construct|ask|etc) query.

SYNTAX: (optional bgps) bgps: ::bgps

E.G., (select [?o ?eman] [[?person foaf:knows somebody] (optional [[?o rdfs:label ?name] (optional [[?name :name/backwards ?eman] (values ?name names)])])] optional-friends)

Makes a graph pattern optional. I.E., the pattern inside (optional [...]) is
optional, patterns outside are required. Can be arbitrarily nested. MUST be
used inside a (select|construct|ask|etc) query.

SYNTAX: (optional bgps)
        bgps: ::bgps

E.G.,
(select [?o ?eman]
  [[?person foaf:knows somebody]
   (optional [[?o rdfs:label ?name]
              (optional [[?name :name/backwards ?eman]
                         (values ?name names)])])]
  optional-friends)

source raw docstring

query-var?^clj

(query-var? sym)

Test whether supplied sym is a query variable. Query variables are symbols who's name begin with a ?.

Test whether supplied sym is a query variable.  Query variables are
symbols who's name begin with a ?.

source raw docstring

replace-vars-with-vals^clj

(replace-vars-with-vals construct-pattern binding-maps)

source

require-grafter-protocols^clj

(require-grafter-protocols require-form)

source

resolve-sym^clj

(resolve-sym x)

source

select^cljmacro

(select bgps)

(select project-vars bgps)

(select project-vars bgps db-or-idx)

Query a db-or-idx with bgps patterns.

If called with 1 argument, select finds all ?vars in the bgps patterns and returns a function of 1 argument: the db-or-idx, which returns a sequence of results.

If called with 2 arguments, returns a function of 1 argument: the db-or-idx, which returns a sequence of results with the ?vars in project-vars projected.

If called with 3 arguments, queries the db-or-idx directly, returning a sequence of results with the ?vars in project-vars projected.

Query a `db-or-idx` with `bgps` patterns.

If called with 1 argument, `select` finds all `?vars` in the `bgps` patterns
and returns a function of 1 argument: the `db-or-idx`, which returns a
sequence of results.

If called with 2 arguments, returns a function of 1 argument: the `db-or-idx`,
which returns a sequence of results with the `?vars` in `project-vars`
projected.

If called with 3 arguments, queries the `db-or-idx` directly, returning a
sequence of results with the `?vars` in `project-vars` projected.

source raw docstring

select-1^cljmacro

(select-1 bgps)

(select-1 project-vars bgps)

(select-1 project-vars bgps db)

Query a db-or-idx with bgps patterns.

If called with 1 argument, select finds all ?vars in the bgps patterns and returns a function of 1 argument: the db-or-idx, which returns the first result.

If called with 2 arguments, returns a function of 1 argument: the db-or-idx, which returns the first result with ?vars in project-varsprojected.

If called with 3 arguments, queries the db-or-idx directly, returning the first result with ?vars in project-vars projected.

Query a `db-or-idx` with `bgps` patterns.

If called with 1 argument, `select` finds all `?vars` in the `bgps` patterns
and returns a function of 1 argument: the `db-or-idx`, which returns the first
result.

If called with 2 arguments, returns a function of 1 argument: the `db-or-idx`,
which returns the first result with `?vars` in `project-vars`projected.

If called with 3 arguments, queries the `db-or-idx` directly, returning the
first result with `?vars` in `project-vars` projected.

source raw docstring

triple^clj

source

triple-vector->idx-triple^clj

(triple-vector->idx-triple [s p o])

Assume triples are either 3/tuple vectors or can be destructured as such. Grafter Quad objects can be destructured in this manner.

Assume triples are either 3/tuple vectors or can be destructured as
such.  Grafter Quad objects can be destructured in this manner.

source raw docstring

unify-solutions^clj

(unify-solutions projected-vars solutions)

source

valid-bgps?^clj

(valid-bgps? bgps-syms)

source

valid-values?^clj

(valid-values? values-syms)

source

values^cljmacro

(values _binding _bound-value)

Binds a ?qvar binding to elements of a set inside the query. MUST be used inside a (select|construct|ask|etc) query.

SYNTAX: (values binding bound-value) binding: ?qvar bound-value: any?

E.G., (let [subjects #{:a :b :c}] (select [?s ?p ?o] [[?s ?p ?o] (values ?s subjects)]))

Binds a ?qvar binding to elements of a set inside the query. MUST be used
inside a (select|construct|ask|etc) query.

SYNTAX: (values binding bound-value)
        binding: ?qvar
        bound-value: any?

E.G.,
(let [subjects #{:a :b :c}]
  (select [?s ?p ?o]
    [[?s ?p ?o]
     (values ?s subjects)]))

source raw docstring

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

Keyboard shortcuts Report a problem cljdoc on GitHub

× close