https://github.com/sanda0/gormdt
gormdt is a Golang package that simplifies data filtering and pagination when working with GORM
https://github.com/sanda0/gormdt
datatable golang gorm
Last synced: 6 months ago
JSON representation
gormdt is a Golang package that simplifies data filtering and pagination when working with GORM
- Host: GitHub
- URL: https://github.com/sanda0/gormdt
- Owner: sanda0
- License: mit
- Created: 2024-08-28T02:41:05.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T03:35:08.000Z (almost 2 years ago)
- Last Synced: 2025-08-09T21:46:31.944Z (12 months ago)
- Topics: datatable, golang, gorm
- Language: Go
- Homepage:
- Size: 6.84 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gormdt
`gormdt` is a Golang package that simplifies data filtering and pagination when working with GORM. It provides two main functions, `FilterAndPaginate` and `FilterAndPaginateCustomQuery`, which allow you to easily filter, search, and paginate database records.
## jQuery DataTables Support
The responses generated by the FilterAndPaginate and FilterAndPaginateCustomQuery functions are designed to be compatible with the jQuery DataTables plugin. This means you can directly use the output from these functions in your frontend application where you are using jQuery DataTables, making it easy to implement server-side processing.
## Installation
To install `gormdt`, run:
```bash
go get github.com/sanda0/gormdt
```
## Usage
### Basic Usage: `FilterAndPaginate`
This function filters and paginates data from a specific table based on the search criteria provided.
#### Example
```go
package main
import (
"fmt"
"github.com/yourusername/gormdt"
"gorm.io/driver/sqlite"
"gorm.io/gorm"
)
func main() {
// Initialize GORM DB connection
db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{})
if err != nil {
panic("failed to connect to database")
}
// Define the filter and paginate parameters
params := gormdt.FilterAndPaginateParam{
DB: db,
TableName: "users",
Fields: []string{"name", "email"},
Request: gormdt.DataTableRequest{
Draw: 1,
Start: 0,
Length: 10,
Search: "john",
},
}
// Call the FilterAndPaginate function
response, err := gormdt.FilterAndPaginate(params)
if err != nil {
fmt.Println("Error:", err)
return
}
// Output the results
fmt.Printf("Total Records: %d\n", response.RecordsTotal)
fmt.Printf("Filtered Records: %d\n", response.RecordsFiltered)
fmt.Printf("Data: %+v\n", response.Data)
}
```
### Advanced Usage: `FilterAndPaginateCustomQuery`
This function allows for more advanced filtering and pagination using a custom SQL query.
#### Example
```go
package main
import (
"fmt"
"github.com/yourusername/gormdt"
"gorm.io/driver/sqlite"
"gorm.io/gorm"
)
func main() {
// Initialize GORM DB connection
db, err := gorm.Open(sqlite.Open("test.db"), &gorm.Config{})
if err != nil {
panic("failed to connect to database")
}
// Define the custom filter and paginate parameters with GROUP BY and HAVING
params := gormdt.FilterAndPaginateCustomQueryParam{
DB: db,
BaseQuery: "SELECT name, email, COUNT(*) as email_count FROM users",
Where: "status = 'active'",
GroupBy: "name, email",
Having: "COUNT(email) > 1", // Example HAVING condition
Fields: []string{"name", "email"},
Request: gormdt.DataTableRequest{
Draw: 1,
Start: 0,
Length: 10,
Search: "john",
},
}
// Call the FilterAndPaginateCustomQuery function
response, err := gormdt.FilterAndPaginateCustomQuery(params)
if err != nil {
fmt.Println("Error:", err)
return
}
// Output the results
fmt.Printf("Total Records: %d\n", response.RecordsTotal)
fmt.Printf("Filtered Records: %d\n", response.RecordsFiltered)
fmt.Printf("Data: %+v\n", response.Data)
}
```
## Data Structures
### `DataTableRequest`
This struct represents the request for data filtering and pagination.
```go
type DataTableRequest struct {
Draw int `json:"draw" form:"draw"`
Start int `json:"start" form:"start"`
Length int `json:"length" form:"length"`
Search string `json:"search" form:"search[value]"`
}
```
### `DataTableResponse`
This struct represents the response after filtering and pagination.
```go
type DataTableResponse struct {
Draw int `json:"draw"`
RecordsTotal int `json:"recordsTotal"`
RecordsFiltered int `json:"recordsFiltered"`
Data interface{} `json:"data"`
}
```
### Parameters
#### `FilterAndPaginateParam`
Parameters for the `FilterAndPaginate` function.
```go
type FilterAndPaginateParam struct {
DB *gorm.DB
TableName string
Fields []string
Request DataTableRequest
}
```
#### `FilterAndPaginateCustomQueryParam`
Parameters for the `FilterAndPaginateCustomQuery` function.
```go
type FilterAndPaginateCustomQueryParam struct {
DB *gorm.DB
BaseQuery string
Where string
GroupBy string
Having string
Fields []string
Request DataTableRequest
}
```