Merge pull request #53 from olachat/yinloo/fix-query-interface

deprecate methods with ctx

coredb/engine.go

@@ -43,6 +43,7 @@ func getDB(dbname string, mode DBMode) *sql.DB {
 }
 
 // FetchByPK returns a row of T type with given primary key value
+// Deprecated: use the function with context
 func FetchByPK[T any](dbname string, tableName string, pkName []string, val ...any) *T {
 	sql := "WHERE `" + pkName[0] + "` = ?"
 	for _, name := range pkName[1:] {
@@ -53,6 +54,7 @@ func FetchByPK[T any](dbname string, tableName string, pkName []string, val ...a
 }
 
 // FetchByPKs returns rows of T type with given primary key values
+// Deprecated: use the function with context
 func FetchByPKs[T any](dbname string, tableName string, pkName string, vals []any) []*T {
 	if len(vals) == 0 {
 		return make([]*T, 0)
@@ -69,6 +71,7 @@ func FetchByPKs[T any](dbname string, tableName string, pkName string, vals []an
 }
 
 // FetchByPKFromMaster returns a row of T type with given primary key value
+// Deprecated: use the function with context
 func FetchByPKFromMaster[T any](dbname string, tableName string, pkName []string, val ...any) *T {
 	sql := "WHERE `" + pkName[0] + "` = ?"
 	for _, name := range pkName[1:] {
@@ -79,6 +82,7 @@ func FetchByPKFromMaster[T any](dbname string, tableName string, pkName []string
 }
 
 // FetchByPKsFromMaster returns rows of T type with given primary key values
+// Deprecated: use the function with context
 func FetchByPKsFromMaster[T any](dbname string, tableName string, pkName string, vals []any) []*T {
 	if len(vals) == 0 {
 		return make([]*T, 0)
@@ -95,12 +99,14 @@ func FetchByPKsFromMaster[T any](dbname string, tableName string, pkName string,
 }
 
 // Exec given query with given db info & params
+// Deprecated: use the function with context
 func Exec(dbname string, query string, params ...any) (sql.Result, error) {
 	mydb := getDB(dbname, DBModeWrite)
 	return mydb.Exec(query, params...)
 }
 
 // FindOne returns a row from given table type with where query
+// Deprecated: use the function with context
 func FindOne[T any](dbname string, tableName string, where WhereQuery) *T {
 	u := new(T)
 	columnsNames := GetColumnsNames[T]()
@@ -125,6 +131,7 @@ func FindOne[T any](dbname string, tableName string, where WhereQuery) *T {
 }
 
 // Find returns rows from given table type with where query
+// Deprecated: use the function with context
 func Find[T any](dbname string, tableName string, where WhereQuery) ([]*T, error) {
 	columnsNames := GetColumnsNames[T]()
 	whereSQL, params := where.GetWhere()
@@ -135,6 +142,7 @@ func Find[T any](dbname string, tableName string, where WhereQuery) ([]*T, error
 }
 
 // FindOneFromMaster using master DB returns a row from given table type with where query
+// Deprecated: use the function with context
 func FindOneFromMaster[T any](dbname string, tableName string, where WhereQuery) *T {
 	u := new(T)
 	columnsNames := GetColumnsNames[T]()
@@ -159,6 +167,7 @@ func FindOneFromMaster[T any](dbname string, tableName string, where WhereQuery)
 }
 
 // FindFromMaster using master DB returns rows from given table type with where query
+// Deprecated: use the function with context
 func FindFromMaster[T any](dbname string, tableName string, where WhereQuery) ([]*T, error) {
 	columnsNames := GetColumnsNames[T]()
 	whereSQL, params := where.GetWhere()
@@ -169,20 +178,23 @@ func FindFromMaster[T any](dbname string, tableName string, where WhereQuery) ([
 }
 
 // QueryInt single int result by query, handy for count(*) querys
+// Deprecated: use the function with context
 func QueryInt(dbname string, query string, params ...any) (result int, err error) {
 	mydb := getDB(dbname, DBModeRead)
 	mydb.QueryRow(query, params...).Scan(&result)
 	return
 }
 
 // QueryIntFromMaster single int result by query, handy for count(*) querys
+// Deprecated: use the function with context
 func QueryIntFromMaster(dbname string, query string, params ...any) (result int, err error) {
 	mydb := getDB(dbname, DBModeReadFromWrite)
 	mydb.QueryRow(query, params...).Scan(&result)
 	return
 }
 
 // Query rows from given table type with where query & params
+// Deprecated: use the function with context
 func Query[T any](dbname string, query string, params ...any) (result []*T, err error) {
 	mydb := getDB(dbname, DBModeRead)
 	rows, err := mydb.Query(query, params...)
@@ -205,6 +217,7 @@ func Query[T any](dbname string, query string, params ...any) (result []*T, err
 }
 
 // Query rows from master DB from given table type with where query & params
+// Deprecated: use the function with context
 func QueryFromMaster[T any](dbname string, query string, params ...any) (result []*T, err error) {
 	mydb := getDB(dbname, DBModeReadFromWrite)
 	rows, err := mydb.Query(query, params...)

coredb/query_type.go

@@ -1,5 +1,7 @@
 package coredb
 
+import "context"
+
 // WhereQuery defines interface which support forming query query
 type WhereQuery interface {
 	GetWhere() (whereSQL string, params []any)
@@ -26,10 +28,19 @@ func NewWhere(whereSQL string, params ...any) WhereQuery {
 
 // ReadQuery defines interface which support reading multiple objects
 type ReadQuery[T any] interface {
+	// Deprecated: use the function with context
 	All() []*T
+	// Deprecated: use the function with context
 	Limit(offset, limit int) []*T
+	// Deprecated: use the function with context
 	AllFromMaster() []*T
+	// Deprecated: use the function with context
 	LimitFromMaster(offset, limit int) []*T
+
+	AllCtx(context.Context) ([]*T, error)
+	LimitCtx(ctx context.Context, offset, limit int) ([]*T, error)
+	AllFromMasterCtx(context.Context) ([]*T, error)
+	LimitFromMasterCtx(ctx context.Context, offset, limit int) ([]*T, error)
 }
 
 // ReadOneQuery defines interface which support reading one object