Docs: SQL CREATE INDEX ... USING fts WITH (...) options are undocumented (only with_position appears)
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 78/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 領域
- databases, documentation, search
調査の方向性
Start with docs/search/sql/fts-sql.mdx and compare its existing WITH example with the accepted key list in the issue. Check the referenced engine.rs:4832-4857 behavior for code-only flags, then document every key with types and defaults and add a code-search example with a wait-for-index step.
索引モデルが issue の本文から書いたものです。
説明
Bug bash: Ready to fix
Bug bash priority: Low · critical-fix: no
From the FTS for Code bug bash (2026-10-01), findings: sdkdocs-8.md. Repros ran against released artifacts (pylance 12.0.0 / 13.0.0b18, lancedb 0.39.0 / 0.40.0b12, @lancedb/lancedb 0.40.0-beta.12) unless stated. $S is the bug bash scratch dir.
Docs gap, not dispatched.
- Category: docs gap
- Environment:
lancedb/docsmainat7fa2ff6; LanceDB Enterpriselancedb server+ Flight SQL CLI, Linux arm64 - Artifacts: CLI
release-2026-10-01.148d419ac8.verified - Target tracker: GitHub
lancedb/docs(and Linear Enterprise for LanceDB Enterprise-side reference)
Repro
docs/search/sql/fts-sql.mdx:71-81 (the only SQL FTS index docs):
run_query("CREATE INDEX ON my_docs USING fts (text)")
...
CREATE INDEX ON my_docs USING fts (text) WITH (with_position = true)
No other WITH key is documented anywhere on the docs site (grep -rn -i "using fts" docs returns only these lines and :192).
The server does accept the code flags, and that is the only way for a LanceDB user to get identifier splitting today (PW-1):
$ lancedb ... -c "CREATE INDEX code_idx ON code_t USING fts (code) WITH (base_tokenizer = 'code', split_identifiers = true, with_position = true)"
CREATE INDEX
# list_indices() from lancedb Python remote:
index_details={'base_tokenizer': 'code', 'with_position': True, 'stem': False, 'remove_stop_words': False,
'split_identifiers': True, 'split_on_numerics': True, 'preserve_original': True, 'index_operators': False, 'block_size': 128, 'document_granularity': 'row', ...}
Expected behavior
fts-sql.mdx (or a SQL reference page) lists every WITH key for USING fts, with types and defaults. It should flag the code-only flags (rejected unless base_tokenizer = 'code', engine.rs:4832-4857) and include a code-search example.
Evidence: accepted key list above.
Suspected root cause
The SQL FTS page was written before the code flags were added to build_fts_params and never got an options table.
Fix direction
Add an options table to docs/search/sql/fts-sql.mdx, generated from or checked against build_fts_params, plus a code example with a wait-for-index step.
- 主要言語
- Python
- スター
- 11
- フォーク
- 14
- 平均マージ
- 1日 12時間
- マージ済み PR（30日）
- 9
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
lancedb/docs のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
documentation
難易度 4/5 3〜5日 初心者へのやさしさ 55/100
メンテナーはふだん 1 日以内に返信
-
難易度 3/5 1〜2日 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
Improve training documentation user journey and sidebar naming再び着手できるかも @prrao87 が 84 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
メンテナーはふだん 1 日以内に返信
似ている issue
-
fix formatting of the sample database page of the docs対応中かも @Aaqibhafeezkhan が今日担当しました。 オープンdocumentation good first issue help wanted
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
chaoss/CollectOSS#544 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
area/plugin good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
kestra-io/plugin-soda#137 ·
-
難易度 2/5 半日 初心者へのやさしさ 62/100
ibm-granite/granite.build#504 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信