Documentation
¶
Index ¶
- type Activity
- type DeleteIdentityProvider
- type DeleteMemo
- type DeleteMemoOrganizer
- type DeleteMemoRelation
- type DeleteResource
- type DeleteStorage
- type DeleteTag
- type DeleteUser
- type Driver
- type FieldMapping
- type FindIdentityProvider
- type FindMemo
- type FindMemoOrganizer
- type FindMemoRelation
- type FindResource
- type FindStorage
- type FindSystemSetting
- type FindTag
- type FindUser
- type FindUserSetting
- type FindUserSettingV1
- type IdentityProvider
- type IdentityProviderConfig
- type IdentityProviderOAuth2Config
- type IdentityProviderType
- type Memo
- type MemoOrganizer
- type MemoRelation
- type MemoRelationType
- type Resource
- type Role
- type RowStatus
- type Storage
- type Store
- func (s *Store) BackupTo(ctx context.Context, filename string) error
- func (s *Store) Close() error
- func (s *Store) CreateActivity(ctx context.Context, create *Activity) (*Activity, error)
- func (s *Store) CreateIdentityProvider(ctx context.Context, create *IdentityProvider) (*IdentityProvider, error)
- func (s *Store) CreateMemo(ctx context.Context, create *Memo) (*Memo, error)
- func (s *Store) CreateResource(ctx context.Context, create *Resource) (*Resource, error)
- func (s *Store) CreateStorage(ctx context.Context, create *Storage) (*Storage, error)
- func (s *Store) CreateUser(ctx context.Context, create *User) (*User, error)
- func (s *Store) DeleteIdentityProvider(ctx context.Context, delete *DeleteIdentityProvider) error
- func (s *Store) DeleteMemo(ctx context.Context, delete *DeleteMemo) error
- func (s *Store) DeleteMemoOrganizer(ctx context.Context, delete *DeleteMemoOrganizer) error
- func (s *Store) DeleteMemoRelation(ctx context.Context, delete *DeleteMemoRelation) error
- func (s *Store) DeleteResource(ctx context.Context, delete *DeleteResource) error
- func (s *Store) DeleteStorage(ctx context.Context, delete *DeleteStorage) error
- func (s *Store) DeleteTag(ctx context.Context, delete *DeleteTag) error
- func (s *Store) DeleteUser(ctx context.Context, delete *DeleteUser) error
- func (s *Store) FindMemosVisibilityList(ctx context.Context, memoIDs []int32) ([]Visibility, error)
- func (s *Store) GetIdentityProvider(ctx context.Context, find *FindIdentityProvider) (*IdentityProvider, error)
- func (s *Store) GetMemo(ctx context.Context, find *FindMemo) (*Memo, error)
- func (s *Store) GetMemoOrganizer(ctx context.Context, find *FindMemoOrganizer) (*MemoOrganizer, error)
- func (s *Store) GetMemoRelation(ctx context.Context, find *FindMemoRelation) (*MemoRelation, error)
- func (s *Store) GetResource(ctx context.Context, find *FindResource) (*Resource, error)
- func (s *Store) GetStorage(ctx context.Context, find *FindStorage) (*Storage, error)
- func (s *Store) GetSystemSetting(ctx context.Context, find *FindSystemSetting) (*SystemSetting, error)
- func (s *Store) GetSystemSettingValueWithDefault(ctx *context.Context, settingName string, defaultValue string) string
- func (s *Store) GetUser(ctx context.Context, find *FindUser) (*User, error)
- func (s *Store) GetUserAccessTokens(ctx context.Context, userID int32) ([]*storepb.AccessTokensUserSetting_AccessToken, error)
- func (s *Store) GetUserSetting(ctx context.Context, find *FindUserSetting) (*UserSetting, error)
- func (s *Store) GetUserSettingV1(ctx context.Context, find *FindUserSettingV1) (*storepb.UserSetting, error)
- func (s *Store) ListIdentityProviders(ctx context.Context, find *FindIdentityProvider) ([]*IdentityProvider, error)
- func (s *Store) ListMemoRelations(ctx context.Context, find *FindMemoRelation) ([]*MemoRelation, error)
- func (s *Store) ListMemos(ctx context.Context, find *FindMemo) ([]*Memo, error)
- func (s *Store) ListResources(ctx context.Context, find *FindResource) ([]*Resource, error)
- func (s *Store) ListStorages(ctx context.Context, find *FindStorage) ([]*Storage, error)
- func (s *Store) ListSystemSettings(ctx context.Context, find *FindSystemSetting) ([]*SystemSetting, error)
- func (s *Store) ListTags(ctx context.Context, find *FindTag) ([]*Tag, error)
- func (s *Store) ListUserSettings(ctx context.Context, find *FindUserSetting) ([]*UserSetting, error)
- func (s *Store) ListUserSettingsV1(ctx context.Context, find *FindUserSettingV1) ([]*storepb.UserSetting, error)
- func (s *Store) ListUsers(ctx context.Context, find *FindUser) ([]*User, error)
- func (s *Store) UpdateIdentityProvider(ctx context.Context, update *UpdateIdentityProvider) (*IdentityProvider, error)
- func (s *Store) UpdateMemo(ctx context.Context, update *UpdateMemo) error
- func (s *Store) UpdateResource(ctx context.Context, update *UpdateResource) (*Resource, error)
- func (s *Store) UpdateStorage(ctx context.Context, update *UpdateStorage) (*Storage, error)
- func (s *Store) UpdateUser(ctx context.Context, update *UpdateUser) (*User, error)
- func (s *Store) UpsertMemoOrganizer(ctx context.Context, upsert *MemoOrganizer) (*MemoOrganizer, error)
- func (s *Store) UpsertMemoRelation(ctx context.Context, create *MemoRelation) (*MemoRelation, error)
- func (s *Store) UpsertSystemSetting(ctx context.Context, upsert *SystemSetting) (*SystemSetting, error)
- func (s *Store) UpsertTag(ctx context.Context, upsert *Tag) (*Tag, error)
- func (s *Store) UpsertUserSetting(ctx context.Context, upsert *UserSetting) (*UserSetting, error)
- func (s *Store) UpsertUserSettingV1(ctx context.Context, upsert *storepb.UserSetting) (*storepb.UserSetting, error)
- func (s *Store) Vacuum(ctx context.Context) error
- type SystemSetting
- type Tag
- type UpdateIdentityProvider
- type UpdateMemo
- type UpdateResource
- type UpdateStorage
- type UpdateUser
- type User
- type UserSetting
- type Visibility
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DeleteIdentityProvider ¶ added in v0.13.2
type DeleteIdentityProvider struct {
ID int32
}
type DeleteMemo ¶ added in v0.14.0
type DeleteMemo struct {
ID int32
}
type DeleteMemoOrganizer ¶ added in v0.14.0
type DeleteMemoRelation ¶ added in v0.14.0
type DeleteMemoRelation struct {
MemoID *int32
RelatedMemoID *int32
Type *MemoRelationType
}
type DeleteResource ¶ added in v0.14.0
type DeleteStorage ¶ added in v0.14.0
type DeleteStorage struct {
ID int32
}
type DeleteUser ¶ added in v0.14.0
type DeleteUser struct {
ID int32
}
type Driver ¶ added in v0.16.0
type Driver interface {
GetDB() *sql.DB
Close() error
Migrate(ctx context.Context) error
Vacuum(ctx context.Context) error
BackupTo(ctx context.Context, filename string) error
// Activity model related methods.
CreateActivity(ctx context.Context, create *Activity) (*Activity, error)
// Resource model related methods.
CreateResource(ctx context.Context, create *Resource) (*Resource, error)
ListResources(ctx context.Context, find *FindResource) ([]*Resource, error)
UpdateResource(ctx context.Context, update *UpdateResource) (*Resource, error)
DeleteResource(ctx context.Context, delete *DeleteResource) error
// Memo model related methods.
CreateMemo(ctx context.Context, create *Memo) (*Memo, error)
ListMemos(ctx context.Context, find *FindMemo) ([]*Memo, error)
UpdateMemo(ctx context.Context, update *UpdateMemo) error
DeleteMemo(ctx context.Context, delete *DeleteMemo) error
FindMemosVisibilityList(ctx context.Context, memoIDs []int32) ([]Visibility, error)
// MemoRelation model related methods.
UpsertMemoRelation(ctx context.Context, create *MemoRelation) (*MemoRelation, error)
ListMemoRelations(ctx context.Context, find *FindMemoRelation) ([]*MemoRelation, error)
DeleteMemoRelation(ctx context.Context, delete *DeleteMemoRelation) error
// MemoOrganizer model related methods.
UpsertMemoOrganizer(ctx context.Context, upsert *MemoOrganizer) (*MemoOrganizer, error)
GetMemoOrganizer(ctx context.Context, find *FindMemoOrganizer) (*MemoOrganizer, error)
DeleteMemoOrganizer(ctx context.Context, delete *DeleteMemoOrganizer) error
// SystemSetting model related methods.
UpsertSystemSetting(ctx context.Context, upsert *SystemSetting) (*SystemSetting, error)
ListSystemSettings(ctx context.Context, find *FindSystemSetting) ([]*SystemSetting, error)
// User model related methods.
CreateUser(ctx context.Context, create *User) (*User, error)
UpdateUser(ctx context.Context, update *UpdateUser) (*User, error)
ListUsers(ctx context.Context, find *FindUser) ([]*User, error)
DeleteUser(ctx context.Context, delete *DeleteUser) error
// UserSetting model related methods.
UpsertUserSetting(ctx context.Context, upsert *UserSetting) (*UserSetting, error)
ListUserSettings(ctx context.Context, find *FindUserSetting) ([]*UserSetting, error)
UpsertUserSettingV1(ctx context.Context, upsert *storepb.UserSetting) (*storepb.UserSetting, error)
ListUserSettingsV1(ctx context.Context, find *FindUserSettingV1) ([]*storepb.UserSetting, error)
// IdentityProvider model related methods.
CreateIdentityProvider(ctx context.Context, create *IdentityProvider) (*IdentityProvider, error)
ListIdentityProviders(ctx context.Context, find *FindIdentityProvider) ([]*IdentityProvider, error)
GetIdentityProvider(ctx context.Context, find *FindIdentityProvider) (*IdentityProvider, error)
UpdateIdentityProvider(ctx context.Context, update *UpdateIdentityProvider) (*IdentityProvider, error)
DeleteIdentityProvider(ctx context.Context, delete *DeleteIdentityProvider) error
// Tag model related methods.
UpsertTag(ctx context.Context, upsert *Tag) (*Tag, error)
ListTags(ctx context.Context, find *FindTag) ([]*Tag, error)
DeleteTag(ctx context.Context, delete *DeleteTag) error
// Storage model related methods.
CreateStorage(ctx context.Context, create *Storage) (*Storage, error)
ListStorages(ctx context.Context, find *FindStorage) ([]*Storage, error)
GetStorage(ctx context.Context, find *FindStorage) (*Storage, error)
UpdateStorage(ctx context.Context, update *UpdateStorage) (*Storage, error)
DeleteStorage(ctx context.Context, delete *DeleteStorage) error
}
Driver is an interface for store driver. It contains all methods that store database driver should implement.
type FieldMapping ¶ added in v0.11.0
type FindIdentityProvider ¶ added in v0.13.2
type FindIdentityProvider struct {
ID *int32
}
type FindMemoOrganizer ¶ added in v0.14.0
type FindMemoRelation ¶ added in v0.14.0
type FindMemoRelation struct {
MemoID *int32
RelatedMemoID *int32
Type *MemoRelationType
}
type FindResource ¶ added in v0.14.0
type FindStorage ¶ added in v0.14.0
type FindStorage struct {
ID *int32
}
type FindSystemSetting ¶ added in v0.13.2
type FindSystemSetting struct {
Name string
}
type FindUserSetting ¶ added in v0.13.2
type FindUserSettingV1 ¶ added in v0.15.0
type FindUserSettingV1 struct {
UserID *int32
Key storepb.UserSettingKey
}
type IdentityProvider ¶ added in v0.13.2
type IdentityProvider struct {
ID int32
Name string
Type IdentityProviderType
IdentifierFilter string
Config *IdentityProviderConfig
}
type IdentityProviderConfig ¶ added in v0.11.0
type IdentityProviderConfig struct {
OAuth2Config *IdentityProviderOAuth2Config
}
type IdentityProviderOAuth2Config ¶ added in v0.11.0
type IdentityProviderOAuth2Config struct {
ClientID string `json:"clientId"`
ClientSecret string `json:"clientSecret"`
AuthURL string `json:"authUrl"`
TokenURL string `json:"tokenUrl"`
UserInfoURL string `json:"userInfoUrl"`
Scopes []string `json:"scopes"`
FieldMapping *FieldMapping `json:"fieldMapping"`
}
type IdentityProviderType ¶ added in v0.11.0
type IdentityProviderType string
const (
IdentityProviderOAuth2Type IdentityProviderType = "OAUTH2"
)
func (IdentityProviderType) String ¶ added in v0.14.0
func (t IdentityProviderType) String() string
type Memo ¶ added in v0.14.0
type Memo struct {
ID int32
// Standard fields
RowStatus RowStatus
CreatorID int32
CreatedTs int64
UpdatedTs int64
// Domain specific fields
Content string
Visibility Visibility
// Composed fields
// For those comment memos, the parent ID is the memo ID of the memo being commented.
// If the parent ID is nil, then this memo is not a comment.
ParentID *int32
Pinned bool
ResourceIDList []int32
RelationList []*MemoRelation
}
type MemoOrganizer ¶ added in v0.14.0
type MemoRelation ¶ added in v0.14.0
type MemoRelation struct {
MemoID int32
RelatedMemoID int32
Type MemoRelationType
}
type MemoRelationType ¶ added in v0.13.0
type MemoRelationType string
const ( // MemoRelationReference is the type for a reference memo relation. MemoRelationReference MemoRelationType = "REFERENCE" // MemoRelationComment is the type for a comment memo relation. MemoRelationComment MemoRelationType = "COMMENT" )
type Store ¶
Store provides database access to all raw objects.
func (*Store) CreateActivity ¶ added in v0.10.0
func (*Store) CreateIdentityProvider ¶ added in v0.11.0
func (s *Store) CreateIdentityProvider(ctx context.Context, create *IdentityProvider) (*IdentityProvider, error)
func (*Store) CreateMemo ¶
func (*Store) CreateResource ¶
func (*Store) CreateStorage ¶ added in v0.11.0
func (*Store) CreateUser ¶
func (*Store) DeleteIdentityProvider ¶ added in v0.11.0
func (s *Store) DeleteIdentityProvider(ctx context.Context, delete *DeleteIdentityProvider) error
func (*Store) DeleteMemo ¶
func (s *Store) DeleteMemo(ctx context.Context, delete *DeleteMemo) error
func (*Store) DeleteMemoOrganizer ¶ added in v0.7.2
func (s *Store) DeleteMemoOrganizer(ctx context.Context, delete *DeleteMemoOrganizer) error
func (*Store) DeleteMemoRelation ¶ added in v0.13.0
func (s *Store) DeleteMemoRelation(ctx context.Context, delete *DeleteMemoRelation) error
func (*Store) DeleteResource ¶
func (s *Store) DeleteResource(ctx context.Context, delete *DeleteResource) error
func (*Store) DeleteStorage ¶ added in v0.11.0
func (s *Store) DeleteStorage(ctx context.Context, delete *DeleteStorage) error
func (*Store) DeleteUser ¶ added in v0.3.0
func (s *Store) DeleteUser(ctx context.Context, delete *DeleteUser) error
func (*Store) FindMemosVisibilityList ¶ added in v0.13.2
func (*Store) GetIdentityProvider ¶ added in v0.11.0
func (s *Store) GetIdentityProvider(ctx context.Context, find *FindIdentityProvider) (*IdentityProvider, error)
func (*Store) GetMemoOrganizer ¶ added in v0.14.0
func (s *Store) GetMemoOrganizer(ctx context.Context, find *FindMemoOrganizer) (*MemoOrganizer, error)
func (*Store) GetMemoRelation ¶ added in v0.13.0
func (s *Store) GetMemoRelation(ctx context.Context, find *FindMemoRelation) (*MemoRelation, error)
func (*Store) GetResource ¶ added in v0.14.0
func (*Store) GetStorage ¶ added in v0.14.0
func (*Store) GetSystemSetting ¶ added in v0.13.2
func (s *Store) GetSystemSetting(ctx context.Context, find *FindSystemSetting) (*SystemSetting, error)
func (*Store) GetSystemSettingValueWithDefault ¶ added in v0.14.0
func (*Store) GetUserAccessTokens ¶ added in v0.15.0
func (s *Store) GetUserAccessTokens(ctx context.Context, userID int32) ([]*storepb.AccessTokensUserSetting_AccessToken, error)
GetUserAccessTokens returns the access tokens of the user.
func (*Store) GetUserSetting ¶ added in v0.13.2
func (s *Store) GetUserSetting(ctx context.Context, find *FindUserSetting) (*UserSetting, error)
func (*Store) GetUserSettingV1 ¶ added in v0.15.0
func (s *Store) GetUserSettingV1(ctx context.Context, find *FindUserSettingV1) (*storepb.UserSetting, error)
func (*Store) ListIdentityProviders ¶ added in v0.11.0
func (s *Store) ListIdentityProviders(ctx context.Context, find *FindIdentityProvider) ([]*IdentityProvider, error)
func (*Store) ListMemoRelations ¶ added in v0.13.0
func (s *Store) ListMemoRelations(ctx context.Context, find *FindMemoRelation) ([]*MemoRelation, error)
func (*Store) ListResources ¶ added in v0.14.0
func (*Store) ListStorages ¶ added in v0.14.0
func (*Store) ListSystemSettings ¶ added in v0.13.2
func (s *Store) ListSystemSettings(ctx context.Context, find *FindSystemSetting) ([]*SystemSetting, error)
func (*Store) ListUserSettings ¶ added in v0.13.2
func (s *Store) ListUserSettings(ctx context.Context, find *FindUserSetting) ([]*UserSetting, error)
func (*Store) ListUserSettingsV1 ¶ added in v0.15.0
func (s *Store) ListUserSettingsV1(ctx context.Context, find *FindUserSettingV1) ([]*storepb.UserSetting, error)
func (*Store) UpdateIdentityProvider ¶ added in v0.11.0
func (s *Store) UpdateIdentityProvider(ctx context.Context, update *UpdateIdentityProvider) (*IdentityProvider, error)
func (*Store) UpdateMemo ¶ added in v0.13.1
func (s *Store) UpdateMemo(ctx context.Context, update *UpdateMemo) error
func (*Store) UpdateResource ¶ added in v0.14.0
func (*Store) UpdateStorage ¶ added in v0.14.0
func (*Store) UpdateUser ¶ added in v0.14.0
func (*Store) UpsertMemoOrganizer ¶
func (s *Store) UpsertMemoOrganizer(ctx context.Context, upsert *MemoOrganizer) (*MemoOrganizer, error)
func (*Store) UpsertMemoRelation ¶ added in v0.13.0
func (s *Store) UpsertMemoRelation(ctx context.Context, create *MemoRelation) (*MemoRelation, error)
func (*Store) UpsertSystemSetting ¶ added in v0.7.1
func (s *Store) UpsertSystemSetting(ctx context.Context, upsert *SystemSetting) (*SystemSetting, error)
func (*Store) UpsertUserSetting ¶ added in v0.4.0
func (s *Store) UpsertUserSetting(ctx context.Context, upsert *UserSetting) (*UserSetting, error)
func (*Store) UpsertUserSettingV1 ¶ added in v0.15.0
func (s *Store) UpsertUserSettingV1(ctx context.Context, upsert *storepb.UserSetting) (*storepb.UserSetting, error)
type SystemSetting ¶ added in v0.13.2
type UpdateIdentityProvider ¶ added in v0.13.2
type UpdateIdentityProvider struct {
ID int32
Type IdentityProviderType
Name *string
IdentifierFilter *string
Config *IdentityProviderConfig
}
type UpdateMemo ¶ added in v0.14.0
type UpdateResource ¶ added in v0.14.0
type UpdateStorage ¶ added in v0.14.0
type UpdateUser ¶ added in v0.14.0
type UserSetting ¶ added in v0.13.2
type Visibility ¶ added in v0.13.1
type Visibility string
Visibility is the type of a visibility.
const ( // Public is the PUBLIC visibility. Public Visibility = "PUBLIC" // Protected is the PROTECTED visibility. Protected Visibility = "PROTECTED" // Private is the PRIVATE visibility. Private Visibility = "PRIVATE" )
func (Visibility) String ¶ added in v0.13.1
func (v Visibility) String() string
Source Files
¶
Click to show internal directories.
Click to hide internal directories.