Document the sql configuration block (engine, allowFullScan, maxSortRows, maxHashRows) in configuration options
维护者通常 4 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 65/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- sql
调研方向
从 reference/configuration/options.md 开始,该文件没有 sql 章节,同时参考 issue 中的设置表。阅读 reference/operations-api/sql.md 中的 "The fallback contract" 章节,使新条目的措辞与之保持一致。对照 harper 中的 validation/configValidator.ts 和 sqlEngine/config.ts 确认 maxSortRows 与 maxHashRows 的语义。完成的标准是:为四个设置都添加一个带有 Type: 和 Default: 行的 ## sql 条目,并链接到 fallback contract 章节。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- MDX
- 星标
- 9
- 派生
- 9
- 平均合并
- 5 天 5 小时
- 30 天内合并 PR
- 48
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
HarperFast/documentation 的其他 Issue
-
Document http.maxRequestBodySize (REST, MCP application endpoint, and operations API body limits)未关闭
难度 2/5 1-3 小时 新手友好度 88/100
HarperFast/documentation#806 ·
维护者通常 4 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
HarperFast/documentation#803 ·
维护者通常 4 天内回复
-
content
难度 2/5 半天 新手友好度 68/100
HarperFast/documentation#770 ·
维护者通常 4 天内回复
-
content
难度 2/5 1-3 小时 新手友好度 74/100
HarperFast/documentation#769 ·
维护者通常 4 天内回复
-
难度 1/5 1 小时以内 新手友好度 76/100
HarperFast/documentation#768 ·
维护者通常 4 天内回复
查看 HarperFast/documentation 的全部 Issue
相似的 Issue
-
入群码过期未关闭
难度 1/5 1 小时以内 新手友好度 84/100
aliyun/ai-agent-handbook#29 · 1 条评论 ·
-
docs documentation need-triage SaaS
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
[Sync EN] stream: document the errors of the stream_context_*() and stream filter functions (#6091)未关闭sync-en
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
[Sync EN] stream: document the errors of the stream_context_*() and stream filter functions (#6091)未关闭sync-en
难度 2/5 1-3 小时 新手友好度 66/100
维护者通常 1 天内回复
-
documentation
难度 2/5 1-3 小时 新手友好度 73/100
sleepyviper1213/redis#30 ·