Improve documentation on NewCreateIndex · uptrace/bun#1290

(7 comments) (0 reactions) (0 assignees)Go (4,826 stars) (279 forks)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
Issue 種別: documentation
難度: 2
推定時間: 1-3 hours
活動状況: fresh
明確さ: clear
前提条件: Go programmingSQL knowledgebun ORM basics
初心者向け度: 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.