Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/WinterYukky/gorm-extra-clause-plugin
The clause support plugin for gorm, that not supported by gorm.
https://github.com/WinterYukky/gorm-extra-clause-plugin
go gorm gorm-plugin
Last synced: 6 days ago
JSON representation
The clause support plugin for gorm, that not supported by gorm.
- Host: GitHub
- URL: https://github.com/WinterYukky/gorm-extra-clause-plugin
- Owner: WinterYukky
- License: mit
- Created: 2021-07-16T12:40:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-12T06:19:21.000Z (4 months ago)
- Last Synced: 2024-08-02T16:35:57.245Z (3 months ago)
- Topics: go, gorm, gorm-plugin
- Language: Go
- Homepage:
- Size: 127 KB
- Stars: 43
- Watchers: 3
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gorm-extra-clause-plugin
The clause support plugin for gorm, that not supported by gorm.
[](https://github.com/WinterYukky/gorm-extra-clause-plugin/actions)
[](https://opensource.org/licenses/MIT)
## Support clauses
- [x] WITH (CTE)
- [x] UNION
- [x] INTERSECT
- [x] EXCEPT
## Install
```shell
go get github.com/WinterYukky/gorm-extra-clause-plugin
```
## Get Started
> [!IMPORTANT]
> Do not forget the plugin initialisation code `db.Use(extraClausePlugin.New()`.
```go
package main
import (
"gorm.io/gorm"
"gorm.io/driver/sqlite"
// Add plugin package
extraClausePlugin "github.com/WinterYukky/gorm-extra-clause-plugin"
"github.com/WinterYukky/gorm-extra-clause-plugin/exclause"
)
func main() {
db, err := gorm.Open(sqlite.Open(":memory:"), &gorm.Config{})
if err != nil {
panic("failed to connect database")
}
// Insert this line
db.Use(extraClausePlugin.New())
// Use exclauses
db.Clauses(exclause.NewWith("cte", db.Table("users"))).Table("cte").Scan(&users)
}
```
## Examples
### WITH (CTE)
```go
// WITH `cte` AS (SELECT * FROM `users`) SELECT * FROM `cte`
db.Clauses(exclause.NewWith("cte", "SELECT * FROM `users`")).Table("cte").Scan(&users)
// WITH `cte` AS (SELECT * FROM `users` WHERE `name` = 'WinterYukky') SELECT * FROM `cte`
db.Clauses(exclause.NewWith("cte", "SELECT * FROM `users` WHERE `name` = ?", "WinterYukky")).Table("cte").Scan(&users)
// WITH `cte` AS (SELECT * FROM `users` WHERE `name` = 'WinterYukky') SELECT * FROM `cte`
db.Clauses(exclause.NewWith("cte", db.Table("users").Where("`name` = ?", "WinterYukky"))).Table("cte").Scan(&users)
// WITH `cte` (`id`,`name`) AS (SELECT * FROM `users`) SELECT * FROM `cte`
db.Clauses(exclause.With{CTEs: []exclause.CTE{{Name: "cte", Columns: []string{"id", "name"}, Subquery: exclause.Subquery{DB: db.Table("users")}}}}).Table("cte").Scan(&users)
// WITH RECURSIVE `cte` AS (SELECT * FROM `users`) SELECT * FROM `cte`
db.Clauses(exclause.With{Recursive: true, CTEs: []exclause.CTE{{Name: "cte", Subquery: exclause.Subquery{DB: db.Table("users")}}}}).Table("cte").Scan(&users)
```
### UNION
```go
// SELECT * FROM `general_users` UNION SELECT * FROM `admin_users`
db.Table("general_users").Clauses(exclause.NewUnion("SELECT * FROM `admin_users`")).Scan(&users)
// SELECT * FROM `general_users` UNION SELECT * FROM `admin_users`
db.Table("general_users").Clauses(exclause.NewUnion(db.Table("admin_users"))).Scan(&users)
// SELECT * FROM `general_users` UNION ALL SELECT * FROM `admin_users`
db.Table("general_users").Clauses(exclause.NewUnion("ALL ?", db.Table("admin_users"))).Scan(&users)
```
### INTERSECT
```go
// SELECT * FROM `general_users` INTERSECT SELECT * FROM `admin_users`
db.Table("general_users").Clauses(exclause.NewIntersect("SELECT * FROM `admin_users`")).Scan(&users)
// SELECT * FROM `general_users` INTERSECT SELECT * FROM `admin_users`
db.Table("general_users").Clauses(exclause.NewIntersect(db.Table("admin_users"))).Scan(&users)
// SELECT * FROM `general_users` INTERSECT ALL SELECT * FROM `admin_users`
db.Table("general_users").Clauses(exclause.NewIntersect("ALL ?", db.Table("admin_users"))).Scan(&users)
```
### EXCEPT
```go
// SELECT * FROM `general_users` EXCEPT SELECT * FROM `admin_users`
db.Table("general_users").Clauses(exclause.NewExcept("SELECT * FROM `admin_users`")).Scan(&users)
// SELECT * FROM `general_users` EXCEPT SELECT * FROM `admin_users`
db.Table("general_users").Clauses(exclause.NewExcept(db.Table("admin_users"))).Scan(&users)
// SELECT * FROM `general_users` EXCEPT ALL SELECT * FROM `admin_users`
db.Table("general_users").Clauses(exclause.NewExcept("ALL ?", db.Table("admin_users"))).Scan(&users)
```