Interface RevisionCache

db/revision_cache_interface.go:30–70

RevisionCache is an interface that can be used to fetch a DocumentRevision for a Doc ID and Rev ID pair.

// RevisionCache is an interface that can be used to fetch a DocumentRevision for a Doc ID and Rev ID pair.
type RevisionCache interface {

	// GetWithRev returns the given revision, and stores if not already cached.
	// When includeDelta=true, the returned DocumentRevision will include delta - requires additional locking during retrieval.
	GetWithRev(ctx context.Context, docID, revID string, collectionID uint32, includeDelta bool) (DocumentRevision, error)

	// GetWithCV returns the given revision by CV, and stores if not already cached.
	// When includeDelta=true, the returned DocumentRevision will include delta - requires additional locking during retrieval.
	// When loadBackup=true, will load from backup revisions if requested version is not active document
	GetWithCV(ctx context.Context, docID string, cv *Version, collectionID uint32, includeDelta bool, loadBackup bool) (DocumentRevision, error)

	// GetActive returns the current revision for the given doc ID, and stores if not already cached.
	GetActive(ctx context.Context, docID string, collectionID uint32) (docRev DocumentRevision, err error)

	// Peek returns the given revision if present in the cache
	Peek(ctx context.Context, docID, revID string, collectionID uint32) (docRev DocumentRevision, found bool)

	// Put will store the given docRev in the cache
	Put(ctx context.Context, docRev DocumentRevision, collectionID uint32)

	// Upsert will remove existing value and re-create new one
	Upsert(ctx context.Context, docRev DocumentRevision, collectionID uint32)

	// RemoveWithRev evicts a revision from the cache using its revID.
	RemoveWithRev(ctx context.Context, docID, revID string, collectionID uint32)

	// RemoveWithCV evicts a revision from the cache using its current version.
	RemoveWithCV(ctx context.Context, docID string, cv *Version, collectionID uint32)

	// RemoveRevOnly removes the specified key from the revID lookup map in the cache
	RemoveRevOnly(ctx context.Context, docID, revID string, collectionID uint32)

	// RemoveCVOnly removes the specified key from the HLV lookup map in the cache
	RemoveCVOnly(ctx context.Context, docID string, cv *Version, collectionID uint32)

	// UpdateDelta stores the given toDelta value in the given rev if cached
	UpdateDelta(ctx context.Context, docID, revID string, collectionID uint32, toDelta RevisionDelta)

	// UpdateDeltaCV stores the given toDelta value in the given rev if cached but will look up in cache by cv
	UpdateDeltaCV(ctx context.Context, docID string, cv *Version, collectionID uint32, toDelta RevisionDelta)
}

const (
	RevCacheIncludeDelta = true