Document the sql configuration block (engine, allowFullScan, maxSortRows, maxHashRows) in configuration options
Maintainer antworten meist innerhalb von 4 Tagen
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Anfängerfreundlichkeit
- 65/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Aktiv
- Tech-Stack
- sql
- Bereich
- documentation
Rechercherichtung
Beginne mit reference/configuration/options.md, das keinen sql-Abschnitt hat, und mit der Einstellungstabelle im Issue. Lies den Abschnitt „The fallback contract“ in reference/operations-api/sql.md, damit der neue Eintrag zu dessen Formulierung passt. Prüfe die Semantik von maxSortRows und maxHashRows anhand der Dateien validation/configValidator.ts und sqlEngine/config.ts im harper-Repository. Fertig ist, wenn ein Eintrag ## sql mit den Zeilen Type: und Default: für alle vier Einstellungen existiert und auf den Abschnitt zum fallback contract verlinkt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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.
- Vorherrschende Sprache
- MDX
- Sterne
- 9
- Forks
- 9
- Ø Merge
- 5 T. 5 Std.
- Gemergte PRs (30 T.)
- 48
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus HarperFast/documentation
-
Document http.maxRequestBodySize (REST, MCP application endpoint, and operations API body limits)Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 88/100
HarperFast/documentation#806 ·
Maintainer antworten meist innerhalb von 4 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
HarperFast/documentation#803 ·
Maintainer antworten meist innerhalb von 4 Tagen
-
content
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 68/100
HarperFast/documentation#770 ·
Maintainer antworten meist innerhalb von 4 Tagen
-
content
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100
HarperFast/documentation#769 ·
Maintainer antworten meist innerhalb von 4 Tagen
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 76/100
HarperFast/documentation#768 ·
Maintainer antworten meist innerhalb von 4 Tagen
Alle Issues in HarperFast/documentation
Ähnliche Issues
-
audit-reference-check
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
[Docs]: Document the `timezone` ELN key for timestamps without a time zoneEvtl. vergeben @keila-moral hat das heute übernommen. Offendocumentation
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 88/100
FAIRmat-NFDI/pynxtools-spm#134 ·
Maintainer antworten meist innerhalb von 1 Tag
-
from.page-issue
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag
-
feedback simulation workshop
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 69/100
githubnext/gh-aw-workshop#5826 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 66/100
philippe-nougaillon/coopcomm#543 ·