refactor: rename to rql

raystack · Feb 17, 2025 · 0d1aaf1 · 0d1aaf1
1 parent b5051ea
commit 0d1aaf1
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/qp/README.md → rql/README.md b/qp/README.md → rql/README.md
@@ -1,4 +1,4 @@
-# QP (Query parser)
+# RQL (Rest Query Language)
 
 A library to parse support advanced REST API query parameters like (filter, pagination, sort, group, search) and logical operators on the keys (like eq, neq, like, gt, lt etc)
 
@@ -32,18 +32,18 @@ Frontend should send the parameters and operator like this schema to the backend
 }
 ```
 
-The `qp` library can be used to parse this json, validate it and returns a Struct containing all the info to generate the operations and values for SQL.
+The `rql` library can be used to parse this json, validate it and returns a Struct containing all the info to generate the operations and values for SQL.
 
 The validation happens via stuct tags defined on your model. Example:
 
 ```golang
 type Organization struct {
-	Id              int       `qp:"type=number,min=10,max=200"`
-	BillingPlanName string    `qp:"type=string"`
-	CreatedAt       time.Time `qp:"type=datetime"`
-	MemberCount     int       `qp:"type=number"`
-	Title           string    `qp:"type=string"`
-	Enabled         bool      `qp:"type=bool"`
+	Id              int       `rql:"type=number,min=10,max=200"`
+	BillingPlanName string    `rql:"type=string"`
+	CreatedAt       time.Time `rql:"type=datetime"`
+	MemberCount     int       `rql:"type=number"`
+	Title           string    `rql:"type=string"`
+	Enabled         bool      `rql:"type=bool"`
 }
 
 ```

diff --git a/qp/parser/parser.go → rql/parser.go b/qp/parser/parser.go → rql/parser.go
@@ -1,4 +1,4 @@
-package parser
+package rql
 
 import (
 	"fmt"
@@ -15,7 +15,7 @@ var validBoolOperations = []string{"eq", "neq"}
 var validDatetimeOperations = []string{"eq", "neq", "gt", "gt", "gte", "lte"}
 var validSortOrder = []string{"asc", "desc"}
 
-const TAG = "qp"
+const TAG = "rql"
 
 type Query struct {
 	Filters []Filter `json:"filters"`

diff --git a/qp/parser/parser_test.go → rql/parser_test.go b/qp/parser/parser_test.go → rql/parser_test.go
@@ -1,15 +1,15 @@
-package parser
+package rql
 
 import (
 	"testing"
 	"time"
 )
 
 type TestStruct struct {
-	ID        int32     `qp:"type=number"`
-	Name      string    `qp:"type=string"`
-	IsActive  bool      `qp:"type=bool"`
-	CreatedAt time.Time `qp:"type=datetime"`
+	ID        int32     `rql:"type=number"`
+	Name      string    `rql:"type=string"`
+	IsActive  bool      `rql:"type=bool"`
+	CreatedAt time.Time `rql:"type=datetime"`
 }
 
 func TestValidateQuery(t *testing.T) {