Skip to content

Commit f5d7849

Browse files
marvinvimarvinvi
authored
Support for optional primary key (#127)
* Auto-fill `id` is now optional.
1 parent 29ce2e4 commit f5d7849

File tree

8 files changed

+176
-90
lines changed

8 files changed

+176
-90
lines changed

‎.github/workflows/tests.yml‎

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -40,16 +40,20 @@ jobs:
4040
4141
env:
4242
DIALECTOR: postgres
43-
DATABASE_URL: postgres://gorm:gorm@localhost:5432/sharding-test
44-
DATABASE_READ_URL: postgres://gorm:gorm@localhost:5432/sharding-read-test
45-
DATABASE_WRITE_URL: postgres://gorm:gorm@localhost:5432/sharding-write-test
43+
DB_URL: postgres://gorm:gorm@localhost:5432/sharding-test
44+
DB_NOID_URL: postgres://gorm:gorm@localhost:5432/sharding-noid-test
45+
DB_READ_URL: postgres://gorm:gorm@localhost:5432/sharding-read-test
46+
DB_WRITE_URL: postgres://gorm:gorm@localhost:5432/sharding-write-test
4647
steps:
4748
- name: Set up Go
4849
uses: actions/setup-go@v4
4950
with:
5051
go-version: "1.20"
5152
id: go
5253

54+
- name: Create No ID Database
55+
run: PGPASSWORD=gorm psql -h localhost -U gorm -d sharding-test -c 'CREATE DATABASE "sharding-noid-test";'
56+
5357
- name: Create Read Database
5458
run: PGPASSWORD=gorm psql -h localhost -U gorm -d sharding-test -c 'CREATE DATABASE "sharding-read-test";'
5559

@@ -93,23 +97,25 @@ jobs:
9397
9498
env:
9599
DIALECTOR: mysql
96-
DATABASE_URL: gorm:gorm@tcp(127.0.0.1:3306)/sharding-test?charset=utf8mb4&parseTime=True&loc=Local
97-
DATABASE_READ_URL: root:gorm@tcp(127.0.0.1:3306)/sharding-read-test?charset=utf8mb4&parseTime=True&loc=Local
98-
DATABASE_WRITE_URL: root:gorm@tcp(127.0.0.1:3306)/sharding-write-test?charset=utf8mb4&parseTime=True&loc=Local
100+
DB_URL: gorm:gorm@tcp(127.0.0.1:3306)/sharding-test?charset=utf8mb4&parseTime=True&loc=Local
101+
DB_NOID_URL: root:gorm@tcp(127.0.0.1:3306)/sharding-noid-test?charset=utf8mb4&parseTime=True&loc=Local
102+
DB_READ_URL: root:gorm@tcp(127.0.0.1:3306)/sharding-read-test?charset=utf8mb4&parseTime=True&loc=Local
103+
DB_WRITE_URL: root:gorm@tcp(127.0.0.1:3306)/sharding-write-test?charset=utf8mb4&parseTime=True&loc=Local
99104
steps:
100105
- name: Set up Go
101106
uses: actions/setup-go@v4
102107
with:
103108
go-version: "1.20"
104109
id: go
105110

111+
- name: Create No ID Database
112+
run: mysqladmin -h 127.0.0.1 -uroot -pgorm create sharding-noid-test
113+
106114
- name: Create Read Database
107115
run: mysqladmin -h 127.0.0.1 -uroot -pgorm create sharding-read-test
108-
#run: mysql -e 'CREATE DATABASE sharding-read-test' -ugorm -pgorm
109116

110117
- name: Create Write Database
111118
run: mysqladmin -h 127.0.0.1 -uroot -pgorm create sharding-write-test
112-
#run: mysql -e 'CREATE DATABASE sharding-write-test' -ugorm -pgorm
113119

114120
- name: Check out code into the Go module directory
115121
uses: actions/checkout@v3
@@ -125,7 +131,7 @@ jobs:
125131

126132
strategy:
127133
matrix:
128-
dbversion: ["mariadb:latest"]
134+
dbversion: ["mariadb:10.11"]
129135
platform: [ubuntu-latest]
130136
runs-on: ${{ matrix.platform }}
131137

@@ -148,23 +154,25 @@ jobs:
148154
149155
env:
150156
DIALECTOR: mariadb
151-
DATABASE_URL: gorm:gorm@tcp(127.0.0.1:3306)/sharding-test?charset=utf8mb4&parseTime=True&loc=Local
152-
DATABASE_READ_URL: root:gorm@tcp(127.0.0.1:3306)/sharding-read-test?charset=utf8mb4&parseTime=True&loc=Local
153-
DATABASE_WRITE_URL: root:gorm@tcp(127.0.0.1:3306)/sharding-write-test?charset=utf8mb4&parseTime=True&loc=Local
157+
DB_URL: gorm:gorm@tcp(127.0.0.1:3306)/sharding-test?charset=utf8mb4&parseTime=True&loc=Local
158+
DB_NOID_URL: root:gorm@tcp(127.0.0.1:3306)/sharding-noid-test?charset=utf8mb4&parseTime=True&loc=Local
159+
DB_READ_URL: root:gorm@tcp(127.0.0.1:3306)/sharding-read-test?charset=utf8mb4&parseTime=True&loc=Local
160+
DB_WRITE_URL: root:gorm@tcp(127.0.0.1:3306)/sharding-write-test?charset=utf8mb4&parseTime=True&loc=Local
154161
steps:
155162
- name: Set up Go
156163
uses: actions/setup-go@v4
157164
with:
158165
go-version: "1.20"
159166
id: go
160167

168+
- name: Create No ID Database
169+
run: mysqladmin -h 127.0.0.1 -uroot -pgorm create sharding-noid-test
170+
161171
- name: Create Read Database
162172
run: mysqladmin -h 127.0.0.1 -uroot -pgorm create sharding-read-test
163-
#run: mysql -e 'CREATE DATABASE sharding-read-test' -ugorm -pgorm
164173

165174
- name: Create Write Database
166175
run: mysqladmin -h 127.0.0.1 -uroot -pgorm create sharding-write-test
167-
#run: mysql -e 'CREATE DATABASE sharding-write-test' -ugorm -pgorm
168176

169177
- name: Check out code into the Go module directory
170178
uses: actions/checkout@v3

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,10 @@ db.Use(sharding.Register(sharding.Config{
120120
}, "orders")
121121
```
122122
123+
### No primary key
124+
125+
If your table doesn't have a primary key, or has a primary key that isn't called `id`, anyway, you don't want to auto-fill the `id` field, then you can set `PrimaryKeyGenerator` to `PKCustom` and have `PrimaryKeyGeneratorFn` return `0`.
126+
123127
## Combining with dbresolver
124128
125129
> 🚨 NOTE: Use dbresolver first.

‎conn_pool.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ func (pool ConnPool) PrepareContext(ctx context.Context, query string) (*sql.Stm
2222
return pool.ConnPool.PrepareContext(ctx, query)
2323
}
2424

25-
func (pool ConnPool) ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error) {
25+
func (pool ConnPool) ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error) {
2626
ftQuery, stQuery, table, err := pool.sharding.resolve(query, args...)
2727
if err != nil {
2828
return nil, err
@@ -42,7 +42,7 @@ func (pool ConnPool) ExecContext(ctx context.Context, query string, args ...inte
4242
}
4343

4444
// https://github.com/go-gorm/gorm/blob/v1.21.11/callbacks/query.go#L18
45-
func (pool ConnPool) QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error) {
45+
func (pool ConnPool) QueryContext(ctx context.Context, query string, args ...any) (*sql.Rows, error) {
4646
ftQuery, stQuery, table, err := pool.sharding.resolve(query, args...)
4747
if err != nil {
4848
return nil, err
@@ -61,7 +61,7 @@ func (pool ConnPool) QueryContext(ctx context.Context, query string, args ...int
6161
return pool.ConnPool.QueryContext(ctx, stQuery, args...)
6262
}
6363

64-
func (pool ConnPool) QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row {
64+
func (pool ConnPool) QueryRowContext(ctx context.Context, query string, args ...any) *sql.Row {
6565
_, query, _, _ = pool.sharding.resolve(query, args...)
6666
pool.sharding.querys.Store("last_query", query)
6767

‎dialector.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func (d ShardingDialector) Migrator(db *gorm.DB) gorm.Migrator {
3333
}
3434
}
3535

36-
func (m ShardingMigrator) AutoMigrate(dst ...interface{}) error {
36+
func (m ShardingMigrator) AutoMigrate(dst ...any) error {
3737
shardingDsts, noShardingDsts, err := m.splitShardingDsts(dst...)
3838
if err != nil {
3939
return err
@@ -61,7 +61,7 @@ func (m ShardingMigrator) AutoMigrate(dst ...interface{}) error {
6161
return nil
6262
}
6363

64-
func (m ShardingMigrator) DropTable(dst ...interface{}) error {
64+
func (m ShardingMigrator) DropTable(dst ...any) error {
6565
shardingDsts, noShardingDsts, err := m.splitShardingDsts(dst...)
6666
if err != nil {
6767
return err
@@ -84,15 +84,15 @@ func (m ShardingMigrator) DropTable(dst ...interface{}) error {
8484

8585
type shardingDst struct {
8686
table string
87-
dst interface{}
87+
dst any
8888
}
8989

9090
// splite sharding or normal dsts
91-
func (m ShardingMigrator) splitShardingDsts(dsts ...interface{}) (shardingDsts []shardingDst,
92-
noShardingDsts []interface{}, err error) {
91+
func (m ShardingMigrator) splitShardingDsts(dsts ...any) (shardingDsts []shardingDst,
92+
noShardingDsts []any, err error) {
9393

9494
shardingDsts = make([]shardingDst, 0)
95-
noShardingDsts = make([]interface{}, 0)
95+
noShardingDsts = make([]any, 0)
9696
for _, model := range dsts {
9797
stmt := &gorm.Statement{DB: m.sharding.DB}
9898
err = stmt.Parse(model)

‎go.mod‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
module gorm.io/sharding
22

3-
go 1.20
3+
go 1.21
44

55
require (
66
github.com/bwmarrin/snowflake v0.3.0
77
github.com/longbridgeapp/assert v1.1.0
88
github.com/longbridgeapp/sqlparser v0.3.1
9-
golang.org/x/exp v0.0.0-20230510235704-dd950f8aeaea
10-
gorm.io/driver/mysql v1.4.7
11-
gorm.io/driver/postgres v1.5.0
12-
gorm.io/gorm v1.25.1
9+
golang.org/x/exp v0.0.0-20230817173708-d852ddb80c63
10+
gorm.io/driver/mysql v1.5.1
11+
gorm.io/driver/postgres v1.5.2
12+
gorm.io/gorm v1.25.4
1313
gorm.io/hints v1.1.2
14-
gorm.io/plugin/dbresolver v1.4.1
14+
gorm.io/plugin/dbresolver v1.4.7
1515
)
1616

1717
require (
1818
github.com/davecgh/go-spew v1.1.1 // indirect
1919
github.com/go-sql-driver/mysql v1.7.0 // indirect
2020
github.com/jackc/pgpassfile v1.0.0 // indirect
2121
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
22-
github.com/jackc/pgx/v5 v5.3.0 // indirect
22+
github.com/jackc/pgx/v5 v5.3.1 // indirect
2323
github.com/jinzhu/inflection v1.0.0 // indirect
2424
github.com/jinzhu/now v1.1.5 // indirect
2525
github.com/pmezard/go-difflib v1.0.0 // indirect
2626
github.com/stretchr/testify v1.8.1 // indirect
27-
golang.org/x/crypto v0.6.0 // indirect
28-
golang.org/x/text v0.7.0 // indirect
27+
golang.org/x/crypto v0.8.0 // indirect
28+
golang.org/x/text v0.9.0 // indirect
2929
gopkg.in/yaml.v3 v3.0.1 // indirect
3030
)

‎go.sum‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/
1515
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
1616
github.com/jackc/pgx/v5 v5.3.0 h1:/NQi8KHMpKWHInxXesC8yD4DhkXPrVhmnwYkjp9AmBA=
1717
github.com/jackc/pgx/v5 v5.3.0/go.mod h1:t3JDKnCBlYIc0ewLF0Q7B8MXmoIaBOZj/ic7iHozM/8=
18+
github.com/jackc/pgx/v5 v5.3.1 h1:Fcr8QJ1ZeLi5zsPZqQeUZhNhxfkkKBOgJuYkJHoBOtU=
19+
github.com/jackc/pgx/v5 v5.3.1/go.mod h1:t3JDKnCBlYIc0ewLF0Q7B8MXmoIaBOZj/ic7iHozM/8=
1820
github.com/jackc/puddle/v2 v2.2.0/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
1921
github.com/jinzhu/inflection v1.0.0 h1:K317FqzuhWc8YvSVlFMCCUb36O/S9MCKRDI7QkRKD/E=
2022
github.com/jinzhu/inflection v1.0.0/go.mod h1:h+uFLlag+Qp1Va5pdKtLDYj+kHp5pxUVkryuEj+Srlc=
@@ -54,8 +56,12 @@ golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACk
5456
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
5557
golang.org/x/crypto v0.6.0 h1:qfktjS5LUO+fFKeJXZ+ikTRijMmljikvG68fpMMruSc=
5658
golang.org/x/crypto v0.6.0/go.mod h1:OFC/31mSvZgRz0V1QTNCzfAI1aIRzbiufJtkMIlEp58=
59+
golang.org/x/crypto v0.8.0 h1:pd9TJtTueMTVQXzk8E2XESSMQDj/U7OUu0PqJqPXQjQ=
60+
golang.org/x/crypto v0.8.0/go.mod h1:mRqEX+O9/h5TFCrQhkgjo2yKi0yYA+9ecGkdQoHrywE=
5761
golang.org/x/exp v0.0.0-20230510235704-dd950f8aeaea h1:vLCWI/yYrdEHyN2JzIzPO3aaQJHQdp89IZBA/+azVC4=
5862
golang.org/x/exp v0.0.0-20230510235704-dd950f8aeaea/go.mod h1:V1LtkGg67GoY2N1AnLN78QLrzxkLyJw7RJb1gzOOz9w=
63+
golang.org/x/exp v0.0.0-20230817173708-d852ddb80c63 h1:m64FZMko/V45gv0bNmrNYoDEq8U5YUhetc9cBWKS1TQ=
64+
golang.org/x/exp v0.0.0-20230817173708-d852ddb80c63/go.mod h1:0v4NqG35kSWCMzLaMeX+IQrlSnVE/bqGSyC2cz/9Le8=
5965
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
6066
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
6167
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
@@ -78,6 +84,8 @@ golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
7884
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
7985
golang.org/x/text v0.7.0 h1:4BRB4x83lYWy72KwLD/qYDuTu7q9PjSagHvijDw7cLo=
8086
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
87+
golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE=
88+
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
8189
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
8290
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
8391
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
@@ -93,8 +101,12 @@ gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
93101
gorm.io/driver/mysql v1.4.3/go.mod h1:sSIebwZAVPiT+27jK9HIwvsqOGKx3YMPmrA3mBJR10c=
94102
gorm.io/driver/mysql v1.4.7 h1:rY46lkCspzGHn7+IYsNpSfEv9tA+SU4SkkB+GFX125Y=
95103
gorm.io/driver/mysql v1.4.7/go.mod h1:SxzItlnT1cb6e1e4ZRpgJN2VYtcqJgqnHxWr4wsP8oc=
104+
gorm.io/driver/mysql v1.5.1 h1:WUEH5VF9obL/lTtzjmML/5e6VfFR/788coz2uaVCAZw=
105+
gorm.io/driver/mysql v1.5.1/go.mod h1:Jo3Xu7mMhCyj8dlrb3WoCaRd1FhsVh+yMXb1jUInf5o=
96106
gorm.io/driver/postgres v1.5.0 h1:u2FXTy14l45qc3UeCJ7QaAXZmZfDDv0YrthvmRq1l0U=
97107
gorm.io/driver/postgres v1.5.0/go.mod h1:FUZXzO+5Uqg5zzwzv4KK49R8lvGIyscBOqYrtI1Ce9A=
108+
gorm.io/driver/postgres v1.5.2 h1:ytTDxxEv+MplXOfFe3Lzm7SjG09fcdb3Z/c056DTBx0=
109+
gorm.io/driver/postgres v1.5.2/go.mod h1:fmpX0m2I1PKuR7mKZiEluwrP3hbs+ps7JIGMUBpCgl8=
98110
gorm.io/driver/sqlite v1.5.0 h1:zKYbzRCpBrT1bNijRnxLDJWPjVfImGEn0lSnUY5gZ+c=
99111
gorm.io/driver/sqlite v1.5.0/go.mod h1:kDMDfntV9u/vuMmz8APHtHF0b4nyBB7sfCieC6G8k8I=
100112
gorm.io/gorm v1.23.8/go.mod h1:l2lP/RyAtc1ynaTjFksBde/O8v9oOGIApu2/xRitmZk=
@@ -103,7 +115,12 @@ gorm.io/gorm v1.24.7-0.20230306060331-85eaf9eeda11/go.mod h1:L4uxeKpfBml98NYqVqw
103115
gorm.io/gorm v1.25.0/go.mod h1:L4uxeKpfBml98NYqVqwAdmV1a2nBtAec/cf3fpucW/k=
104116
gorm.io/gorm v1.25.1 h1:nsSALe5Pr+cM3V1qwwQ7rOkw+6UeLrX5O4v3llhHa64=
105117
gorm.io/gorm v1.25.1/go.mod h1:L4uxeKpfBml98NYqVqwAdmV1a2nBtAec/cf3fpucW/k=
118+
gorm.io/gorm v1.25.2/go.mod h1:L4uxeKpfBml98NYqVqwAdmV1a2nBtAec/cf3fpucW/k=
119+
gorm.io/gorm v1.25.4 h1:iyNd8fNAe8W9dvtlgeRI5zSVZPsq3OpcTu37cYcpCmw=
120+
gorm.io/gorm v1.25.4/go.mod h1:L4uxeKpfBml98NYqVqwAdmV1a2nBtAec/cf3fpucW/k=
106121
gorm.io/hints v1.1.2 h1:b5j0kwk5p4+3BtDtYqqfY+ATSxjj+6ptPgVveuynn9o=
107122
gorm.io/hints v1.1.2/go.mod h1:/ARdpUHAtyEMCh5NNi3tI7FsGh+Cj/MIUlvNxCNCFWg=
108123
gorm.io/plugin/dbresolver v1.4.1 h1:Ug4LcoPhrvqq71UhxtF346f+skTYoCa/nEsdjvHwEzk=
109124
gorm.io/plugin/dbresolver v1.4.1/go.mod h1:CTbCtMWhsjXSiJqiW2R8POvJ2cq18RVOl4WGyT5nhNc=
125+
gorm.io/plugin/dbresolver v1.4.7 h1:ZwtwmJQxTx9us7o6zEHFvH1q4OeEo1pooU7efmnunJA=
126+
gorm.io/plugin/dbresolver v1.4.7/go.mod h1:l4Cn87EHLEYuqUncpEeTC2tTJQkjngPSD+lo8hIvcT0=

0 commit comments

Comments
 (0)