uptrace/bun

Improve documentation on NewCreateIndex

Open

#1,290 建立於 2025年10月28日

在 GitHub 查看
 (7 留言) (0 反應) (0 負責人)Go (4,826 star) (279 fork)user submission
documentationgood first issueno stalebotstale

描述

Hi, I'm creating indexes with the ORM, and it's all good, but it took a lot of searching and some trial and error. The documentation seems very poor about this, I believe a few complex examples with the NewCreateIndex function would help a lot, especially with the counterpart SQL code.

Thanks!

貢獻者指南

技術棧
gosql
領域
documentationbackend
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Go programmingSQL knowledgebun ORM basics
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
Examine the existing documentation for CreateIndex and NewCreateIndex in the bun repository (likely in the docs folder or README). Look at the current examples and compare with the actual SQL output generated by the ORM. Consider adding examples for composite indexes, unique indexes, and indexes with conditions. Include the corresponding SQL statements generated by bun for each example. Coordinate with maintainers to ensure consistency with the codebase.