Skip to content

docs(search): 拼音召回 — 明确 sys_user/选人器覆盖与存量数据回填(#2486 文档补遗) #3057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
os-zhuang merged 1 commit into from
Jul 16, 2026
+18 −0
Merged

docs(search): 拼音召回 — 明确 sys_user/选人器覆盖与存量数据回填(#2486 文档补遗) #3057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions content/docs/data-modeling/queries.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,17 @@ the expanded filter; `fields` semantics, `searchableFields`, and drivers are unc
(ADR-0097). Relevance ranking and typo tolerance remain Tier-2 (native FTS) and are not
part of this.

**Coverage** — every object with a resolvable display/name field gets the companion,
**including `sys_user`**: the people picker (which sends a plain `$search` against
`sys_user`) finds users by pinyin with zero per-object or per-field configuration. Users
created through any write path — sign-up, admin rename, engine writes — are searchable
immediately.

**Pre-existing rows** are reconciled automatically: the first boot after the switch turns
on runs a paged, idempotent backfill over every object that carries the companion column.
For bulk imports that bypassed write hooks at runtime, `rebuildSearchCompanion` (exported
by `@objectstack/plugin-pinyin-search`) recomputes the column on demand.

---

## Window Functions
Expand Down
7 changes: 7 additions & 0 deletions content/docs/deployment/environment-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,6 +253,13 @@ OS_SEARCH_PINYIN_ENABLED=false os start # force off (e.g. a zh-locale stack th
|:---|:---|:---|:---|
| `OS_SEARCH_PINYIN_ENABLED` | boolean | locale-derived | Pinyin search recall. When unset, the default derives from the stack's configured locales (`i18n.defaultLocale` / `supportedLocales` / `fallbackLocale`): any `zh-*` locale turns it on; an explicit value always wins. Gates both the compile-time `__search` companion column and the `plugin-pinyin-search` populate hooks, so there is no half-state. Off ⇒ no extra column, and `pinyin-pro` is never loaded. |

Coverage includes `sys_user` — the people picker finds users by pinyin with no
per-object configuration. Rows that predate the switch are backfilled automatically
on the first boot after it turns on (paged, idempotent); for runtime bulk imports
that bypassed write hooks, `rebuildSearchCompanion` (from
`@objectstack/plugin-pinyin-search`) recomputes the column on demand. See
[Queries → Pinyin recall](/docs/data-modeling/queries#pinyin-recall-chinese-deployments).

---

## Marketplace & Metadata
Expand Down