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

Aperta Adatta ai principianti
#785 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 4 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
65/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
sql
Ambito
documentation

Direzione di ricerca

Inizia da reference/configuration/options.md, che non ha una sezione sql, e dalla tabella delle impostazioni nell'issue. Leggi la sezione "The fallback contract" di reference/operations-api/sql.md in modo che la nuova voce corrisponda alla sua formulazione. Verifica la semantica di maxSortRows e maxHashRows nei file validation/configValidator.ts e sqlEngine/config.ts di harper. È fatto quando esiste una voce ## sql con le righe Type: e Default: per tutte e quattro le impostazioni, che rimanda alla sezione del fallback contract.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
MDX
Stelle
9
Fork
9
Merge medio
5g 5h
PR unite (30g)
48

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di HarperFast/documentation

Tutte le issue di HarperFast/documentation

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.