Documentation
¶
Index ¶
- type AppServer
- type CreateRefObjectRequest
- type CreateRequest
- type DbBulkRetrieve
- type DbCreate
- type DbDelete
- type DbEdit
- type DbOperation
- type DbRetrieve
- type DbUpdate
- type DeleteRefObjectRequest
- type DeleteRequest
- type EditRefObjectRequest
- type GetRefObjectRequest
- type GetRequest
- type HookFunction
- type KeyType
- type QueryRefObjectRequest
- type QueryRefObjectResponse
- type QueryRequest
- type QueryResponse
- type RefDbBulkRetrieve
- type RefDbCreate
- type RefDbDelete
- type RefDbEdit
- type RefDbOperation
- type RefDbRetrieve
- type RefDbUpdate
- type RepoBulkGet
- type RepoCount
- type RepoCreate
- type RepoDelete
- type RepoGet
- type RepoList
- type RepoOperation
- type RepoQuery
- type RepoUpdate
- type ScopedRepoCount
- type ScopedRepoCreate
- type ScopedRepoDelete
- type ScopedRepoList
- type ScopedRepoOperation
- type ScopedRepoUpdate
- type ServiceBulkGet
- type ServiceCreate
- type ServiceDelete
- type ServiceGet
- type ServiceOperation
- type ServiceQuery
- type ServiceUpdate
- type UpdateRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AppServer ¶
type AppServer interface {
Start() error // 开始
Stop(forced ...bool) error // 默认为优雅关闭, 如果forced为true, 则强制关闭
HookPreStart(fns ...HookFunction) AppServer // 添加启动前的钩子函数
HookPreStop(fns ...HookFunction) AppServer // 添加停止前的钩子函数
}
type CreateRefObjectRequest ¶
type CreateRequest ¶ added in v0.1.6
type CreateRequest[TCreateModel any] struct { Item TCreateModel `json:"item"` }
type DbBulkRetrieve ¶
type DbBulkRetrieve[TObjectKey KeyType, ModelObject any] interface { BulkGet(ids []TObjectKey) (map[TObjectKey]ModelObject, error) // 批量获取对象 }
DbBulkRetrieve 批量读取
type DbCreate ¶
type DbCreate[BizObject any, ModelObject any] interface { Create(bizObj BizObject) (ModelObject, error) // 创建对象 }
DbCreate 创建操作:C
type DbOperation ¶
type DbRetrieve ¶
type DbRetrieve[TObjectKey KeyType, TModelObject any, TCondition any] interface { Get(key TObjectKey) (TModelObject, error) // 获取对象 Count(filters map[string]string) (int64, error) // 统计对象 List(filters map[string]string, list ...*protobuf.ListParam) ([]TModelObject, error) // 列出对象, list不传的时候获取所有对象 GetQueryConditions(filters map[string]string) []TCondition // 获取查询条件 }
DbRetrieve 读操作
type DeleteRefObjectRequest ¶
type DeleteRefObjectRequest[TObjectKey KeyType] struct { Key TObjectKey `json:"key"` ItemKey TObjectKey `json:"item_key"` }
type DeleteRequest ¶ added in v0.1.6
type DeleteRequest[TKey KeyType] struct { Keys []TKey `json:"keys"` }
type EditRefObjectRequest ¶
type GetRefObjectRequest ¶
type GetRefObjectRequest[TObjectKey KeyType] struct { Key TObjectKey `json:"key"` ItemKey TObjectKey `json:"item_key"` }
type GetRequest ¶ added in v0.1.6
type GetRequest[TKey KeyType] struct { Key TKey `json:"key"` }
type HookFunction ¶
type HookFunction func() error
type QueryRefObjectRequest ¶
type QueryRefObjectResponse ¶
type QueryRequest ¶ added in v0.1.6
type QueryResponse ¶ added in v0.1.6
type RefDbBulkRetrieve ¶
type RefDbBulkRetrieve[TObjectKey KeyType, TRefModelObject any] interface { BulkGet(key TObjectKey, refKeys []TObjectKey) (map[TObjectKey]TRefModelObject, error) // 批量获取对象 }
RefDbBulkRetrieve 批量读取关联对象
type RefDbCreate ¶
type RefDbCreate[TObjectKey KeyType, TRefBizObject any, TRefModelObject any] interface { Create(key TObjectKey, refBizObj TRefBizObject) (TRefModelObject, error) // 创建关联对象DAO }
RefDbCreate 创建关联对象操作:C
type RefDbDelete ¶
type RefDbDelete[TObjectKey KeyType] interface { Delete(key, refKey TObjectKey) error // 删除关联对象DAO }
RefDbDelete 删除关联对象
type RefDbOperation ¶
type RefDbOperation[TObjectKey KeyType, TRefBizObject any, TRefModelObject any, TCondition any] interface { RefDbCreate[TObjectKey, TRefBizObject, TRefModelObject] RefDbRetrieve[TObjectKey, TRefModelObject, TCondition] RefDbUpdate[TRefModelObject] RefDbDelete[TObjectKey] }
type RefDbRetrieve ¶
type RefDbRetrieve[TObjectKey KeyType, TRefModelObject any, Condition any] interface { Get(key, refKey TObjectKey) (TRefModelObject, error) // 获取关联对象DAO Count(key TObjectKey, refObjFilters map[string]string) (int64, error) // 统计关联对象DAO List(key TObjectKey, refObjFilters map[string]string, list ...*protobuf.ListParam) ([]TRefModelObject, error) // 列出关联对象DAO GetQueryConditions(key TObjectKey, refObjFilters map[string]string) []Condition // 获取关联对象DAO }
RefDbRetrieve 读取关联对象操作:R
type RefDbUpdate ¶
type RefDbUpdate[TRefObjectModel any] interface { Update(refObjModel TRefObjectModel) error // 更新数据库关联对象 }
RefDbUpdate 更新关联对象:U
type RepoBulkGet ¶ added in v0.1.1
type RepoBulkGet[TKey KeyType, TModel any] interface { BulkGet(ctx context.Context, keys ...TKey) (map[TKey]TModel, error) }
RepoBulkGet 批量读取(返回 map) 调用者需要 slice 时,使用 pie.Values(map) 或 slices.Collect(maps.Values(map))
type RepoCreate ¶ added in v0.1.1
type RepoCreate[TCreate any, TKey KeyType] interface { Create(ctx context.Context, model TCreate) (TKey, error) }
RepoCreate 创建操作:C
type RepoDelete ¶ added in v0.1.1
type RepoDelete[TKey KeyType] interface { Delete(ctx context.Context, keys ...TKey) (int64, error) }
RepoDelete 删除:D
type RepoOperation ¶ added in v0.1.6
type RepoOperation[TKey KeyType, TCreate, TUpdate, TFilter, TModel any] interface { RepoCreate[TCreate, TKey] RepoGet[TKey, TModel] RepoCount[TFilter] RepoList[TFilter, TModel] RepoUpdate[TUpdate] RepoDelete[TKey] }
type RepoUpdate ¶ added in v0.1.1
RepoUpdate 更新:U
type ScopedRepoCount ¶ added in v0.1.6
type ScopedRepoCreate ¶ added in v0.1.6
type ScopedRepoDelete ¶ added in v0.1.6
type ScopedRepoList ¶ added in v0.1.6
type ScopedRepoOperation ¶ added in v0.1.6
type ScopedRepoOperation[TScopeKey, TKey KeyType, TCreate, TUpdate, TFilter, TModel any] interface { RepoGet[TKey, TModel] ScopedRepoCreate[TScopeKey, TKey, TCreate] ScopedRepoUpdate[TScopeKey, TUpdate] ScopedRepoDelete[TScopeKey, TKey] ScopedRepoCount[TScopeKey, TFilter] ScopedRepoList[TScopeKey, TFilter, TModel] }
type ScopedRepoUpdate ¶ added in v0.1.6
type ServiceBulkGet ¶ added in v0.1.1
type ServiceBulkGet[TKey KeyType, TResult any] interface { BulkGet(ctx context.Context, keys ...TKey) (map[TKey]TResult, error) }
ServiceBulkGet 批量读取(返回 map) 调用者需要 slice 时,使用 pie.Values(map) 或 slices.Collect(maps.Values(map))
type ServiceCreate ¶
type ServiceDelete ¶
type ServiceGet ¶ added in v0.0.11
type ServiceOperation ¶
type ServiceOperation[TKey KeyType, TCreate, TUpdate, TFilter, TResult any] interface { ServiceCreate[TCreate, TKey] ServiceGet[TKey, TResult] ServiceQuery[TFilter, TResult] ServiceUpdate[TUpdate] ServiceDelete[TKey] }
type ServiceQuery ¶ added in v0.0.11
type ServiceUpdate ¶
type UpdateRequest ¶ added in v0.1.8
type UpdateRequest[TUpdateModel any] struct { Item TUpdateModel `json:"item"` }
Click to show internal directories.
Click to hide internal directories.