README
¶
replicator 
Go implementation of https://docs.couchdb.org/en/stable/replication/protocol.html
Goal is to have a 100% compatible implemntation of the replicator.
Ideas
Create a kubernetes deployable replicator. Requirements:
- Configuration via environment
- Chart example
- Docker container
- Logging
- Termination log
Couchdb
Launch via podman for local testing.
make couchdb
Documentation
¶
Index ¶
- Constants
- Variables
- type Config
- type Job
- type Replicator
- func (r *Replicator) CompareReplicationLogs(ctx context.Context, source, target *client.ReplicationLog) error
- func (r *Replicator) FindCommonAncestry(ctx context.Context) error
- func (r *Replicator) GetPeersInformation(ctx context.Context) error
- func (r *Replicator) LocateChangedDocuments(ctx context.Context) (string, error)
- func (r *Replicator) ReplicateChanges(ctx context.Context, lastSeq string) error
- func (r *Replicator) Reset(ctx context.Context) error
- func (r *Replicator) Run(ctx context.Context) error
- func (r *Replicator) SetLogger(logger logger.Logger)
- func (r *Replicator) VerifyPeers(ctx context.Context) error
- type UserCtx
Constants ¶
const MB10 = 10 * (1024 ^ 2)
MB10 10 MB
const NoVersion = "0"
Variables ¶
var ( ErrAbort = errors.New("abort replication") ErrReplicationCompleted = errors.New("replication completed") )
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Heartbeat For Continuous Replication the heartbeat parameter defines the heartbeat period in milliseconds. The RECOMMENDED value by default is 10000 (10 seconds).
Heartbeat time.Duration
}
func (Config) HeartbeatOrFallback ¶
type Job ¶
type Job struct {
ID string `json:"_id"`
Rev string `json:"_rev"`
UserCtx UserCtx `json:"user_ctx"`
Source *client.Remote `json:"source"`
Target *client.Remote `json:"target"`
CreateTarget bool `json:"create_target"`
Continuous bool `json:"continuous"`
Owner string `json:"owner"`
Config
}
func (*Job) GenerateReplicationID ¶
GenerateReplicationID generates a replication id using the given name, name could be a hostame. https://docs.couchdb.org/en/stable/replication/protocol.html#generate-replication-id
type Replicator ¶
type Replicator struct {
// contains filtered or unexported fields
}
Replicator implements the couchdb replication protocol: https://docs.couchdb.org/en/stable/replication/protocol.html
func NewReplicator ¶
func NewReplicator(name string, job *Job) (*Replicator, error)
func (*Replicator) CompareReplicationLogs ¶
func (r *Replicator) CompareReplicationLogs(ctx context.Context, source, target *client.ReplicationLog) error
2.4.2.3.3. Compare Replication Logs
func (*Replicator) FindCommonAncestry ¶
func (r *Replicator) FindCommonAncestry(ctx context.Context) error
FindCommonAncestry https://docs.couchdb.org/en/stable/replication/protocol.html#find-common-ancestry
func (*Replicator) GetPeersInformation ¶
func (r *Replicator) GetPeersInformation(ctx context.Context) error
GetPeersInformation https://docs.couchdb.org/en/stable/replication/protocol.html#get-peers-information
func (*Replicator) LocateChangedDocuments ¶
func (r *Replicator) LocateChangedDocuments(ctx context.Context) (string, error)
Locate Changed Documents https://docs.couchdb.org/en/stable/replication/protocol.html#locate-changed-documents
func (*Replicator) ReplicateChanges ¶
func (r *Replicator) ReplicateChanges(ctx context.Context, lastSeq string) error
ReplicateChanges https://docs.couchdb.org/en/stable/replication/protocol.html#replicate-changes
func (*Replicator) Reset ¶
func (r *Replicator) Reset(ctx context.Context) error
Reset resets the replicator state at the source and target database
func (*Replicator) SetLogger ¶
func (r *Replicator) SetLogger(logger logger.Logger)
func (*Replicator) VerifyPeers ¶
func (r *Replicator) VerifyPeers(ctx context.Context) error
VerifyPeers https://docs.couchdb.org/en/stable/replication/protocol.html#verify-peers
Source Files
Directories