加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
organization.go 2.53 KB
一键复制 编辑 原始数据 按行查看 历史
package influxdb
import (
"context"
"fmt"
)
// Organization is an organization. 🎉
type Organization struct {
ID ID `json:"id,omitempty"`
Name string `json:"name"`
Description string `json:"description"`
CRUDLog
}
// errors of org
var (
// ErrOrgNameisEmpty is error when org name is empty
ErrOrgNameisEmpty = &Error{
Code: EInvalid,
Msg: "org name is empty",
}
)
// ops for orgs error and orgs op logs.
const (
OpFindOrganizationByID = "FindOrganizationByID"
OpFindOrganization = "FindOrganization"
OpFindOrganizations = "FindOrganizations"
OpCreateOrganization = "CreateOrganization"
OpPutOrganization = "PutOrganization"
OpUpdateOrganization = "UpdateOrganization"
OpDeleteOrganization = "DeleteOrganization"
)
// OrganizationService represents a service for managing organization data.
type OrganizationService interface {
// Returns a single organization by ID.
FindOrganizationByID(ctx context.Context, id ID) (*Organization, error)
// Returns the first organization that matches filter.
FindOrganization(ctx context.Context, filter OrganizationFilter) (*Organization, error)
// Returns a list of organizations that match filter and the total count of matching organizations.
// Additional options provide pagination & sorting.
FindOrganizations(ctx context.Context, filter OrganizationFilter, opt ...FindOptions) ([]*Organization, int, error)
// Creates a new organization and sets b.ID with the new identifier.
CreateOrganization(ctx context.Context, b *Organization) error
// Updates a single organization with changeset.
// Returns the new organization state after update.
UpdateOrganization(ctx context.Context, id ID, upd OrganizationUpdate) (*Organization, error)
// Removes a organization by ID.
DeleteOrganization(ctx context.Context, id ID) error
}
// OrganizationUpdate represents updates to a organization.
// Only fields which are set are updated.
type OrganizationUpdate struct {
Name *string
Description *string `json:"description,omitempty"`
}
// ErrInvalidOrgFilter is the error indicate org filter is empty
var ErrInvalidOrgFilter = &Error{
Code: EInvalid,
Msg: "Please provide either orgID or org",
}
// OrganizationFilter represents a set of filter that restrict the returned results.
type OrganizationFilter struct {
Name *string
ID *ID
UserID *ID
}
func ErrInternalOrgServiceError(op string, err error) *Error {
return &Error{
Code: EInternal,
Msg: fmt.Sprintf("unexpected error in organizations; Err: %v", err),
Op: op,
Err: err,
}
}
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化