Liking cljdoc? Tell your friends :D

fluree.db.api.query


block-query-asyncclj/s

(block-query-async conn ledger {:keys [opts] :as query})

block-rangeclj/s

(block-range db start)
(block-range db start end)
(block-range db start end opts)

Returns a core async channel of blocks from start block (inclusive) to end if provided (exclusive). Each block is a separate map, containing keys :block, :t and :flakes. Channel is lazy, continue to take! values as needed.

Returns a core async channel of blocks from start block (inclusive) to end if provided (exclusive).
Each block is a separate map, containing keys :block, :t and :flakes.
Channel is lazy, continue to take! values as needed.
raw docstring

dbclj/s

(db conn ledger)
(db conn ledger opts)

Returns a queryable database as a promise channel from the connection for the specified ledger.

Returns a queryable database as a promise channel from the connection for the specified ledger.
raw docstring

db-ident?clj/s

(db-ident? source)

get-history-patternclj/s

(get-history-pattern history)

history-query-asyncclj/s

(history-query-async sources query-map)

multi-query-asyncclj/s

(multi-query-async source flureeQL)

Performs multiple queries in a map, with the key being the alias for the query and the value being the query itself - standard, history, and block queries are all supported. Each query result will be in a response map with its respective alias as the key.

If a :block is specified at the top level, it will be used as a default for all queries

If any errors occur, an :errors key will be present with a map of each alias to its error information. Check for the presence of this key if detection of an error is important.

An optional :opts key contains options, which for now is limited to:

  • meta: true or false - If false, will just report out the result as a map. If true will roll up all status and fuel consumption. Response map will contain keys: - status - aggregate status (200 all good, 207 some good, or 400+ for differing errors - fuel - aggregate fuel for all queries - result - query result - errors - map of query alias to their respective error
Performs multiple queries in a map, with the key being the alias for the query
and the value being the query itself - standard, history, and block queries are all supported.
Each query result will be in a response map with its respective alias as the key.

If a :block is specified at the top level, it will be used as a default for all queries

If any errors occur, an :errors key will be present with a map of each alias to its error
information. Check for the presence of this key if detection of an error is important.

An optional :opts key contains options, which for now is limited to:
 - meta: true or false - If false, will just report out the result as a map.
         If true will roll up all status and fuel consumption. Response map will contain keys:
         - status - aggregate status (200 all good, 207 some good, or 400+ for differing errors
         - fuel   - aggregate fuel for all queries
         - result - query result
         - errors - map of query alias to their respective error
raw docstring

queryclj/s

(query source flureeQL)

Generic query interface. Will determine if multi-query, standard query, block or history and dispatch appropriately.

For now, sources is expected to be just a db. In the case of a block query, which requires a conn + ledger, those will be extracted from the db.

Generic query interface. Will determine if multi-query, standard query, block or history
and dispatch appropriately.

For now, sources is expected to be just a db. In the case of a block query, which requires
a conn + ledger, those will be extracted from the db.
raw docstring

query-asyncclj/s

(query-async sources flureeQL)

Execute a query against a database source, or optionally additional sources if the query spans multiple data sets. Returns core async channel containing result.

Execute a query against a database source, or optionally
additional sources if the query spans multiple data sets.
Returns core async channel containing result.
raw docstring

query-typeclj/s

(query-type flureeQL)

Returns keyword of query type by inspecting flureeQL query.

Query types are: :standard - basic or analytical query :multi - multi-query :block - block query :history - history query

Returns keyword of query type by inspecting flureeQL query.

Query types are:
  :standard - basic or analytical query
  :multi - multi-query
  :block - block query
  :history - history query
raw docstring

resolve-block-rangeclj/s

(resolve-block-range db query-map)

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

× close