xiaoxue_admin
/
mempalace
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: align capability token names in RFC 001 

Copilot review flagged back-references in §1.4 and §6 that still used
the pre-skuznetsov-rename names (`$contains_fast`, `sync_capable`,
`change_feed`). Updated to the `supports_*` prefix used in the §2.1
capability table.
This commit is contained in:
Igor Lins e Silva 2026-04-12 20:35:52 -03:00
parent 2a2466c656
commit f142458a31
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/rfcs/001-storage-backend-plugin-spec.md
View File

@ -138,7 +138,7 @@ On empty results: return a result object with empty inner lists, never raise. Sp
**Required operators:** `$eq`, `$ne`, `$in`, `$nin`, `$and`, `$or`, `$contains`.
Backends that do not support full-text natively must implement `$contains` via payload string match. A `$contains_fast` capability flag lets callers check whether a backend's implementation is indexed (fast) or scan-based (slow).
Backends that do not support full-text natively must implement `$contains` via payload string match. The `supports_contains_fast` capability flag (§2.1) lets callers check whether a backend's implementation is indexed (fast) or scan-based (slow).
**Unknown operators:** backends MUST raise `UnsupportedFilterError`. Silent dropping is forbidden — it produces incorrect results.
@ -368,12 +368,12 @@ Backends receive an `Embedder` via `get_collection(embedder=...)`. Backends with
The sync subsystem is out of scope for this spec. What this spec defines:
- `sync_capable` capability flag — a backend advertising it agrees to implement idempotent upserts under conflict and to expose change data.
- `supports_sync` capability flag (§2.1) — a backend advertising it agrees to implement idempotent upserts under conflict and to expose change data.
- Optional method on `BaseCollection`:
```python
def changes_since(self, cursor: SyncCursor) -> Iterator[Change]: ...
```
- Backends without `change_feed` / `sync_capable` are rejected by the sync subsystem at bind time.
- Backends without `supports_change_feed` / `supports_sync` are rejected by the sync subsystem at bind time.
Local single-user deployments never load the sync subsystem; non-sync-capable backends cost them nothing.