Skip to content

Commit 2f6f47e

Browse files
sim-wangyansim-wangyan
committed
๐Ÿ”„ v0.10.5: Project Rename sqlxb โ†’ xb
## Core Changes ### 1. Project Rename - โœ… Module name: `github.com/x-ream/sqlxb` โ†’ `github.com/x-ream/xb` - โœ… All import paths updated - โœ… Package name remains `sqlxb` (backward compatible) ### 2. Documentation Updates - โœ… README.md with migration notice - โœ… All document titles updated (40+ files) - โœ… All example code updated - โœ… 4 application examples' go.mod updated ### 3. Migration Guide - โœ… New MIGRATION.md - Migration steps - Batch replace commands (Linux/macOS/Windows) - FAQ - Verification methods ### 4. Test Verification - โœ… All existing tests pass - โœ… go mod tidy no errors - โœ… Build successful --- ## Backward Compatibility โœ… **100% Backward Compatible**: - Package name still `sqlxb` - All APIs unchanged - Only import paths need update ```go // โœ… Only update import import ( "github.com/x-ream/xb" // New path ) // โœ… Code unchanged builder := sqlxb.Of(&User{}) ``` --- ## Migration Steps 1. Update `go.mod`: ``` require github.com/x-ream/xb v0.10.5 ``` 2. Update all `.go` file imports: ``` github.com/x-ream/sqlxb โ†’ github.com/x-ream/xb ``` 3. Run tests: ``` go mod tidy go test ./... ``` See: [MIGRATION.md](../MIGRATION.md) --- ## File Changes ### Core - `go.mod` - module name - `MIGRATION.md` - new migration guide - `README.md` - migration notice ### Source Code - `to_sql.go` - `to_insert_set.go` - `builder_x.go` - `to_update_set.go` - `to_agg.go` - `to_from_sql_by_builder.go` - `to_result_key.go` - `interceptor_test.go` ### Documentation (40+ files) - `doc/*.md` - all titles updated - `doc/ai_application/*.md` - AI application docs - `commit_message/*.txt` - commit messages ### Examples - `examples/pgvector-app/go.mod` - `examples/qdrant-app/go.mod` - `examples/rag-app/go.mod` - `examples/pageindex-app/go.mod` - All example source imports --- ## Why Rename? 1. **More Concise** - `xb` is shorter and easier to remember than `sqlxb` 2. **Brand Consistency** - Aligns with x-ream organization naming 3. **Better Discoverability** - Shorter names are more advantageous in search --- ## Impact **All sqlxb users** - Need to update import paths **Migration Difficulty**: โญ Easy (2 minutes) --- ## Roadmap Update - v0.10.5 marked as completed - v1.0.0 target unchanged (2025 Q4) --- **Test Status**: โœ… All passed **Compatibility**: โœ… 100% backward compatible **Documentation**: โœ… Complete migration guide **Release**: โœ… Ready
1 parent 83ce87a commit 2f6f47e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+630
-153
lines changed

โ€ŽCHANGELOG_v0.9.2.mdโ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,5 @@
4646

4747
---
4848

49-
**ๅ‡็บง**๏ผš`go get github.com/x-ream/sqlxb@v0.9.2`
49+
**ๅ‡็บง**๏ผš`go get github.com/x-ream/xb@v0.9.2`
5050

โ€ŽMIGRATION.mdโ€Ž

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
# ไปŽ sqlxb ่ฟ็งปๅˆฐ xb
2+
3+
## ๐Ÿ”„ ้กน็›ฎ้‡ๅ‘ฝๅ้€š็Ÿฅ
4+
5+
**็‰ˆๆœฌ**: v0.10.5
6+
**ๆ—ฅๆœŸ**: 2025-10-28
7+
8+
ไปŽ `v0.10.5` ๅผ€ๅง‹๏ผŒ้กน็›ฎไปŽ `sqlxb` ้‡ๅ‘ฝๅไธบ `xb`ใ€‚
9+
10+
---
11+
12+
## ๐Ÿ“‹ ไธบไป€ไนˆ้‡ๅ‘ฝๅ๏ผŸ
13+
14+
1. **ๆ›ด็ฎ€ๆด็š„ๅ็งฐ** - `xb` ๆฏ” `sqlxb` ๆ›ด็Ÿญใ€ๆ›ดๆ˜“่ฎฐ
15+
2. **ๅ“็‰Œ็ปŸไธ€** - ไธŽ x-ream ็ป„็ป‡ๅ‘ฝๅ้ฃŽๆ ผไฟๆŒไธ€่‡ด
16+
3. **ๆ›ดๅฅฝ็š„ๅฏๅ‘็Žฐๆ€ง** - ็Ÿญๅ็งฐๅœจๆœ็ดขๅ’ŒๆŽจ่ๆ—ถๆ›ดๅ…ทไผ˜ๅŠฟ
17+
18+
---
19+
20+
## ๐Ÿš€ ่ฟ็งปๆญฅ้ชค
21+
22+
### 1๏ธโƒฃ ๆ›ดๆ–ฐ `go.mod`
23+
24+
**ไฟฎๆ”นๅ‰**:
25+
```go
26+
module your-project
27+
28+
require (
29+
github.com/x-ream/sqlxb v0.10.4
30+
)
31+
```
32+
33+
**ไฟฎๆ”นๅŽ**:
34+
```go
35+
module your-project
36+
37+
require (
38+
github.com/x-ream/xb v0.10.5
39+
)
40+
```
41+
42+
---
43+
44+
### 2๏ธโƒฃ ๆ›ดๆ–ฐ import ่ฏญๅฅ
45+
46+
**ไฟฎๆ”นๅ‰**:
47+
```go
48+
import (
49+
"github.com/x-ream/sqlxb"
50+
)
51+
```
52+
53+
**ไฟฎๆ”นๅŽ**:
54+
```go
55+
import (
56+
"github.com/x-ream/xb"
57+
)
58+
```
59+
60+
---
61+
62+
### 3๏ธโƒฃ ๅŒ…ๅไฟๆŒไธๅ˜๏ผˆๅ‘ๅŽๅ…ผๅฎน๏ผ‰
63+
64+
โœ… **ๆ— ้œ€ไฟฎๆ”นไปฃ็ ** - ๅŒ…ๅไป็„ถๆ˜ฏ `sqlxb`๏ผš
65+
66+
```go
67+
// โœ… ่ฟ™ไบ›ไปฃ็ ๆ— ้œ€ไฟฎๆ”น
68+
builder := sqlxb.Of(&User{})
69+
qx := sqlxb.QdrantX{}
70+
built := builder.Build()
71+
```
72+
73+
---
74+
75+
## ๐Ÿ”ง ๆ‰น้‡ๆ›ฟๆขๅ‘ฝไปค
76+
77+
### Linux / macOS / Git Bash
78+
```bash
79+
# ๆ›ดๆ–ฐ go.mod
80+
find . -name "go.mod" -type f -exec sed -i 's|github.com/x-ream/sqlxb|github.com/x-ream/xb|g' {} +
81+
82+
# ๆ›ดๆ–ฐๆ‰€ๆœ‰ Go ๆ–‡ไปถ
83+
find . -name "*.go" -type f -exec sed -i 's|github.com/x-ream/sqlxb|github.com/x-ream/xb|g' {} +
84+
85+
# ่ฟ่กŒ go mod tidy
86+
go mod tidy
87+
```
88+
89+
### Windows PowerShell
90+
```powershell
91+
# ๆ›ดๆ–ฐ go.mod
92+
Get-ChildItem -Recurse -Filter "go.mod" | ForEach-Object {
93+
(Get-Content $_.FullName) -replace 'github.com/x-ream/sqlxb', 'github.com/x-ream/xb' | Set-Content $_.FullName
94+
}
95+
96+
# ๆ›ดๆ–ฐๆ‰€ๆœ‰ Go ๆ–‡ไปถ
97+
Get-ChildItem -Recurse -Filter "*.go" | ForEach-Object {
98+
(Get-Content $_.FullName) -replace 'github.com/x-ream/sqlxb', 'github.com/x-ream/xb' | Set-Content $_.FullName
99+
}
100+
101+
# ่ฟ่กŒ go mod tidy
102+
go mod tidy
103+
```
104+
105+
---
106+
107+
## โœ… ้ชŒ่ฏ่ฟ็งป
108+
109+
### 1. ็กฎ่ฎคไพ่ต–ๆ›ดๆ–ฐ
110+
```bash
111+
go list -m all | grep "x-ream"
112+
```
113+
114+
**ๆœŸๆœ›่พ“ๅ‡บ**:
115+
```
116+
github.com/x-ream/xb v0.10.5
117+
```
118+
119+
### 2. ่ฟ่กŒๆต‹่ฏ•
120+
```bash
121+
go test ./...
122+
```
123+
124+
### 3. ๆž„ๅปบ้กน็›ฎ
125+
```bash
126+
go build ./...
127+
```
128+
129+
---
130+
131+
## ๐Ÿ“Œ ๅธธ่ง้—ฎ้ข˜
132+
133+
### Q1: ๆ—ง็‰ˆๆœฌ็š„ `sqlxb` ่ฟ˜่ƒฝ็”จๅ—๏ผŸ
134+
135+
**A**: ๅฏไปฅใ€‚ๆ—ง็š„ `github.com/x-ream/sqlxb` ไป“ๅบ“ไผšไฟ็•™ๅˆฐ `v0.10.4`๏ผŒไฝ†ไธๅ†็ปดๆŠคใ€‚ๅปบ่ฎฎๅฐฝๅฟซ่ฟ็งปๅˆฐ `xb`ใ€‚
136+
137+
---
138+
139+
### Q2: ๆˆ‘้œ€่ฆไฟฎๆ”นไปฃ็ ไธญ็š„ `sqlxb` ๅŒ…ๅๅ—๏ผŸ
140+
141+
**A**: **ไธ้œ€่ฆ**ใ€‚ๅŒ…ๅไป็„ถๆ˜ฏ `sqlxb`๏ผŒๅช้œ€่ฆไฟฎๆ”น `import` ่ทฏๅพ„ๅณๅฏ๏ผš
142+
143+
```go
144+
import (
145+
"github.com/x-ream/xb" // โœ… ๅชๆ”น่ฟ™้‡Œ
146+
)
147+
148+
// โœ… ไปฃ็ ๆ— ้œ€ไฟฎๆ”น
149+
builder := sqlxb.Of(&User{})
150+
```
151+
152+
---
153+
154+
### Q3: ๆˆ‘็š„้กน็›ฎไฝฟ็”จไบ† v0.10.4 ไน‹ๅ‰็š„็‰ˆๆœฌ๏ผŒๆ€ŽไนˆๅŠž๏ผŸ
155+
156+
**A**: ๅˆ†ไธคๆญฅ่ฟ็งป๏ผš
157+
158+
1. **ๅ…ˆๅ‡็บงๅˆฐ v0.10.4**๏ผˆไปไฝฟ็”จ `sqlxb`๏ผ‰
159+
2. **ๅ†ๅ‡็บงๅˆฐ v0.10.5**๏ผˆๅˆ‡ๆขๅˆฐ `xb`๏ผ‰
160+
161+
```bash
162+
# Step 1
163+
go get github.com/x-ream/[email protected]
164+
go mod tidy
165+
166+
# ๆต‹่ฏ•็กฎ่ฎคๆ— ่ฏฏๅŽ
167+
# Step 2
168+
go get github.com/x-ream/[email protected]
169+
# ็„ถๅŽๆŒ‰็…งไธŠ้ข็š„ๆญฅ้ชคไฟฎๆ”น import ่ทฏๅพ„
170+
```
171+
172+
---
173+
174+
### Q4: ๆˆ‘ไฝฟ็”จไบ† `replace` ๆŒ‡ไปคๆ€ŽไนˆๅŠž๏ผŸ
175+
176+
**A**: ๆ›ดๆ–ฐ `go.mod` ไธญ็š„ `replace` ๆŒ‡ไปค๏ผš
177+
178+
**ไฟฎๆ”นๅ‰**:
179+
```go
180+
replace github.com/x-ream/sqlxb => /path/to/local/sqlxb
181+
```
182+
183+
**ไฟฎๆ”นๅŽ**:
184+
```go
185+
replace github.com/x-ream/xb => /path/to/local/xb
186+
```
187+
188+
---
189+
190+
## ๐Ÿ”— ็›ธๅ…ณ่ต„ๆบ
191+
192+
- **GitHub ไป“ๅบ“**: https://github.com/x-ream/xb
193+
- **ๆ–‡ๆกฃ**: https://github.com/x-ream/xb/blob/main/README.md
194+
- **Roadmap**: https://github.com/x-ream/xb/blob/main/doc/ROADMAP_v1.0.0.md
195+
- **Issues**: https://github.com/x-ream/xb/issues
196+
197+
---
198+
199+
## ๐Ÿ’ฌ ้œ€่ฆๅธฎๅŠฉ๏ผŸ
200+
201+
ๅฆ‚ๆžœๆ‚จๅœจ่ฟ็งป่ฟ‡็จ‹ไธญ้‡ๅˆฐ้—ฎ้ข˜๏ผš
202+
203+
1. **ๆŸฅ้˜…ๆ–‡ๆกฃ**: [doc/README.md](./doc/README.md)
204+
2. **ๆไบค Issue**: https://github.com/x-ream/xb/issues
205+
3. **ๆŸฅ็œ‹็คบไพ‹**: [examples/](./examples/README.md)
206+
207+
---
208+
209+
**ๆ„Ÿ่ฐขๆ‚จไฝฟ็”จ xb๏ผˆๅŽŸ sqlxb๏ผ‰๏ผ** ๐Ÿš€
210+

โ€ŽREADME.mdโ€Ž

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
# sqlxb
2-
[![OSCS Status](https://www.oscs1024.com/platform/badge/x-ream/sqlxb.svg?size=small)](https://www.oscs1024.com/project/x-ream/sqlxb?ref=badge_small)
3-
![workflow build](https://github.com/x-ream/sqlxb/actions/workflows/go.yml/badge.svg)
4-
[![GitHub tag](https://img.shields.io/github/tag/x-ream/sqlxb.svg?style=flat)](https://github.com/x-ream/sqlxb/tags)
5-
[![Go Report Card](https://goreportcard.com/badge/github.com/x-ream/sqlxb)](https://goreportcard.com/report/github.com/x-ream/sqlxb)
1+
# xb
2+
[![OSCS Status](https://www.oscs1024.com/platform/badge/x-ream/xb.svg?size=small)](https://www.oscs1024.com/project/x-ream/xb?ref=badge_small)
3+
![workflow build](https://github.com/x-ream/xb/actions/workflows/go.yml/badge.svg)
4+
[![GitHub tag](https://img.shields.io/github/tag/x-ream/xb.svg?style=flat)](https://github.com/x-ream/xb/tags)
5+
[![Go Report Card](https://goreportcard.com/badge/github.com/x-ream/xb)](https://goreportcard.com/report/github.com/x-ream/xb)
6+
7+
> ๐Ÿ”„ **Project Renamed (v0.10.5)**: `sqlxb` โ†’ `xb`
8+
> ๐Ÿ“– **[Migration Guide](./MIGRATION.md)** - Update your `go.mod` and imports in 2 minutes
69
710
**AI-First SQL Builder** for Relational and Vector Databases
811

@@ -56,7 +59,7 @@ sqlxb.Of(&CodeVector{}).
5659

5760
## ๐Ÿค– AI-First Development
5861

59-
sqlxb v0.8.0+ is developed using an innovative **AI-First** approach:
62+
xb v0.8.0+ is developed using an innovative **AI-First** approach:
6063

6164
- ๐Ÿค– **AI Assistant (Claude via Cursor)**: Architecture design, code implementation, testing, documentation
6265
- ๐Ÿ‘จโ€๐Ÿ’ป **Human Maintainer**: Code review, strategic decisions, critical algorithm oversight
@@ -76,7 +79,7 @@ sqlxb v0.8.0+ is developed using an innovative **AI-First** approach:
7679
- Documentation: AI Assistant (120+ pages)
7780
- Review & Approval: Human Maintainer
7881

79-
This makes sqlxb **one of the first major Go ORM projects successfully maintained by AI**.
82+
This makes xb **one of the first major Go ORM projects successfully maintained by AI**.
8083

8184
---
8285

@@ -134,7 +137,7 @@ Quick links:
134137

135138
## Contributing
136139

137-
Contributors are welcomed to join the sqlxb project. <br>
140+
Contributors are welcomed to join the xb project. <br>
138141
Please check [CONTRIBUTING](./doc/CONTRIBUTING.md)
139142

140143
## Quickstart
@@ -148,7 +151,7 @@ Please check [CONTRIBUTING](./doc/CONTRIBUTING.md)
148151
```Go
149152

150153
import (
151-
. "github.com/x-ream/sqlxb"
154+
. "github.com/x-ream/xb"
152155
)
153156

154157
type Cat struct {
@@ -250,7 +253,7 @@ func main() {
250253

251254
```Go
252255
import (
253-
. "github.com/x-ream/sqlxb"
256+
. "github.com/x-ream/xb"
254257
)
255258

256259
func main() {
@@ -437,5 +440,5 @@ Don't debate technology choices โ€” Look at data characteristics:
437440
โ†’ Hybrid approach
438441
```
439442

440-
**sqlxb supports all scenarios โ€” One API for everything!** โœ…
443+
**xb supports all scenarios โ€” One API for everything!** โœ…
441444

โ€Žbuilder_x.goโ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ package sqlxb
1919
import (
2020
"fmt"
2121

22-
"github.com/x-ream/sqlxb/interceptor"
22+
"github.com/x-ream/xb/interceptor"
2323
)
2424

2525
// ToId build sql, like: SELECT DISTINCT f.id FROM foo f INNER_JOIN JOIN (SELECT foo_id FROM bar) b ON b.foo_id = f.id

โ€Žcommit_message/COMMIT_MESSAGE.txtโ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Performance:
5757

5858
Migration:
5959
No code changes required. Fully backward compatible.
60-
go get github.com/x-ream/sqlxb@v0.9.0
60+
go get github.com/x-ream/xb@v0.9.0
6161

6262
Design philosophy:
6363
Builder-time filtering > JSON post-filtering

โ€Žcommit_message/COMMIT_MESSAGE_v0.10.0.txtโ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ Discover API:
192192
### ๅฎ‰่ฃ…
193193

194194
```bash
195-
go get github.com/x-ream/sqlxb@v0.10.0
195+
go get github.com/x-ream/xb@v0.10.0
196196
```
197197

198198
### ๅ‘ๅŽๅ…ผๅฎน

โ€Žcommit_message/COMMIT_MESSAGE_v0.10.0_EN.txtโ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ Discover API:
192192
### Installation
193193

194194
```bash
195-
go get github.com/x-ream/sqlxb@v0.10.0
195+
go get github.com/x-ream/xb@v0.10.0
196196
```
197197

198198
### Backward Compatibility

0 commit comments

Comments
ย (0)