https://github.com/ActiveChooN/gin-gorm-filter

Filter GORM query with query params
https://github.com/ActiveChooN/gin-gorm-filter

filter gin golang

Last synced: 13 days ago
JSON representation

Filter GORM query with query params

• Host: GitHub
• URL: https://github.com/ActiveChooN/gin-gorm-filter
• Owner: ActiveChooN
• License: mit
• Created: 2021-11-10T18:02:36.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2023-08-18T10:25:39.000Z (about 1 year ago)
• Last Synced: 2024-02-13T13:38:46.370Z (9 months ago)
• Topics: filter, gin, golang
• Language: Go
• Homepage:
• Size: 25.4 KB
• Stars: 13
• Watchers: 2
• Forks: 12
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# Gin GORM filter

![GitHub](https://img.shields.io/github/license/ActiveChooN/gin-gorm-filter)

![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/ActiveChooN/gin-gorm-filter/ci.yml?branch=master)

![GitHub release (latest by date)](https://img.shields.io/github/v/release/ActiveChooN/gin-gorm-filter)

Scope function for GORM queries provides easy filtering with query parameters

## Usage

```(shell)

go get github.com/ActiveChooN/gin-gorm-filter

```

## Model definition

```go

type UserModel struct {

    gorm.Model

    Username string `gorm:"uniqueIndex" filter:"param:login;searchable;filterable"`

    FullName string `filter:"searchable"`

    Role     string `filter:"filterable"`

}

```

`param` tag in that case defines custom column name for the query param

## Controller Example

```go

func GetUsers(c *gin.Context) {

	var users []UserModel

	var usersCount int64

	db, err := gorm.Open(sqlite.Open("gorm.db"), &gorm.Config{})

	err := db.Model(&UserModel{}).Scopes(

		filter.FilterByQuery(c, filter.ALL),

	).Count(&usersCount).Find(&users).Error

	if err != nil {

		c.JSON(http.StatusBadRequest, err.Error())

		return

	}

	serializer := serializers.PaginatedUsers{Users: users, Count: usersCount}

	c.JSON(http.StatusOK, serializer.Response())

}

```

Any filter combination can be used here `filter.PAGINATION|filter.ORDER_BY` e.g. **Important note:** GORM model should be initialize first for DB, otherwise filter and search won't work

## Request example

```(shell)

curl -X GET http://localhost:8080/users?page=1&limit=10&order_by=username&order_direction=asc&filter="name:John"

```

## Supported filter operators

- :   The equality operator `filter=username:John` matches only when the username is exactly `John`

- \>  The greater than operator `filter=age>35` matches only when age is more than 35

- \<  The less than operator `filter=salary<80000` matches only when salary is less than 80,000

- \>= The greater than or equals to operator `filter=items>=100` matches only when items is at least 100

- \<= The less than or equals to operator `filter=score<=100000` matches when score is 100,000 or lower

- \!= The not equals to operator `state!=FAIL` matches when state has any value other than FAIL

- \~  The like operator `filter=lastName~illi` matches when lastName contains the substring `illi`

## TODO list

- [x] Write tests for the lib with CI integration

- [x] Add support for case-insensitive search

- [x] Add other filters, like > or !=

- [x] Add support for multiple filters in one query

- [ ] Add suport for filtering for related models