SqliteEngine.Procedures (SqliteEngine v0.1.0)

Copy Markdown View Source

Immutable, bounded native Luau application procedures.

A physical SQLite connection owns one warm VM. Procedure source is installed once in the database and lazily compiled by digest on each connection. Use apply_batch/3 for an ordered host-owned transaction, receipts, and durable results; use apply_batch_in_transaction/3 only on an already checked-out active transaction.

Summary

Functions

apply_batch(conn, commands, opts \\ [])

Applies an ordered heterogeneous batch in one native call and transaction.

apply_batch_in_transaction(conn, commands, opts \\ [])

Applies a batch inside the caller's already-active transaction.

call(conn, key, arguments, opts \\ [])

Calls one key in a host-owned transaction and returns its inline value.

delete(conn, key, opts \\ [])

Deletes future catalog availability. Keys already warm remain loaded.

delete_result(conn, result, opts \\ [])

Deletes a result only when no retained receipt requires it.

exists?(conn, key)

Returns whether an immutable procedure key exists.

fetch_result(conn, result, opts \\ [])

Fetches and verifies one bounded durable canonical result.

info(conn, key, opts \\ [])

Returns catalog information for one key. Source is opt-in.

install(conn, source, opts \\ [])

Installs exact immutable Luau source and returns its SHA-256 key.

list(conn, opts \\ [])

Lists a deterministic bounded catalog page ordered by key.

lookup_receipt(conn, command_id, opts \\ [])

Looks up a definitive committed command receipt.

prune_results(conn, opts)

Prunes at most :limit results and their receipts using a caller cutoff.

stats(conn, opts \\ [])

Returns connection-local VM/cache/memory counters.

warm(conn, keys, opts \\ [])

Warms only the selected keys on this physical connection.

Functions

apply_batch(conn, commands, opts \\ [])

Applies an ordered heterogeneous batch in one native call and transaction.

apply_batch_in_transaction(conn, commands, opts \\ [])

Applies a batch inside the caller's already-active transaction.

call(conn, key, arguments, opts \\ [])

Calls one key in a host-owned transaction and returns its inline value.

delete(conn, key, opts \\ [])

Deletes future catalog availability. Keys already warm remain loaded.

delete_result(conn, result, opts \\ [])

Deletes a result only when no retained receipt requires it.

exists?(conn, key)

Returns whether an immutable procedure key exists.

fetch_result(conn, result, opts \\ [])

Fetches and verifies one bounded durable canonical result.

info(conn, key, opts \\ [])

Returns catalog information for one key. Source is opt-in.

install(conn, source, opts \\ [])

@spec install(SqliteEngine.Sqlite3.db() | DBConnection.conn(), binary(), keyword()) ::
  {:ok, SqliteEngine.Procedures.Procedure.t()}
  | {:error, SqliteEngine.ProcedureError.t()}

Installs exact immutable Luau source and returns its SHA-256 key.

list(conn, opts \\ [])

Lists a deterministic bounded catalog page ordered by key.

lookup_receipt(conn, command_id, opts \\ [])

Looks up a definitive committed command receipt.

prune_results(conn, opts)

Prunes at most :limit results and their receipts using a caller cutoff.

stats(conn, opts \\ [])

Returns connection-local VM/cache/memory counters.

warm(conn, keys, opts \\ [])

Warms only the selected keys on this physical connection.