diff options
| author | Alexander_Kabui <alexanderkabua@gmail.com> | 2026-10-08 07:35:40 +0300 |
|---|---|---|
| committer | Alexander_Kabui <alexanderkabua@gmail.com> | 2026-10-08 07:35:40 +0300 |
| commit | fa1d410d95860f29d4a3aae86c565bee78618d3d (patch) | |
| tree | 740bd86a80eeaa5207b8c7db15bdd5cf75a63d77 /docs | |
| parent | 1a03e984c2e37ad0c8ec50efe6353548af7d222d (diff) | |
| download | genenetwork4-fa1d410d95860f29d4a3aae86c565bee78618d3d.tar.gz | |
docs/search-engines.md: give the indexer command its script
prefix (scripts/index-genenetwork, verified against the click CLI); plain 'planned response enrichment' instead of naming a proposal; state the behavior-preserving default up front.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/search-engines.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/search-engines.md b/docs/search-engines.md index cdb58c5..0c8a5b9 100644 --- a/docs/search-engines.md +++ b/docs/search-engines.md @@ -4,7 +4,8 @@ Everything below is about **how to select and run a search engine**, not how either engine is built. Two engines implement the same `Engine` seam (`src/search/mod.rs`): a forwarder that calls gn3's `/api/search` (the default), and a native engine that searches a -xapian index directly from Rust. +xapian index directly from Rust. The default is unchanged — taking +this changes no behavior; the native engine is opt-in. ## One config key selects the engine @@ -19,7 +20,7 @@ rebuild or redeploy. The native engine also needs `XAPIAN_DB_PATH` pointing at a xapian index. On production that is `/var/lib/xapian`; locally, an index built with the existing indexer: - create-xapian-index <index-dir> <sql-uri> <sparql-uri> + scripts/index-genenetwork create-xapian-index <index-dir> <sql-uri> <sparql-uri> Index building stays with the existing indexer (`index-genenetwork`); only searching moved into gn4. @@ -52,8 +53,8 @@ A client can read `type`/`param`/`message`, fix the query, and retry ## Known quirks - `locus: null` does not say whether the marker is absent or the - database was unreachable; carrying that reason is future work - (the response-format proposal). + database was unreachable; carrying that reason is planned + response enrichment. - With `sort`, the forwarder ranks gn3's first 1000 matches; the native engine retrieves the full match set before ranking, so sorted results can differ in the tail. |
