Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Docs: SQL CREATE INDEX ... USING fts WITH (...) options are undocumented (only with_position appears)

Abierto
  • ¿Algo no está bien?
#370 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
78/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python, sql
Área
databases, documentation, search

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

documentation

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/docs main at 7fa2ff6; LanceDB Enterprise lancedb 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.

Lenguaje dominante
Python
Estrellas
11
Forks
14
Merge medio
1 d 12 h
PR fusionados (30 d)
9

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de lancedb/docs

Todos los issues de lancedb/docs

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.