docs: make the facade's own example run on the default wire #95

Merged
yuris merged 1 commit from fix-header-example into main 2026-08-21 11:33:27 +00:00
Owner

Comment-only. Found while sweeping the wiki for the same class of claim, after #94 merged.

stdb/init.lua's header is the SDK's front door, and every line of its example fails on the default it sets three hundred lines below: a hand-written schema has no types, so its table is skipped and reported rather than decoded; db:subscribe raises; call_reducer raises at the call without reducers. All three were correct before the flip and wrong the moment it landed.

The example now generates its schema and passes reducers/procedures, uses subscribe_query, and says why each is a requirement on BSATN rather than an upgrade — naming the v1 opt-out, where a hand-written schema is still fine.

Lands after the v2.0.0 tag deliberately. Re-pointing a published tag to fix a comment is worse than shipping the fix on main, and no consumer's code is affected.

Comment-only. Found while sweeping the wiki for the same class of claim, after #94 merged. `stdb/init.lua`'s header is the SDK's front door, and every line of its example fails on the default it sets three hundred lines below: a hand-written schema has no `types`, so its table is skipped and reported rather than decoded; `db:subscribe` raises; `call_reducer` raises at the call without `reducers`. All three were correct before the flip and wrong the moment it landed. The example now generates its schema and passes `reducers`/`procedures`, uses `subscribe_query`, and says why each is a requirement on BSATN rather than an upgrade — naming the v1 opt-out, where a hand-written schema is still fine. Lands after the `v2.0.0` tag deliberately. Re-pointing a published tag to fix a comment is worse than shipping the fix on `main`, and no consumer's code is affected.
docs: make the facade's own example run on the default wire
All checks were successful
ci / ci (pull_request) Successful in 1m28s
conformance / conformance (v1) (pull_request) Successful in 2m52s
conformance / conformance (v2) (pull_request) Successful in 3m5s
4a35e5fd0f
stdb/init.lua's header is the SDK's front door, and every line of its example
now fails on the default it sets three hundred lines below: a hand-written
schema has no `types`, so its table is skipped and reported rather than
decoded; `db:subscribe` raises; and `call_reducer` raises at the call without
`reducers`. Correct before the flip, wrong the moment it landed.

The example now generates its schema and passes reducers/procedures, uses
subscribe_query, and says why each is a requirement on BSATN rather than an
upgrade -- with the v1 opt-out named, since a hand-written schema is still fine
there.

Comment-only; found while sweeping the wiki for the same class of claim.
yuris merged commit e2cb4151aa into main 2026-08-21 11:33:27 +00:00
yuris deleted branch fix-header-example 2026-08-21 11:33:27 +00:00
Sign in to join this conversation.
No description provided.