entity

type Archive struct {
	Method         string         `yaml:"method"`
	ArchiveOptions ArchiveOptions `yaml:"options"`
}

type ArchiveOptions struct {
	Compression string `yaml:"compression"`
	Threads     string `yaml:"threads"`
}

type BackupMetadata struct {
	DateCreated time.Time `yaml:"dateCreated"`
	Host        string
	Keyspaces   []string
	SnapshotTag string    `yaml:"snapshotTag"`
	BuildInfo   BuildInfo `yaml:"buildInfo"`
	Archive     Archive   `yaml:"archive"`
}

type BackupResult struct {
	Error         error
	DateStarted   time.Time
	Duration      time.Duration
	SnapshotTag   string
	Keyspaces     []string
	Uploaded      bool
	CleanupResult CleanupResult
}

type BackupResults struct {
	TotalNodes    int
	BackedUpNodes int
	ByHost        map[string]BackupResult
	Error         error
}

type BuildInfo struct {
	Version string
	Commit  string
	Date    string
}

type CleanupResult struct {
	// an error that occurred while cleaning up files on a database node, if any
	LocalError error
	// an error that occurred while cleaning up a backup in remote storage, if any
	RemoteError          error
	RemovedRemoteBackups []RemoteBackup
}

type Credentials struct {
	User     string
	Password string
}

type Node struct {
	Info NodeInfo
	// a shell command executor on this node
	Cmd cmd.Executor
	// an SSH connection error, if any
	ConnectionErr error
}

type NodeBinaries struct {
	Cqlsh    string
	Nodetool string
}

type NodeCallback func(ctx context.Context, node *Node) NodeCallbackResult

type NodeCallbackResult struct {
	Host  string
	Value interface{}
	Err   error
}

type NodeCallbackResults map[string]NodeCallbackResult

type NodeInfo struct {
	// ip or domain name
	Host        string
	IpAddress   string
	DomainName  string
	DataPath    string
	ClusterName string
	Datacenter  string
	// a status according to `nodetool status`
	Status   string
	Binaries NodeBinaries
}

type RemoteBackup struct {
	Path        string
	HostPrefix  string
	DateCreated time.Time
	Removed     bool
	RemoveError error
}

type RemoteBackupsByHost map[string][]RemoteBackup

type RepairResult struct {
	Output   string
	Duration time.Duration
}

type RepairResults struct {
	TotalNodes    int
	RepairedNodes int
	ByHost        map[string]RepairResult
	Error         error
}

type Snapshot struct {
	Tag string
	// keeps the snapshots of specific database tables and indices
	Items []SnapshotItem
}

type SnapshotItem struct {
	Keyspace     string
	ColumnFamily string
}

type Snapshots map[string]Snapshot

type SnapshotsByNode map[string]Snapshots