funcspec

Dec 11, 2025

Changes in this version

type Handler

+ func (h *Handler) GetVariablesCallback() func(r *http.Request) map[string]interface{}

+ func (h *Handler) SetVariablesCallback(callback func(r *http.Request) map[string]interface{})

type SqlQueryOptions

+ func NewSqlQueryOptions() SqlQueryOptions

Dec 11, 2025

Changes in this version

+ type SqlQueryOptions struct

+ AllowFilter bool

+ BlankParams bool

+ GetVariablesCallback func(w http.ResponseWriter, r *http.Request) map[string]interface{}

+ NoCount bool

Dec 2, 2025

Changes in this version

+ func RegisterSecurityHooks(handler *Handler, securityList *security.SecurityList)

Dec 2, 2025

Changes in this version

type Handler

+ func (h *Handler) GetDatabase() common.Database

Dec 1, 2025

Changes in this version

+ func ExampleAuditHook(ctx *HookContext) error

+ func ExampleCacheHook(ctx *HookContext) error

+ func ExampleErrorHandlingHook(ctx *HookContext) error

+ func ExampleLoggingHook(ctx *HookContext) error

+ func ExampleQueryModificationHook(ctx *HookContext) error

+ func ExampleResultFilterHook(ctx *HookContext) error

+ func ExampleSecurityHook(ctx *HookContext) error

+ func IsNumeric(s string) bool

+ func ValidSQL(input, mode string) string

+ type FilterOperator struct

+ Logic string

+ Operator string

+ Value string

+ type HTTPFuncType func(http.ResponseWriter, *http.Request)

+ type Handler struct

+ func NewHandler(db common.Database) *Handler

+ func (h *Handler) ApplyDistinct(sqlQuery string, params *RequestParameters) string

+ func (h *Handler) ApplyFieldSelection(sqlQuery string, params *RequestParameters) string

+ func (h *Handler) ApplyFilters(sqlQuery string, params *RequestParameters) string

+ func (h *Handler) Hooks() *HookRegistry

+ func (h *Handler) ParseParameters(r *http.Request) *RequestParameters

+ func (h *Handler) SqlQuery(sqlquery string, pBlankparms bool) HTTPFuncType

+ func (h *Handler) SqlQueryList(sqlquery string, pNoCount, pBlankparms, pAllowFilter bool) HTTPFuncType

+ type HookContext struct

+ Abort bool

+ AbortCode int

+ AbortMessage string

+ AllowFilter bool

+ BlankParams bool

+ ComplexAPI bool

+ Context context.Context

+ Error error

+ Handler *Handler

+ InputVars []string

+ Limit int

+ MetaInfo map[string]interface{}

+ NoCount bool

+ Offset int

+ PropQry map[string]string

+ Request *http.Request

+ Result interface{}

+ SQLQuery string

+ SortColumns string

+ Total int64

+ UserContext *security.UserContext

+ Variables map[string]interface{}

+ Writer http.ResponseWriter

+ type HookFunc func(*HookContext) error

+ type HookRegistry struct

+ func NewHookRegistry() *HookRegistry

+ func (r *HookRegistry) Clear(hookType HookType)

+ func (r *HookRegistry) ClearAll()

+ func (r *HookRegistry) Count(hookType HookType) int

+ func (r *HookRegistry) Execute(hookType HookType, ctx *HookContext) error

+ func (r *HookRegistry) GetAllHookTypes() []HookType

+ func (r *HookRegistry) HasHooks(hookType HookType) bool

+ func (r *HookRegistry) Register(hookType HookType, hook HookFunc)

+ func (r *HookRegistry) RegisterMultiple(hookTypes []HookType, hook HookFunc)

+ type HookType string

+ const AfterQuery

+ const AfterQueryList

+ const AfterSQLExec

+ const BeforeQuery

+ const BeforeQueryList

+ const BeforeResponse

+ const BeforeSQLExec

+ type RequestParameters struct

+ ComplexAPI bool

+ CustomSQLOr string

+ CustomSQLWhere string

+ Distinct bool

+ FieldFilters map[string]string

+ Limit int

+ NotSelectFields []string

+ Offset int

+ ResponseFormat string

+ SearchFilters map[string]string

+ SearchOps map[string]FilterOperator

+ SelectFields []string

+ SkipCache bool

+ SkipCount bool

+ SortColumns string