IF Commons GitHub

logical/execute

Written to: 7 requirements: 7 proved, 0 partly, 0 failing, 0 with no test recorded. 0003-query-planning FR-002, 0003-query-planning FR-003, 0003-query-planning FR-004, 0003-query-planning FR-005, 0003-query-planning FR-006, 0003-query-planning FR-007 and 1 more

A query run (commons anyfs-query 0003-query-planning, 0004-query-safety): the plan of a query is carried out over the store of its place, listing only below the prefix its filter allows, answering from the listing what the listing answers, and reading an object only when the listing has left it and the consent and the budget allow. The operations it uses are list, stat, history and read, and no others. A run that reaches a limit says so in its result, with the rows it has.

Source: commons/anyfs-query/src/logical/execute.ts

3 of 6 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

Queriedtypeno test imports it
type Queried = {
  readonly columns: readonly OutColumn[];
  readonly rows: readonly Row[];
  /** The limit the run ended at, short of its end, or nothing where it ended. */
  readonly truncated: Truncation | undefined;
  readonly stats: Stats;
  /** The plan and what the run did, as text. */
  readonly explained: string;
};

What a query gave.

listingRowfunctionno test imports it
function listingRow(place: string, s: Stat): Readonly<Record<string, Value>>

The row a listing gives for an object.

reachOffunction
function reachOf(base: Prefix, bound: Bound): Reach

Where a query lists: the prefix of its place, narrowed by what its filter says.

Imported by 8 tests of the run (8 passed, 0 failed): the library's results

describeRunfunctionno test imports it
function describeRun(ctx: QueryContext, p: Prepared): string

The plan of a run and what the run would do, as text, with no store called.

explainQueryfunction
function explainQuery(ctx: QueryContext, queryText: string): Result<string, QueryProblem>

What a query would do, as text, with no store called.

Imported by 8 tests of the run (8 passed, 0 failed): the library's results

queryfunction
function query(ctx: QueryContext, queryText: string): Promise<Result<Queried, QueryProblem>>

Runs a query.

Imported by 25 tests of the run (25 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.