gou

type API struct {
	ID     string `jsong:"id"`
	Name   string
	Source string
	Type   string
	HTTP   HTTP
}

type Column struct {
	Label       string       `json:"label,omitempty"`
	Name        string       `json:"name"`
	Type        string       `json:"type,omitempty"`
	Title       string       `json:"title,omitempty"`
	Description string       `json:"description,omitempty"`
	Comment     string       `json:"comment,omitempty"`
	Length      int          `json:"length,omitempty"`
	Precision   int          `json:"precision,omitempty"`
	Scale       int          `json:"scale,omitempty"`
	Nullable    bool         `json:"nullable,omitempty"`
	Option      []string     `json:"option,omitempty"`
	Default     interface{}  `json:"default,omitempty"`
	DefaultRaw  string       `json:"default_raw,omitempty"`
	Example     interface{}  `json:"example,omitempty"`
	Generate    string       `json:"generate,omitempty"` // Increment, UUID,...
	Crypt       string       `json:"crypt,omitempty"`    // AES, PASSWORD, AES-256, AES-128, PASSWORD-HASH, ...
	Validations []Validation `json:"validations,omitempty"`
	Index       bool         `json:"index,omitempty"`
	Unique      bool         `json:"unique,omitempty"`
	Primary     bool         `json:"primary,omitempty"`
	// contains filtered or unexported fields
}

type ColumnMap struct {
	Column *Column
	Model  *Model
	Export string // 取值时的变量名
}

type Encryptor struct {
	Name   string `json:"-"`                // 名称
	Source string `json:"-"`                // 来源
	Salt   string `json:"salt,omitempty"`   // 盐
	Key    string `json:"key,omitempty"`    // 钥匙
	Secret string `json:"secret,omitempty"` // 密钥
}

type EncryptorAES struct{ Encryptor }

type EncryptorAES128 struct{ Encryptor }

type EncryptorAES256 struct{ Encryptor }

type EncryptorPassword struct{ Encryptor }

type ErrorOfImport struct {
	Code    int         `json:"code"`            // 错误码
	Message string      `json:"message"`         // 错误描述
	File    string      `json:"file"`            // 出错文件
	Line    int         `json:"line,omitempty"`  // 出错行
	Field   string      `json:"field,omitempty"` // 源数据出错字段名称
	Value   interface{} `json:"value,omitempty"` // 源数据出错数值
}

type ErrorsImport []*ErrorOfImport

type ExportData struct {
	Model   string          `json:"model"`
	Columns []string        `json:"columns"`
	Values  [][]interface{} `json:"values"`
}

type Flow struct {
	Name        string                 `json:"-"`
	Source      string                 `json:"-"`
	Scripts     map[string]string      `json:"-"`
	Label       string                 `json:"label"`
	Version     string                 `json:"version"`
	Description string                 `json:"description,omitempty"`
	Nodes       []FlowNode             `json:"nodes,omitempty"`
	Output      interface{}            `json:"output,omitempty"`
	Global      map[string]interface{} // 全局变量
	Sid         string                 // 会话ID
}

type FlowContext struct {
	In      []interface{}
	Res     map[string]interface{}
	Context *context.Context
	Cancel  context.CancelFunc
}

type FlowNode struct {
	Name    string        `json:"name,omitempty"`
	Process string        `json:"process,omitempty"`
	Engine  string        `json:"engine,omitempty"` // 数据分析引擎名称
	Query   interface{}   `json:"query,omitempty"`  // 数据分析语言 Query Source
	DSL     share.DSL     `json:"-"`                // 数据分析语言 Query DSL
	Script  string        `json:"script,omitempty"`
	Args    []interface{} `json:"args,omitempty"`
	Outs    []interface{} `json:"outs,omitempty"`
}

type HTTP struct {
	Name        string `json:"name"`
	Version     string `json:"version"`
	Description string `json:"description,omitempty"`
	Group       string `json:"group,omitempty"`
	Guard       string `json:"guard,omitempty"`
	Paths       []Path `json:"paths,omitempty"`
}

type IEncryptor interface {
	Set(crypt Encryptor)
	Encode(value string) (string, error)
	Decode(value string) (string, error)
	Validate(hash string, value string) bool
}

type Import struct {
	Mapping map[string]string             `json:"mapping,omitempty"` // 源数据与数据模型字段映射表
	Process string                        `json:"process,omitempty"` // 源数据与数据模型转换处理器 (process & mapping 任选其一)
	Chunk   int                           `json:"chunk,omitempty"`   // 每次处理数据数量
	Notify  func(line int, record string) `json:"-"`                 // 进度通报函数
	Option  map[string]interface{}        `json:"option,omitempty"`  // CSV 分割符等参数

}

type Index struct {
	Comment string   `json:"comment,omitempty"`
	Name    string   `json:"name,omitempty"`
	Columns []string `json:"columns,omitempty"`
	Type    string   `json:"type,omitempty"` // primary,unique,index,match
}

type MetaData struct {
	Name      string              `json:"name,omitempty"`      // 元数据名称
	Connector string              `json:"connector,omitempty"` // Bind a connector, MySQL, SQLite, Postgres, Clickhouse, Tidb, Oracle support. default is SQLite
	Table     Table               `json:"table,omitempty"`     // 数据表选项
	Columns   []Column            `json:"columns,omitempty"`   // 字段定义
	Indexes   []Index             `json:"indexes,omitempty"`   // 索引定义
	Relations map[string]Relation `json:"relations,omitempty"` // 映射关系定义
	Values    []maps.MapStrAny    `json:"values,omitempty"`    // 初始数值
	Option    Option              `json:"option,omitempty"`    // 元数据配置
}

type Model struct {
	ID            string
	Name          string
	Source        string
	Driver        string // Driver
	MetaData      MetaData
	Columns       map[string]*Column // 字段映射表
	ColumnNames   []interface{}      // 字段名称清单
	PrimaryKey    string             // 主键(单一主键)
	PrimaryKeys   []string           // 主键(联合主键)
	UniqueColumns []*Column          // 唯一字段清单
}

type Option struct {
	Timestamps  bool `json:"timestamps,omitempty"`   // + created_at, updated_at 字段
	SoftDeletes bool `json:"soft_deletes,omitempty"` // + deleted_at 字段
	Trackings   bool `json:"trackings,omitempty"`    // + created_by, updated_by, deleted_by 字段
	Constraints bool `json:"constraints,omitempty"`  // + 约束定义
	Permission  bool `json:"permission,omitempty"`   // + __permission 字段
	Logging     bool `json:"logging,omitempty"`      // + __logging_id 字段
	Readonly    bool `json:"read_only,omitempty"`    // Ignore the migrate operation
}

type Out struct {
	Status   int               `json:"status"`
	Type     string            `json:"type,omitempty"`
	Body     interface{}       `json:"body,omitempty"`
	Headers  map[string]string `json:"headers,omitempty"`
	Redirect *Redirect         `json:"redirect,omitempty"`
}

type Path struct {
	Label       string   `json:"label,omitempty"`
	Description string   `json:"description,omitempty"`
	Path        string   `json:"path"`
	Method      string   `json:"method"`
	Process     string   `json:"process"`
	Guard       string   `json:"guard,omitempty"`
	In          []string `json:"in,omitempty"`
	Out         Out      `json:"out,omitempty"`
}

type Plugin struct {
	Client *plugin.Client
	Model  grpc.Model
	Name   string
	Cmd    string
}

type Process struct {
	Name    string
	Type    string
	Class   string
	Method  string
	Args    []interface{}
	Global  map[string]interface{} // 全局变量
	Sid     string                 // 会话ID
	Handler ProcessHandler
}

type ProcessHandler func(process *Process) interface{}

type QueryOrder struct {
	Rel    string `json:"rel,omitempty"` // Relation Name
	Column string `json:"column"`
	Option string `json:"option,omitempty"` // desc, asc
}

type QueryParam struct {
	Model    string          `json:"model,omitempty"`
	Table    string          `json:"table,omitempty"`
	Alias    string          `json:"alias,omitempty"`
	Export   string          `json:"export,omitempty"` // 导出前缀
	Select   []interface{}   `json:"select,omitempty"` // string | dbal.Raw
	Wheres   []QueryWhere    `json:"wheres,omitempty"`
	Orders   []QueryOrder    `json:"orders,omitempty"`
	Limit    int             `json:"limit,omitempty"`
	Page     int             `json:"page,omitempty"`
	PageSize int             `json:"pagesize,omitempty"`
	Withs    map[string]With `json:"withs,omitempty"`
}

type QueryStack struct {
	Builders []QueryStackBuilder
	Params   []QueryStackParam
	Current  int
}

type QueryStackBuilder struct {
	Model     *Model
	Query     query.Query
	ColumnMap map[string]ColumnMap
}

type QueryStackParam struct {
	QueryParam   QueryParam
	Relation     Relation
	ExportPrefix string // 字段导出前缀
}

type QueryWhere struct {
	Rel    string       `json:"rel,omitempty"` // Relation Name
	Column interface{}  `json:"column,omitempty"`
	Value  interface{}  `json:"value,omitempty"`
	Method string       `json:"method,omitempty"` // where,orwhere, wherein, orwherein...
	OP     string       `json:"op,omitempty"`     // 操作 eq/gt/lt/ge/le/like...
	Wheres []QueryWhere `json:"wheres,omitempty"` // 分组查询
}

type Redirect struct {
	Code     int    `json:"code,omitempty"`
	Location string `json:"location,omitempty"`
}

type Relation struct {
	Name    string     `json:"-"`
	Type    string     `json:"type"`
	Key     string     `json:"key,omitempty"`
	Model   string     `json:"model,omitempty"`
	Foreign string     `json:"foreign,omitempty"`
	Links   []Relation `json:"links,omitempty"`
	Query   QueryParam `json:"query,omitempty"`
}

type ResponseImport struct {
	Import  *Import       `json:"import"`  // 导入数据
	Errors  *ErrorsImport `json:"errors"`  // 导入错误集合
	Success int           `json:"success"` // 成功导入记录数量
	Failure int           `json:"failure"` // 失败导入记录数量
	Total   int           `json:"total"`   // 总记录记录数量
}

type Schedule struct {
	Name     string        `json:"name"`
	Process  string        `json:"process,omitempty"`
	Schedule string        `json:"schedule"`
	TaskName string        `json:"task,omitempty"`
	Args     []interface{} `json:"args,omitempty"`

	Enabled bool
	// contains filtered or unexported fields
}

type Server struct {
	Debug  bool     `json:"debug,omitempty"`
	Port   int      `json:"port,omitempty"`
	Host   string   `json:"host,omitempty"`
	Root   string   `json:"root,omitempty"`   // API 根目录
	Allows []string `json:"allows,omitempty"` // 许可跨域访问域名
}

type Socket struct {
	Name         string      `json:"name"`
	Version      string      `json:"version"`
	Mode         string      `json:"mode,omitempty"` // Server | client
	Description  string      `json:"description,omitempty"`
	Protocol     string      `json:"protocol,omitempty"`
	Host         string      `json:"host,omitempty"`
	Port         string      `json:"port,omitempty"`
	Event        SocketEvent `json:"event,omitempty"`
	Timeout      int         `json:"timeout,omitempty"` // timeout (seconds)
	BufferSize   int         `json:"buffer,omitempty"`  // bufferSize
	KeepAlive    int         `json:"keep,omitempty"`    // -1 not keep alive, 0 keep alive always, keep alive n seconds.
	Process      string      `json:"process,omitempty"`
	AttemptAfter int         `json:"attempt_after,omitempty"` // Attempt attempt_after
	Attempts     int         `json:"attempts,omitempty"`      // max times try to reconnect server when connection break (client mode only)
	// contains filtered or unexported fields
}

type SocketEvent struct {
	Data      string `json:"data,omitempty"`
	Error     string `json:"error,omitempty"`
	Closed    string `json:"closed,omitempty"`
	Connected string `json:"connected,omitempty"`
}

type Store struct {
	Name        string                 `json:"name"`
	Description string                 `json:"description,omitempty"`
	Connector   string                 `json:"connector,omitempty"`
	Type        string                 `json:"type,omitempty"` // warning: type is deprecated in the future new version
	Option      map[string]interface{} `json:"option,omitempty"`
}

type Table struct {
	Name        string   `json:"name,omitempty"`   // optional, if not set, the default is generate from model name. eg name.space.user, table name is name_space_user
	Prefix      string   `json:"prefix,omitempty"` // optional, the table prefix
	Comment     string   `json:"comment,omitempty"`
	Engine      string   `json:"engine,omitempty"` // InnoDB,MyISAM ( MySQL Only )
	Collation   string   `json:"collation"`
	Charset     string   `json:"charset"`
	PrimaryKeys []string `json:"primarykeys"`
}

type TaskOption struct {
	Name         string      `json:"name"`
	Process      string      `json:"process"`
	Size         interface{} `json:"size,omitempty"`
	WorkerNums   interface{} `json:"worker_nums,omitempty"`
	AttemptAfter interface{} `json:"attempt_after,omitempty"`
	Attempts     interface{} `json:"attempts,omitempty"`
	Timeout      interface{} `json:"timeout,omitempty"`
	Event        struct {
		Next     string `json:"next,omitempty"`
		Add      string `json:"add,omitempty"`
		Success  string `json:"success,omitempty"`
		Error    string `json:"error,omitempty"`
		Progress string `json:"progress,omitempty"`
	} `json:"event"`
}

type Template struct{}

type UploadFile struct {
	Name     string               `json:"name"`
	TempFile string               `json:"tempFile"`
	Size     int64                `json:"size"`
	Header   textproto.MIMEHeader `json:"mimeType"`
}

type ValidateResponse struct {
	Line     int      `json:"line,omitempty"`
	Column   string   `json:"column,omitempty"`
	Messages []string `json:"messages,omitempty"`
}

type Validation struct {
	Method  string        `json:"method"`
	Args    []interface{} `json:"args,omitempty"`
	Message string        `json:"message,omitempty"`
}

type WebSocket struct {
	websocket.WSClientOption
	Event  WebSocketEvent `json:"event,omitempty"`
	Client *websocket.WSClient
}

type WebSocketEvent struct {
	Data      string `json:"data,omitempty"`
	Error     string `json:"error,omitempty"`
	Closed    string `json:"closed,omitempty"`
	Connected string `json:"connected,omitempty"`
}

type With struct {
	Name  string     `json:"name"`
	Query QueryParam `json:"query,omitempty"`
}