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

Đang mở Phù hợp với người mới
#785 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 4 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
65/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
sql
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu từ reference/configuration/options.md, file này chưa có mục sql, và từ bảng cấu hình trong issue. Đọc phần "The fallback contract" trong reference/operations-api/sql.md để mục mới khớp với cách diễn đạt của phần đó. Đối chiếu ngữ nghĩa của maxSortRows và maxHashRows với các file validation/configValidator.ts và sqlEngine/config.ts trong harper. Hoàn thành khi có một mục ## sql với các dòng Type: và Default: cho cả bốn cấu hình, và liên kết đến phần fallback contract.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
MDX
Star
9
Fork
9
Merge trung bình
5 ngày 5 giờ
Pull request đã merge (30 ngày)
48

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của HarperFast/documentation

Tất cả issue của HarperFast/documentation

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.