Document the sql configuration block (engine, allowFullScan, maxSortRows, maxHashRows) in configuration options

Abierto Apto para principiantes
#785 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 4 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
65/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
sql

Línea de trabajo

Empieza con reference/configuration/options.md, que no tiene una sección sql, y con la tabla de ajustes del issue. Lee la sección "The fallback contract" de reference/operations-api/sql.md para que la nueva entrada coincida con su redacción. Confirma la semántica de maxSortRows y maxHashRows en los archivos validation/configValidator.ts y sqlEngine/config.ts de harper. Está terminado cuando exista una entrada ## sql con las líneas Type: y Default: para las cuatro configuraciones, y que enlace a la sección del fallback contract.

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

Descripción

content

reference/configuration/options.md has no sql section, so the SQL engine settings are only findable from the SQL reference page.

Settings the config validator accepts under sql (harper validation/configValidator.ts, sqlEngine/config.ts):

Setting Values Default
sql.engine auto, new, legacy (the HARPER_SQL_ENGINE environment variable overrides it) auto
sql.allowFullScan boolean false
sql.maxSortRows positive integer 1000000
sql.maxHashRows positive integer 1000000

The SQL LIKE docs PR for harper#3936 defines sql.engine and sql.allowFullScan briefly in "The fallback contract" on reference/operations-api/sql.md, because LIKE behavior depends on them. A full ## sql entry in options.md, in the page's Type: / Default: format, should cover all four settings and link to that section. maxSortRows and maxHashRows (row caps for the new engine's in-memory sort and hash operators; exceeding one makes auto fall back) need their semantics checked against core before they are documented.

Review-Deferral: 1fb37cf7647bc110 severity=nit category=documentation

🤖 Generated by Claude Code (Claude Opus 5.5); posted via @kriszyp.

Lenguaje dominante
MDX
Estrellas
9
Forks
9
Merge medio
5 d 5 h
PR fusionados (30 d)
48

Preparar el entorno

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 HarperFast/documentation

Todos los issues de HarperFast/documentation

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.