common

README

common

Documentation

Index

• Variables
• type APIContext
• type Chain
  • func NewChain() *Chain
  • func (c *Chain) Append(middleware func(Handler) Handler)
  • func (c *Chain) Apply(h Handler) Handler
• type ColumnDataType
• type ContextKey
• type DatabaseType
• type Error
  • func NewError(code ErrorCode, message string, opts ...any) Error
• type ErrorCode
• type GlobalThisReader
• type Handler
• type HandlerFunc
  • func (h HandlerFunc) Handle(ctx APIContext)
• type MutableRequestContext
• type MutableResponseContext
• type PersistenceContext
• type PreparedQuery
• type QueryResult
• type QueryType
• type Repository
• type RequestContext
• type ResponseContext
• type ScriptRunner
• type TableType

Examples

• NewError

Variables

var ApiCtxKey = ContextKey{}

Types

type APIContext

type APIContext interface {
	RequestContext
	ResponseContext
	MutableRequestContext
	MutableResponseContext
}

APIContext combines request and response contexts

type Chain

type Chain struct {
	// contains filtered or unexported fields
}

func NewChain

func NewChain() *Chain

func (*Chain) Append

func (c *Chain) Append(middleware func(Handler) Handler)

func (*Chain) Apply

func (c *Chain) Apply(h Handler) Handler

type ColumnDataType

type ColumnDataType string

type ContextKey

type ContextKey struct{}

type DatabaseType

type DatabaseType string

type Error

type Error interface {
	Code() string
	Data() any

	error
}

func NewError

func NewError(code ErrorCode, message string, opts ...any) Error

Example

err := NewError("E001", "An error occurred", "data")
fmt.Println(err)
fmt.Println(err.Code())
fmt.Println(err.Data())

err = NewError("E005", "An error occurred", underlyingError)
fmt.Println(err)

Output:
An error occurred
E001
data
An error occurred, cause: underlying error

type ErrorCode

type ErrorCode string

type GlobalThisReader

type GlobalThisReader interface {
	Input() any
	Env() map[string]any
	Metas() map[string]any
	Session() map[string]any
	RequestHeaders() map[string]any

	Output() any
	ResponseHeaders() map[string]any
}

type Handler

type Handler interface {
	Handle(APIContext)
}

type HandlerFunc

type HandlerFunc func(APIContext)

func (HandlerFunc) Handle

func (h HandlerFunc) Handle(ctx APIContext)

type MutableRequestContext

type MutableRequestContext interface {
	SetRequestID(string)
	SetMethod(string)
	SetParams(any)
	SetRawParams([]byte)
	SetMetas(map[string]any)
}

MutableRequestContext allows modification of request context

type MutableResponseContext

type MutableResponseContext interface {
	SetResult(any)
	SetErr(error)
}

MutableResponseContext allows modification of response context

type PersistenceContext

type PersistenceContext interface {
	GetRepository(entity string) (Repository, error)
	GetAllQueryCount() int64
	CloseAllTxn(error) error
}

type PreparedQuery

type PreparedQuery struct {
	Query     string    `json:"query"`
	Bind      []any     `json:"bind"`
	QueryType QueryType `json:"queryType"`

	CheckPoint      []*PreparedQuery `json:"checkPoint"`
	DatabaseUpdater []*PreparedQuery `json:"databaseUpdater"`
	ResultEnricher  []*PreparedQuery `json:"resultEnricher"`
}

type QueryResult

type QueryResult struct {
	Row          map[string]any
	Rows         []map[string]any
	RowsAffected int64
	LastInsertId int64
	Total        int64
}

type QueryType

type QueryType string

type Repository

type Repository interface {
	BindNamed(query string, arg any) (string, []any, error)
	Find(query string, args ...any) (map[string]any, error)
	FindAll(query string, args ...any) ([]map[string]any, error)
	Insert(query string, args ...any) (int64, error)
	InsertBatch(query string, args ...any) (int64, error)
	// InsertNamedBatch
	// Deprecated
	InsertNamedBatch(query string, args []any) (int64, error)
	Update(query string, args ...any) (int64, error)
	Delete(query string, args ...any) (int64, error)

	Begin() error
	Commit() error
	Rollback() error

	Exec(query string, args ...any) error

	DriverName() string

	QueryTotal() int64
	SetTraceId(traceId string)
}

type RequestContext

type RequestContext interface {
	RequestID() string
	Method() string
	Params() any
	RawParams() []byte
	Metas() map[string]any
}

RequestContext contains request-related information

type ResponseContext

type ResponseContext interface {
	Result() any
	Err() error
}

ResponseContext contains response-related information

type ScriptRunner

type ScriptRunner interface {
	RunScript(globalThis map[string]any, pCtx PersistenceContext, sourceCode string) (any, error)
}

type TableType

type TableType string