database

Nov 22, 2024

Changes in this version

+ func PresenceChangeFromBytes(bytes []byte) (*innerpresence.PresenceChange, error)

type Database

+ FindLatestChangeInfoByActor func(ctx context.Context, docRefKey types.DocRefKey, actorID types.ID, ...) (*ChangeInfo, error)

Oct 28, 2024

Changes in this version

type Database

+ UpdateAndFindMinSyncedVersionVector func(ctx context.Context, clientInfo *ClientInfo, docRefKey types.DocRefKey, ...) (time.VersionVector, error)

Oct 23, 2024

Changes in this version

+ var ErrChangeNotFound = errors.New("change not found")

type ChangeInfo

+ VersionVector time.VersionVector

type Database

+ UpdateAndFindMinSyncedVersionVectorAfterPushPull func(ctx context.Context, clientInfo *ClientInfo, docRefKey types.DocRefKey, ...) (time.VersionVector, error)

+ UpdateVersionVector func(ctx context.Context, clientInfo *ClientInfo, docRefKey types.DocRefKey, ...) error

type SnapshotInfo

+ VersionVector time.VersionVector

+ type VersionVectorInfo struct

+ ClientID types.ID

+ DocID types.ID

+ ID types.ID

+ ProjectID types.ID

+ VersionVector time.VersionVector

Oct 22, 2024

Changes in this version

type ClientInfo

+ func (i *ClientInfo) ServerSeq(docID types.ID) (int64, error)

Aug 5, 2024

Changes in this version

type Database

+ ChangeUserPassword func(ctx context.Context, username, hashedNewPassword string) error

+ DeleteUserInfoByName func(ctx context.Context, username string) error

Jul 25, 2024

Changes in this version

type Database

+ FindDocInfosByKeys func(ctx context.Context, projectID types.ID, docKeys []key.Key) ([]*DocInfo, error)

Jul 3, 2024

Changes in this version

+ var ErrAttachedDocumentExists = errors.New("attached document exits when deactivated")

+ var ErrDocumentAlreadyDetached = errors.New("document already detached")

type ClientInfo

+ func (i *ClientInfo) EnsureDocumentsNotAttachedWhenDeactivated() error

Jun 3, 2024

Changes in this version

type ClientInfo

+ func (i *ClientInfo) EnsureActivated() error

Jan 29, 2024

Changes in this version

type ChangeInfo

+ ProjectID types.ID

+ type ClientDocInfoMap map[types.ID]*ClientDocInfo

type ClientInfo

+ func (i *ClientInfo) RefKey() types.ClientRefKey

type Database

+ FindClientInfoByRefKey func(ctx context.Context, refKey types.ClientRefKey) (*ClientInfo, error)

+ FindDocInfoByRefKey func(ctx context.Context, refKey types.DocRefKey) (*DocInfo, error)

+ FindSnapshotInfoByRefKey func(ctx context.Context, refKey types.SnapshotRefKey) (*SnapshotInfo, error)

+ FindUserInfoByName func(ctx context.Context, username string) (*UserInfo, error)

type DocInfo

+ func (info *DocInfo) RefKey() types.DocRefKey

type SnapshotInfo

+ ProjectID types.ID

+ func (i *SnapshotInfo) RefKey() types.SnapshotRefKey

type SyncedSeqInfo

+ ProjectID types.ID

Jan 19, 2024

Changes in this version

type Database

+ FindDeactivateCandidatesPerProject func(ctx context.Context, project *ProjectInfo, candidatesLimit int) ([]*ClientInfo, error)

+ FindNextNCyclingProjectInfos func(ctx context.Context, pageSize int, lastProjectID types.ID) ([]*ProjectInfo, error)

+ FindProjectInfoBySecretKey func(ctx context.Context, secretKey string) (*ProjectInfo, error)

+ FindUserInfoByID func(ctx context.Context, id types.ID) (*UserInfo, error)

Dec 18, 2023

Changes in this version

+ var ErrDecodeOperationFailed = errors.New("decode operations failed")

Aug 25, 2023

Changes in this version

+ var ErrSnapshotNotFound = errors.New("snapshot not found")

type Database

+ FindSnapshotInfoByID func(ctx context.Context, id types.ID) (*SnapshotInfo, error)

type SnapshotInfo

+ func (i *SnapshotInfo) DeepCopy() *SnapshotInfo

Jul 20, 2023

Changes in this version

+ func EncodePresenceChange(p *innerpresence.PresenceChange) (string, error)

type ChangeInfo

+ PresenceChange string

Jun 29, 2023

Changes in this version

+ var ErrClientDocNotFound = errors.New("client document not found")

type Database

+ IsDocumentAttached func(ctx context.Context, projectID types.ID, docID types.ID) (bool, error)

Jun 5, 2023

Changes in this version

type Database

+ UpdateDocInfoStatusToRemoved func(ctx context.Context, projectID types.ID, docID types.ID) error

Apr 18, 2023

Changes in this version

type ChangeInfo

+ func (i *ChangeInfo) DeepCopy() *ChangeInfo

Mar 24, 2023

Changes in this version

+ const DocumentAttached

+ const DocumentDetached

+ const DocumentRemoved

type ClientInfo

+ func (i *ClientInfo) RemoveDocument(docID types.ID) error

type DocInfo

+ RemovedAt time.Time

+ func (info *DocInfo) IsRemoved() bool

Feb 27, 2023

Changes in this version

+ var ErrInvalidTimeDurationString = errors.New("invalid time duration string format")

type ProjectInfo

+ ClientDeactivateThreshold string

+ func (i *ProjectInfo) ClientDeactivateThresholdAsTimeDuration() (time.Duration, error)

Sep 5, 2022

Changes in this version

type ProjectInfo

+ Owner types.ID

Aug 25, 2022

Changes in this version

type Database

+ FindMinSyncedSeqInfo func(ctx context.Context, docID types.ID) (*SyncedSeqInfo, error)

+ PurgeStaleChanges func(ctx context.Context, docID types.ID) error

Aug 3, 2022

Changes in this version

+ var DefaultPassword = "admin"

+ var DefaultUsername = "admin"

+ var ErrMismatchedPassword = fmt.Errorf("mismatched password")

+ var ErrUserAlreadyExists = errors.New("user already exists")

+ var ErrUserNotFound = errors.New("user not found")

+ func CompareHashAndPassword(hashed, password string) error

+ func HashedPassword(password string) (string, error)

type Database

+ CreateUserInfo func(ctx context.Context, username string, hashedPassword string) (*UserInfo, error)

+ EnsureDefaultUserAndProject func(ctx context.Context) (*UserInfo, *ProjectInfo, error)

+ FindUserInfo func(ctx context.Context, username string) (*UserInfo, error)

+ ListUserInfos func(ctx context.Context) ([]*UserInfo, error)

+ type UserInfo struct

+ CreatedAt time.Time

+ HashedPassword string

+ ID types.ID

+ Username string

+ func NewUserInfo(username, hashedPassword string) *UserInfo

+ func (i *UserInfo) DeepCopy() *UserInfo

+ func (i *UserInfo) ToUser() *types.User

Jul 27, 2022

Changes in this version

type Database

+ FindDocInfosByQuery func(ctx context.Context, projectID types.ID, query string, pageSize int) (*types.SearchResult[*DocInfo], error)

Jun 30, 2022

Changes in this version

type Database

+ FindDocInfoByKeyAndOwner func(ctx context.Context, projectID types.ID, clientID types.ID, docKey key.Key, ...) (*DocInfo, error)

Jun 22, 2022

Changes in this version

+ var ErrProjectNameAlreadyExists = errors.New("project name already exists")

type Database

+ FindProjectInfoByID func(ctx context.Context, id types.ID) (*ProjectInfo, error)

type ProjectInfo

+ UpdatedAt time.Time

+ func (i *ProjectInfo) UpdateFields(fields *types.UpdatableProjectFields)

May 25, 2022

Changes in this version

+ var ErrProjectAlreadyExists = errors.New("project already exists")

type Database

+ FindProjectInfoByName func(ctx context.Context, name string) (*ProjectInfo, error)

May 10, 2022

Changes in this version

+ const ClientActivated

+ const ClientDeactivated

+ var DefaultProjectID = types.ID("000000000000000000000000")

+ var DefaultProjectName = "default"

+ var ErrClientNotActivated = errors.New("client not activated")

+ var ErrClientNotFound = errors.New("client not found")

+ var ErrConflictOnUpdate = errors.New("conflict on update")

+ var ErrDocumentAlreadyAttached = errors.New("document already attached")

+ var ErrDocumentNeverAttached = errors.New("client has never attached the document")

+ var ErrDocumentNotAttached = errors.New("document not attached")

+ var ErrDocumentNotFound = errors.New("document not found")

+ var ErrEncodeOperationFailed = errors.New("encode operations failed")

+ var ErrProjectNotFound = errors.New("project not found")

+ func EncodeOperations(operations []operations.Operation) ([][]byte, error)

+ type ChangeInfo struct

+ ActorID types.ID

+ ClientSeq uint32

+ DocID types.ID

+ ID types.ID

+ Lamport uint64

+ Message string

+ Operations [][]byte

+ ServerSeq uint64

+ func (i *ChangeInfo) ToChange() (*change.Change, error)

+ type ClientDocInfo struct

+ ClientSeq uint32

+ ServerSeq uint64

+ Status string

+ type ClientInfo struct

+ CreatedAt time.Time

+ Documents map[types.ID]*ClientDocInfo

+ ID types.ID

+ Key string

+ ProjectID types.ID

+ Status string

+ UpdatedAt time.Time

+ func (i *ClientInfo) AttachDocument(docID types.ID) error

+ func (i *ClientInfo) Checkpoint(docID types.ID) change.Checkpoint

+ func (i *ClientInfo) Deactivate()

+ func (i *ClientInfo) DeepCopy() *ClientInfo

+ func (i *ClientInfo) DetachDocument(docID types.ID) error

+ func (i *ClientInfo) EnsureDocumentAttached(docID types.ID) error

+ func (i *ClientInfo) IsAttached(docID types.ID) (bool, error)

+ func (i *ClientInfo) UpdateCheckpoint(docID types.ID, cp change.Checkpoint) error

+ func (i ClientInfo) CheckIfInProject(projectID types.ID) error

+ type Database interface

+ ActivateClient func(ctx context.Context, projectID types.ID, key string) (*ClientInfo, error)

+ Close func() error

+ CreateChangeInfos func(ctx context.Context, projectID types.ID, docInfo *DocInfo, ...) error

+ CreateProjectInfo func(ctx context.Context, name string) (*ProjectInfo, error)

+ CreateSnapshotInfo func(ctx context.Context, docID types.ID, doc *document.InternalDocument) error

+ DeactivateClient func(ctx context.Context, projectID, clientID types.ID) (*ClientInfo, error)

+ EnsureDefaultProjectInfo func(ctx context.Context) (*ProjectInfo, error)

+ FindChangeInfosBetweenServerSeqs func(ctx context.Context, docID types.ID, from uint64, to uint64) ([]*ChangeInfo, error)

+ FindChangesBetweenServerSeqs func(ctx context.Context, docID types.ID, from uint64, to uint64) ([]*change.Change, error)

+ FindClientInfoByID func(ctx context.Context, projectID, clientID types.ID) (*ClientInfo, error)

+ FindClosestSnapshotInfo func(ctx context.Context, docID types.ID, serverSeq uint64) (*SnapshotInfo, error)

+ FindDeactivateCandidates func(ctx context.Context, deactivateThreshold gotime.Duration, candidatesLimit int) ([]*ClientInfo, error)

+ FindDocInfoByID func(ctx context.Context, id types.ID) (*DocInfo, error)

+ FindDocInfoByKey func(ctx context.Context, projectID types.ID, clientID types.ID, docKey key.Key, ...) (*DocInfo, error)

+ FindDocInfosByPaging func(ctx context.Context, paging types.Paging) ([]*DocInfo, error)

+ FindProjectInfoByPublicKey func(ctx context.Context, publicKey string) (*ProjectInfo, error)

+ ListProjectInfos func(ctx context.Context) ([]*ProjectInfo, error)

+ UpdateAndFindMinSyncedTicket func(ctx context.Context, clientInfo *ClientInfo, docID types.ID, serverSeq uint64) (*time.Ticket, error)

+ UpdateClientInfoAfterPushPull func(ctx context.Context, clientInfo *ClientInfo, docInfo *DocInfo) error

+ UpdateProjectInfo func(ctx context.Context, project *ProjectInfo) error

+ UpdateSyncedSeq func(ctx context.Context, clientInfo *ClientInfo, docID types.ID, serverSeq uint64) error

+ type DocInfo struct

+ AccessedAt time.Time

+ CreatedAt time.Time

+ ID types.ID

+ Key key.Key

+ Owner types.ID

+ ProjectID types.ID

+ ServerSeq uint64

+ UpdatedAt time.Time

+ func (info *DocInfo) DeepCopy() *DocInfo

+ func (info *DocInfo) IncreaseServerSeq() uint64

+ type ProjectInfo struct

+ AuthWebhookMethods []string

+ AuthWebhookURL string

+ CreatedAt time.Time

+ ID types.ID

+ Name string

+ PublicKey string

+ SecretKey string

+ func NewProjectInfo(name string) *ProjectInfo

+ func ToProjectInfo(project *types.Project) *ProjectInfo

+ func (i *ProjectInfo) DeepCopy() *ProjectInfo

+ func (i *ProjectInfo) ToProject() *types.Project

+ func (i *ProjectInfo) Validate() error

+ type SnapshotInfo struct

+ CreatedAt time.Time

+ DocID types.ID

+ ID types.ID

+ Lamport uint64

+ ServerSeq uint64

+ Snapshot []byte

+ type SyncedSeqInfo struct

+ ActorID types.ID

+ ClientID types.ID

+ DocID types.ID

+ ID types.ID

+ Lamport uint64

+ ServerSeq uint64