Rename binary to litestream; add replicate command

This commit is contained in:
Ben Johnson
2020-12-24 17:05:25 -07:00
parent 89fd441e9a
commit 22d44fda6d
4 changed files with 158 additions and 83 deletions

View File

@@ -1,6 +1,7 @@
package main package main
import ( import (
"flag"
"fmt" "fmt"
"io/ioutil" "io/ioutil"
"os" "os"
@@ -11,6 +12,11 @@ import (
"gopkg.in/yaml.v2" "gopkg.in/yaml.v2"
) )
// Default settings.
const (
DefaultConfigPath = "~/litestream.yml"
)
// Config represents a configuration file for the litestream daemon. // Config represents a configuration file for the litestream daemon.
type Config struct { type Config struct {
DBs []*DBConfig `yaml:"databases"` DBs []*DBConfig `yaml:"databases"`
@@ -57,3 +63,7 @@ type ReplicaConfig struct {
Name string `yaml:"name"` // name of replicator, optional. Name string `yaml:"name"` // name of replicator, optional.
Path string `yaml:"path"` // used for file replicators Path string `yaml:"path"` // used for file replicators
} }
func registerConfigFlag(fs *flag.FlagSet, p *string) {
fs.StringVar(p, "config", DefaultConfigPath, "config path")
}

68
cmd/litestream/main.go Normal file
View File

@@ -0,0 +1,68 @@
package main
import (
"context"
"flag"
"fmt"
"log"
"os"
"strings"
)
// Build information.
var (
Version = "(development build)"
)
func main() {
log.SetFlags(0)
m := NewMain()
if err := m.Run(context.Background(), os.Args[1:]); err == flag.ErrHelp {
os.Exit(1)
} else if err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
}
type Main struct{}
func NewMain() *Main {
return &Main{}
}
func (m *Main) Run(ctx context.Context, args []string) (err error) {
var cmd string
if len(args) > 0 {
cmd, args = args[0], args[1:]
}
switch cmd {
case "replicate":
return (&ReplicateCommand{}).Run(ctx, args)
case "version":
return (&VersionCommand{}).Run(ctx, args)
default:
if cmd == "" || cmd == "help" || strings.HasPrefix(cmd, "-") {
m.Usage()
return flag.ErrHelp
}
return fmt.Errorf("litestream %s: unknown command", cmd)
}
}
func (m *Main) Usage() {
fmt.Println(`
litestream is a tool for replicating SQLite databases.
Usage:
litestream <command> [arguments]
The commands are:
replicate runs a server to replicate databases
version prints the version
`[1:])
}

View File

@@ -5,64 +5,13 @@ import (
"errors" "errors"
"flag" "flag"
"fmt" "fmt"
"log"
"os" "os"
"os/signal" "os/signal"
"github.com/benbjohnson/litestream" "github.com/benbjohnson/litestream"
) )
// Build information. type ReplicateCommand struct {
var (
Version = "(development build)"
)
// Default settings.
const (
DefaultConfigPath = "~/litestreamd.yml"
)
func main() {
// Setup signal handler.
ctx, cancel := context.WithCancel(context.Background())
c := make(chan os.Signal, 1)
signal.Notify(c, os.Interrupt)
go func() { <-c; cancel() }()
// Initialize program and read flags/config.
m := NewMain()
if err := m.ParseFlags(ctx, os.Args[1:]); err == flag.ErrHelp {
os.Exit(1)
} else if err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
// Display version information.
fmt.Printf("litestreamd %s\n", Version)
// Start monitoring databases.
if err := m.Run(ctx); err != nil {
m.Close()
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
// Notify user that initialization is done.
fmt.Printf("Initialized with %d databases.\n", len(m.DBs))
// Wait for signal to stop program.
<-ctx.Done()
signal.Reset()
// Gracefully close
if err := m.Close(); err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
}
type Main struct {
ConfigPath string ConfigPath string
Config Config Config Config
@@ -70,55 +19,71 @@ type Main struct {
DBs []*litestream.DB DBs []*litestream.DB
} }
func NewMain() *Main { func NewReplicateCommand() *ReplicateCommand {
return &Main{} return &ReplicateCommand{}
} }
// ParseFlags parses the flag set from args & loads the configuration. // Run loads all databases specified in the configuration.
func (m *Main) ParseFlags(ctx context.Context, args []string) (err error) { func (c *ReplicateCommand) Run(ctx context.Context, args []string) (err error) {
fs := flag.NewFlagSet("litestreamd", flag.ContinueOnError) fs := flag.NewFlagSet("litestream-replicate", flag.ContinueOnError)
fs.StringVar(&m.ConfigPath, "config", DefaultConfigPath, "configuration path") registerConfigFlag(fs, &c.ConfigPath)
fs.Usage = m.Usage fs.Usage = c.Usage
if err := fs.Parse(args); err != nil { if err := fs.Parse(args); err != nil {
return err return err
} }
// Initialize log.
log.SetFlags(0)
// Load configuration. // Load configuration.
if m.ConfigPath == "" { if c.ConfigPath == "" {
return errors.New("-config required") return errors.New("-config required")
} else if m.Config, err = ReadConfigFile(m.ConfigPath); err != nil { }
config, err := ReadConfigFile(c.ConfigPath)
if err != nil {
return err return err
} }
return nil // Setup signal handler.
} ctx, cancel := context.WithCancel(context.Background())
ch := make(chan os.Signal, 1)
signal.Notify(ch, os.Interrupt)
go func() { <-ch; cancel() }()
// Run loads all databases specified in the configuration. // Display version information.
func (m *Main) Run(ctx context.Context) (err error) { fmt.Printf("litestream %s\n", Version)
if len(m.Config.DBs) == 0 {
if len(config.DBs) == 0 {
return errors.New("configuration must specify at least one database") return errors.New("configuration must specify at least one database")
} }
for _, dbc := range m.Config.DBs { for _, dbc := range config.DBs {
if err := m.openDB(dbc); err != nil { if err := c.openDB(dbc); err != nil {
return err return err
} }
} }
// Notify user that initialization is done.
fmt.Printf("Initialized with %d databases.\n", len(c.DBs))
// Wait for signal to stop program.
<-ctx.Done()
signal.Reset()
// Gracefully close
if err := c.Close(); err != nil {
fmt.Fprintln(os.Stderr, err)
os.Exit(1)
}
return nil return nil
} }
// openDB instantiates and initializes a DB based on a configuration. // openDB instantiates and initializes a DB based on a configuration.
func (m *Main) openDB(config *DBConfig) error { func (c *ReplicateCommand) openDB(config *DBConfig) error {
// Initialize database with given path. // Initialize database with given path.
db := litestream.NewDB(config.Path) db := litestream.NewDB(config.Path)
// Instantiate and attach replicators. // Instantiate and attach replicators.
for _, rconfig := range config.Replicas { for _, rconfig := range config.Replicas {
r, err := m.createReplicator(db, rconfig) r, err := c.createReplicator(db, rconfig)
if err != nil { if err != nil {
return err return err
} }
@@ -129,23 +94,23 @@ func (m *Main) openDB(config *DBConfig) error {
if err := db.Open(); err != nil { if err := db.Open(); err != nil {
return err return err
} }
m.DBs = append(m.DBs, db) c.DBs = append(c.DBs, db)
return nil return nil
} }
// createReplicator instantiates a replicator for a DB based on a config. // createReplicator instantiates a replicator for a DB based on a config.
func (m *Main) createReplicator(db *litestream.DB, config *ReplicaConfig) (litestream.Replicator, error) { func (c *ReplicateCommand) createReplicator(db *litestream.DB, config *ReplicaConfig) (litestream.Replicator, error) {
switch config.Type { switch config.Type {
case "", "file": case "", "file":
return m.createFileReplicator(db, config) return c.createFileReplicator(db, config)
default: default:
return nil, fmt.Errorf("unknown replicator type in config: %q", config.Type) return nil, fmt.Errorf("unknown replicator type in config: %q", config.Type)
} }
} }
// createFileReplicator returns a new instance of FileReplicator build from config. // createFileReplicator returns a new instance of FileReplicator build from config.
func (m *Main) createFileReplicator(db *litestream.DB, config *ReplicaConfig) (*litestream.FileReplicator, error) { func (c *ReplicateCommand) createFileReplicator(db *litestream.DB, config *ReplicaConfig) (*litestream.FileReplicator, error) {
if config.Path == "" { if config.Path == "" {
return nil, fmt.Errorf("file replicator path require for db %q", db.Path()) return nil, fmt.Errorf("file replicator path require for db %q", db.Path())
} }
@@ -153,8 +118,8 @@ func (m *Main) createFileReplicator(db *litestream.DB, config *ReplicaConfig) (*
} }
// Close closes all open databases. // Close closes all open databases.
func (m *Main) Close() (err error) { func (c *ReplicateCommand) Close() (err error) {
for _, db := range m.DBs { for _, db := range c.DBs {
if e := db.SoftClose(); e != nil { if e := db.SoftClose(); e != nil {
fmt.Printf("error closing db: path=%s err=%s\n", db.Path(), e) fmt.Printf("error closing db: path=%s err=%s\n", db.Path(), e)
if err == nil { if err == nil {
@@ -165,18 +130,19 @@ func (m *Main) Close() (err error) {
return err return err
} }
func (m *Main) Usage() { func (c *ReplicateCommand) Usage() {
fmt.Println(` fmt.Println(`
litestreamd is a daemon for replicating SQLite databases. The replicate command starts a server to monitor & replicate databases
specified in your configuration file.
Usage: Usage:
litestreamd [arguments] litestream replicate [arguments]
Arguments: Arguments:
-config PATH -config PATH
Specifies the configuration file. Required. Specifies the configuration file. Defaults to ~/litestream.yml
`[1:]) `[1:])
} }

31
cmd/litestream/version.go Normal file
View File

@@ -0,0 +1,31 @@
package main
import (
"context"
"flag"
"fmt"
)
type VersionCommand struct{}
func (c *VersionCommand) Run(ctx context.Context, args []string) (err error) {
fs := flag.NewFlagSet("litestream-version", flag.ContinueOnError)
fs.Usage = c.Usage
if err := fs.Parse(args); err != nil {
return err
}
fmt.Println("litestream", Version)
return nil
}
func (c *VersionCommand) Usage() {
fmt.Println(`
Prints the version.
Usage:
litestream version
`[1:])
}