uptrace/bun

Improve documentation on NewCreateIndex

Open

#1,290 opened on Oct 28, 2025

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Go (4,826 stars) (279 forks)user submission
documentationgood first issueno stalebotstale

Description

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!

Contributor guide

Tech stack
gosql
Domain
documentationbackend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programmingSQL knowledgebun ORM basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.