Skip to content

feat: SQL 单规则例外（标准 CE） #3339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LordofAvernus wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: SQL 单规则例外（标准 CE） #3339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions sqle/api/app.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,13 +177,21 @@ func StartApi(net *gracenet.Net, exitChan chan struct{}, config *config.SqleOpti
v1Router.POST(fmt.Sprintf("%s/connection", dmsV1.InternalDBServiceRouterGroup), v1.CheckInstanceIsConnectable, sqleMiddleware.OpGlobalAllowed())
v1Router.GET("/database_driver_options", v1.GetDatabaseDriverOptions)
v1Router.GET("/database_driver_logos", v1.GetDatabaseDriverLogos)

// operation record
v1Router.GET("/operation_records/operation_type_names", v1.GetOperationTypeNameList, sqleMiddleware.ViewGlobalAllowed())
v1Router.GET("/operation_records/operation_actions", v1.GetOperationActionList, sqleMiddleware.ViewGlobalAllowed())
v1Router.GET("/operation_records", v1.GetOperationRecordListV1, sqleMiddleware.ViewGlobalAllowed())
v1Router.GET("/operation_records/exports", v1.GetExportOperationRecordListV1, sqleMiddleware.ViewGlobalAllowed())
}

// project admin and global manage router
v1OpProjectRouter := v1Router.Group("/projects", sqleMiddleware.OpProjectAllowed())
{
// audit whitelist
v1OpProjectRouter.POST("/:project_name/audit_whitelist", v1.CreateAuditWhitelist)
v1OpProjectRouter.POST("/:project_name/audit_whitelist/rule_exceptions", v1.CreateSQLRuleException)
v1OpProjectRouter.DELETE("/:project_name/audit_whitelist/rule_exceptions/:sql_rule_exception_id", v1.DeleteSQLRuleException)
v1OpProjectRouter.PATCH("/:project_name/audit_whitelist/:audit_whitelist_id/", v1.UpdateAuditWhitelistById)
v1OpProjectRouter.DELETE("/:project_name/audit_whitelist/:audit_whitelist_id/", v1.DeleteAuditWhitelistById)

Expand Down Expand Up @@ -314,6 +322,7 @@ func StartApi(net *gracenet.Net, exitChan chan struct{}, config *config.SqleOpti
v1ProjectViewRouter.GET("/:project_name/statistic/optimization_record_overview", v1.GetOptimizationRecordOverview)
v1ProjectViewRouter.GET("/:project_name/statistic/optimization_performance_improve_overview", v1.GetDBPerformanceImproveOverview)
v1ProjectViewRouter.GET("/:project_name/audit_whitelist", v1.GetSqlWhitelist)
v1ProjectViewRouter.GET("/:project_name/audit_whitelist/rule_exceptions", v1.GetSQLRuleException)

v1ProjectViewRouter.GET("/:project_name/instances/:instance_name/connection", v1.CheckInstanceIsConnectableByName)
v1ProjectViewRouter.GET("/:project_name/instances/:instance_name/schemas", v1.GetInstanceSchemas)
Expand Down
133 changes: 133 additions & 0 deletions sqle/api/controller/v1/operation_record.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
package v1

import (
"time"

"github.com/actiontech/sqle/sqle/api/controller"
"github.com/labstack/echo/v4"
)

type GetOperationTypeNamesListResV1 struct {
controller.BaseRes
Data []OperationTypeNameList `json:"data"`
}

type OperationTypeNameList struct {
OperationTypeName string `json:"operation_type_name"`
Desc string `json:"desc"`
}

// GetOperationTypeNameList
// @Summary 获取操作类型名列表
// @Description Get operation type name list
// @Id GetOperationTypeNameList
// @Tags OperationRecord
// @Security ApiKeyAuth
// @Success 200 {object} GetOperationTypeNamesListResV1
// @Router /v1/operation_records/operation_type_names [get]
func GetOperationTypeNameList(c echo.Context) error {
return getOperationTypeNameList(c)
}

type GetOperationActionListResV1 struct {
controller.BaseRes
Data []OperationActionList `json:"data"`
}

type OperationActionList struct {
OperationType string `json:"operation_type"`
OperationAction string `json:"operation_action"`
Desc string `json:"desc"`
}

// GetOperationActionList
// @Summary 获取操作内容列表
// @Description Get operation action list
// @Id getOperationActionList
// @Tags OperationRecord
// @Security ApiKeyAuth
// @Success 200 {object} v1.GetOperationActionListResV1
// @Router /v1/operation_records/operation_actions [get]
func GetOperationActionList(c echo.Context) error {
return getOperationActionList(c)
}

type GetOperationRecordListReqV1 struct {
FilterOperateTimeFrom string `json:"filter_operate_time_from" query:"filter_operate_time_from"`
FilterOperateTimeTo string `json:"filter_operate_time_to" query:"filter_operate_time_to"`
FilterOperateProjectName *string `json:"filter_operate_project_name" query:"filter_operate_project_name"`
FuzzySearchOperateUserName string `json:"fuzzy_search_operate_user_name" query:"fuzzy_search_operate_user_name"`
FilterOperateTypeName string `json:"filter_operate_type_name" query:"filter_operate_type_name"`
FilterOperateAction string `json:"filter_operate_action" query:"filter_operate_action"`
PageIndex uint32 `json:"page_index" query:"page_index" valid:"required"`
PageSize uint32 `json:"page_size" query:"page_size" valid:"required"`
}

type GetOperationRecordListResV1 struct {
controller.BaseRes
Data []OperationRecordList `json:"data"`
TotalNums uint64 `json:"total_nums"`
}

type OperationRecordList struct {
ID uint64 `json:"id"`
OperationTime *time.Time `json:"operation_time"`
OperationUser OperationUser `json:"operation_user"`
OperationTypeName string `json:"operation_type_name"`
OperationAction string `json:"operation_action"`
OperationContent string `json:"operation_content"`
ProjectName string `json:"project_name"`
Status string `json:"status" enums:"succeeded,failed"`
}

type OperationUser struct {
UserName string `json:"user_name"`
IP string `json:"ip"`
}

// GetOperationRecordListV1
// @Summary 获取操作记录列表
// @Description Get operation record list
// @Id getOperationRecordListV1
// @Tags OperationRecord
// @Security ApiKeyAuth
// @Param filter_operate_time_from query string false "filter_operate_time_from"
// @Param filter_operate_time_to query string false "filter_operate_time_to"
// @Param filter_operate_project_name query string false "filter_operate_project_name"
// @Param fuzzy_search_operate_user_name query string false "fuzzy_search_operate_user_name"
// @Param filter_operate_type_name query string false "filter_operate_type_name"
// @Param filter_operate_action query string false "filter_operate_action"
// @Param page_index query uint32 true "page_index"
// @Param page_size query uint32 true "page_size"
// @Success 200 {object} v1.GetOperationRecordListResV1
// @Router /v1/operation_records [get]
func GetOperationRecordListV1(c echo.Context) error {
return getOperationRecordList(c)
}

type GetExportOperationRecordListReqV1 struct {
FilterOperateTimeFrom string `json:"filter_operate_time_from" query:"filter_operate_time_from"`
FilterOperateTimeTo string `json:"filter_operate_time_to" query:"filter_operate_time_to"`
FilterOperateProjectName *string `json:"filter_operate_project_name" query:"filter_operate_project_name"`
FuzzySearchOperateUserName string `json:"fuzzy_search_operate_user_name" query:"fuzzy_search_operate_user_name"`
FilterOperateTypeName string `json:"filter_operate_type_name" query:"filter_operate_type_name"`
FilterOperateAction string `json:"filter_operate_action" query:"filter_operate_action"`
}

// GetExportOperationRecordListV1
// @Summary 导出操作记录列表
// @Description Export operation record list
// @Id getExportOperationRecordListV1
// @Tags OperationRecord
// @Security ApiKeyAuth
// @Param filter_operate_time_from query string false "filter_operate_time_from"
// @Param filter_operate_time_to query string false "filter_operate_time_to"
// @Param filter_operate_project_name query string false "filter_operate_project_name"
// @Param fuzzy_search_operate_user_name query string false "fuzzy_search_operate_user_name"
// @Param filter_operate_type_name query string false "filter_operate_type_name"
// @Param filter_operate_action query string false "filter_operate_action"
// @Success 200 {file} file "get export operation record list"
// @Router /v1/operation_records/exports [get]
func GetExportOperationRecordListV1(c echo.Context) error {
return exportOperationRecordList(c)
}
Loading
Loading