miladb.api — in.a6n.miladb/zero 0.110

as-of clj

(as-of db-value t)

Returns the value of the database as of some point t, inclusive.

t may be a transaction number, transaction entity id, lookup ref, Date, or Instant.

as-of-t clj

(as-of-t db-value)

Returns the as-of point, or nil if none.

attribute clj

(attribute db attrid)

Returns attribute metadata for an ident, schema entity id, or Mila aid.

basis-t clj

(basis-t db-value)

Returns the tx-id of the most recent transaction reachable via this db value.

For as-of db values this is the pinned tx-id.

blob-schema clj

System schema for keyed, content-addressed blobs.

Intended usage:

• Install once: (transact conn blob-schema)
• Create: {:miladb.blob/key :docs/readme, :miladb.blob/data bytes}
• Lookup: (entity db [:miladb.blob/key :docs/readme])

closed? clj

(closed? conn)

conn? clj

(conn? v)

connect clj

(connect path)

(connect path opts)

Open an existing MilaDB database file.

The target file must already have been initialized via create-database.

Supported options include the underlying bbolt write options such as :no-sync. :tx-report :early causes tx-report-queue publication to happen before the final durability flush when sync is otherwise enabled. The default is :tx-report :after-sync.

Transactions (transact) block until the flush completes, but queue consumers can observe the tx-report before flushing is completed. The default is :tx-report :after-sync. With :no-sync true, :tx-report has no effect.

create-database clj

(create-database path)

(create-database path opts)

Create and initialize a MilaDB database file.

When opts contains :schema, install that user schema during initialization.

datoms clj

(datoms db index & components)

Return datoms for an index and optional components.

Components are interpreted in logical datom order for the selected index:

• :eavt: [e a v tx]
• :aevt: [a e v tx]
• :avet: [a v e tx]
• :vaet: [v a e tx]

Supplied components narrow the result by matching a leading prefix of that logical order.

• :eavt and :aevt contain all datoms.
• :avet contains datoms for attributes where :db/index or :db/unique is true.
• :vaet contains datoms for reference attributes and serves as the reverse index.

Returns a realized seq of datoms.

db clj

(db conn)

Return the current db value for a connection.

db-stats clj

(db-stats db)

Queries for database stats.

entid clj

(entid db ident)

Returns the entity id associated with a symbolic keyword, or the id itself if passed.

entity clj

(entity db eid)

Return an entity view for an id, ident, or lookup ref.

entity-db clj

(entity-db entity)

Returns the database value that is the basis for this entity.

history clj

(history db)

Return a history db view.

ident clj

(ident db eid)

Returns the keyword associated with an id, or the key itself if passed.

pull clj

(pull db pattern eid & {:as options})

Pull entity data

pull-many clj

(pull-many db pattern eids & {:as options})

Pull many entities

q clj

(q query & args)

query-stats clj

(query-stats query & args)

release clj

(release conn)

Close a MilaDB connection.

remove-tx-report-queue clj

(remove-tx-report-queue conn queue)

Detach the shared tx report queue from conn.

seek-datoms clj

(seek-datoms db index & components)

Seek into an index and return a reducible datom scan source.

Unlike datoms, the supplied components establish the initial search position and does not bind the result. Iteration continues to the end of the physical index unless the reduction terminates early!

WARNING: each reduction holds a read transaction open for the duration of the reduction. Prefer into/transduce with take, take-while, or another early-terminating transducer when possible.

ATTENTION: Leaky abstraction of physical on-disk layout! Accepted component shapes must align to a true leading prefix of the physical index keys:

• :eavt: [], [e], [e a] on-disk layout: (e, a, t*, retract?, v)
• :aevt: [], [a], [a e] on-disk layout: (a, e, t*, retract?, v)
• :avet: [], [a], [a v], [a v e] on-disk layout: (a, v, e, t*)
• :vaet: [], [v a], [v a e] on-disk layout: (v, a, e, t*)

since clj

(since db-value tx-id)

Return a db value filtered since a tx-id.

touch clj

(touch entity)

Touch an entity to realize attributes and return a realized entity map.

transact clj

(transact conn tx-data)

Given a connection and a set of information (tx-data), submits a transaction and blocks until a result is available. transact updates the connection's shared reference to the current database value by swapping in the :db-after value produced by with.

Returns a transaction report map. The report includes at least :db-before, :db-after, :tx-data, :tempids, and :tx-id.

tx-data follows the same transaction forms accepted by with, including entity maps and transaction operation vectors such as :db/add, :db/retract, :db.fn/retractEntity, and :db.fn/retractAttribute.

An exception indicates that the transaction failed and no result was committed.

If a tx report queue is attached via tx-report-queue, the transaction report is also published there.

tx-report-queue clj

(tx-report-queue conn)

Register or return the shared buffered tx report queue for conn.

with clj

(with db tx-data)

Apply a transaction to a db value without persisting it.