seaweedfs/weed/replication/sink/replication_sink.go

package sink

import (
	"github.com/seaweedfs/seaweedfs/weed/pb/filer_pb"
	"github.com/seaweedfs/seaweedfs/weed/replication/source"
	"github.com/seaweedfs/seaweedfs/weed/util"
)

type ReplicationSink interface {
	GetName() string
	Initialize(configuration util.Configuration, prefix string) error
	DeleteEntry(key string, isDirectory, deleteIncludeChunks bool, signatures []int32) error
	CreateEntry(key string, entry *filer_pb.Entry, signatures []int32) error
	UpdateEntry(key string, oldEntry *filer_pb.Entry, newParentPath string, newEntry *filer_pb.Entry, deleteIncludeChunks bool, signatures []int32) (foundExistingEntry bool, err error)
	GetSinkToDirectory() string
	// GetDestinationIdentity distinguishes this sink's write destination from
	// any other destination the same sink type could write to: endpoint or
	// account, bucket or container, and directory. filer.backup keys its resume
	// checkpoint on it, so two configurations writing to different places must
	// not share a value.
	GetDestinationIdentity() string
	SetSourceFiler(s *source.FilerSource)
	IsIncremental() bool
}

// EntryMover is an optional capability for sinks that can relocate an entry
// natively, in one atomic step, instead of create-then-delete. Drivers prefer
// it for a rename so a failed copy can never leave the source deleted with no
// committed destination, a directory move never deletes descendants before they
// are recreated, and the entry's chunks are neither re-copied nor leaked.
type EntryMover interface {
	MoveEntry(oldKey, newKey string, oldEntry, newEntry *filer_pb.Entry, signatures []int32) error
}

// MetadataOnlyDeleter is an optional capability for sinks whose own delete
// events reach remote write-back daemons: the destination filer re-emits a
// replicated delete, so a source delete that kept the remote object must stay
// metadata-only there too.
type MetadataOnlyDeleter interface {
	DeleteEntryKeepingRemoteObject(key string, isDirectory, deleteIncludeChunks bool, signatures []int32) error
}

// LatestVersionWriter is an optional capability for sinks whose CreateEntry
// guards a replayed write against the live source at the key's own path. A
// caller that already resolved the current source state — a flattened latest
// version lives under a different source path than the key it lands on — must
// not be skipped as stale by that check.
type LatestVersionWriter interface {
	CreateEntryLatest(key string, entry *filer_pb.Entry, signatures []int32) error
}

func CreateEntryLatest(s ReplicationSink, key string, entry *filer_pb.Entry, signatures []int32) error {
	if w, ok := s.(LatestVersionWriter); ok {
		return w.CreateEntryLatest(key, entry, signatures)
	}
	return s.CreateEntry(key, entry, signatures)
}

func DeleteEntry(s ReplicationSink, key string, isDirectory, deleteIncludeChunks, keepRemoteObject bool, signatures []int32) error {
	if deleter, ok := s.(MetadataOnlyDeleter); ok && keepRemoteObject {
		return deleter.DeleteEntryKeepingRemoteObject(key, isDirectory, deleteIncludeChunks, signatures)
	}
	return s.DeleteEntry(key, isDirectory, deleteIncludeChunks, signatures)
}

// VersionedDeleter is an optional capability for sinks that check a delete
// against the live source before removing the destination: a delete that
// reaches the sink after the source recreated the path must not remove the
// newer destination, since no later event brings it back. tsNs is the
// delete's mutation time, or 0 when the event does not carry one.
type VersionedDeleter interface {
	DeleteEntryVersion(key string, oldEntry *filer_pb.Entry, tsNs int64, deleteIncludeChunks bool, signatures []int32) error
}

func DeleteEntryVersion(s ReplicationSink, key string, oldEntry *filer_pb.Entry, tsNs int64, deleteIncludeChunks, keepRemoteObject bool, signatures []int32) error {
	if _, ok := s.(MetadataOnlyDeleter); ok && keepRemoteObject {
		return DeleteEntry(s, key, oldEntry.IsDirectory, deleteIncludeChunks, keepRemoteObject, signatures)
	}
	if deleter, ok := s.(VersionedDeleter); ok {
		return deleter.DeleteEntryVersion(key, oldEntry, tsNs, deleteIncludeChunks, signatures)
	}
	return DeleteEntry(s, key, oldEntry.IsDirectory, deleteIncludeChunks, keepRemoteObject, signatures)
}

var (
	Sinks []ReplicationSink
)