Full SCM API documentation: Difference between revisions
No edit summary |
Wikiservice (talk | contribs) (Refresh MemCP documentation: accuracy, operational guidance, performance profile and maintained API reference) |
||
| Line 1: | Line 1: | ||
= | <!-- Copyright (C) 2026 Carl-Philip Haensch --> | ||
<!-- SPDX-License-Identifier: GPL-3.0-or-later --> | |||
= Full SCM API documentation = | |||
<div class="mw-message-box mw-message-box-notice">This reference was generated from MemCP commit <code>c42e19eba</code> on 27 August 2026. Runtime declarations are authoritative for this version.</div> | |||
The SCM API is the low-level programming interface of MemCP's embedded Scheme runtime. It contains general language primitives as well as internal functions used by SQL parsers, generated query plans, storage operations, transactions, dashboards, and application handlers. SQL users do not normally call most storage or planner-facing functions directly. | |||
Each chapter begins with a maintained overview and then lists declarations generated from the runtime's type metadata. Parameter counts, optional and variadic arguments, return types, and function descriptions therefore track the referenced commit. Some names are implementation primitives whose contracts assume generated quoting, transaction contexts, or ownership rules; follow the linked conceptual documentation before using them in handwritten Scheme. | |||
* [[SCM Builtins]] | * [[SCM Builtins]] | ||
| Line 7: | Line 15: | ||
* [[Lists]] | * [[Lists]] | ||
* [[Associative Lists / Dictionaries]] | * [[Associative Lists / Dictionaries]] | ||
* [[Date]] | * [[Date]] | ||
* [[Timezone]] | * [[Timezone]] | ||
| Line 13: | Line 20: | ||
* [[Parsers]] | * [[Parsers]] | ||
* [[Sync]] | * [[Sync]] | ||
* [[Window Functions]] | |||
* [[JIT Compilation]] | |||
* [[IO]] | * [[IO]] | ||
* [[Storage]] | * [[Storage]] | ||
* [[Dashboard Metrics]] | |||
* [[Transactions]] | * [[Transactions]] | ||
Latest revision as of 11:59, 28 August 2026
Full SCM API documentation
The SCM API is the low-level programming interface of MemCP's embedded Scheme runtime. It contains general language primitives as well as internal functions used by SQL parsers, generated query plans, storage operations, transactions, dashboards, and application handlers. SQL users do not normally call most storage or planner-facing functions directly.
Each chapter begins with a maintained overview and then lists declarations generated from the runtime's type metadata. Parameter counts, optional and variadic arguments, return types, and function descriptions therefore track the referenced commit. Some names are implementation primitives whose contracts assume generated quoting, transaction contexts, or ownership rules; follow the linked conceptual documentation before using them in handwritten Scheme.