cmd

Documentation

Index

• Variables
• func NewDatabaseValue(env string, def DatabaseSpec) *envflags.Value[DatabaseSpec]
• type DatabaseFlags
  • func AddDatabaseFlags(baseEnv string, flags *flag.FlagSet, migrateFlag bool) *DatabaseFlags
  • func (f DatabaseFlags) Database() (store.Factory, error)
  • func (f DatabaseFlags) MustDatabase() store.Factory
  • func (f DatabaseFlags) String() DatabaseSpec
• type DatabaseSpec
  • func NewDatabaseSpec(s string) (DatabaseSpec, error)
  • func (d DatabaseSpec) String() string
• type ProxyFlags
  • func AddProxyFlags(proxyName string, withEnabledFlag bool, flags *flag.FlagSet) *ProxyFlags
  • func (p *ProxyFlags) Enabled() bool
  • func (p *ProxyFlags) Password() string
  • func (p *ProxyFlags) ProxyURL() string
  • func (p *ProxyFlags) Username() string

Variables

var (
	DefaultDatabase        = DatabaseSpec{Type: "sqlite", Path: "scrape_data/scrape.db"}
	ErrDatabaseFormat      = errors.New("database spec must be in the format <type>:<path spec>")
	ErrUnsupportedDatabase = errors.New("unsupported database type")
)

Functions

func NewDatabaseValue

func NewDatabaseValue(env string, def DatabaseSpec) *envflags.Value[DatabaseSpec]

Types

type DatabaseFlags

type DatabaseFlags struct {
	Migrate bool
	// contains filtered or unexported fields
}

func AddDatabaseFlags

func AddDatabaseFlags(baseEnv string, flags *flag.FlagSet, migrateFlag bool) *DatabaseFlags

func (DatabaseFlags) Database

func (f DatabaseFlags) Database() (store.Factory, error)

func (DatabaseFlags) MustDatabase

func (f DatabaseFlags) MustDatabase() store.Factory

func (DatabaseFlags) String

func (f DatabaseFlags) String() DatabaseSpec

type DatabaseSpec

type DatabaseSpec struct {
	Type string
	Path string
}

func NewDatabaseSpec

func NewDatabaseSpec(s string) (DatabaseSpec, error)

Format: <type>:<path spec> Example: sqlite:scrape_data/scrape.db Example: sqlite::memory:

func (DatabaseSpec) String

func (d DatabaseSpec) String() string

type ProxyFlags

type ProxyFlags struct {
	// contains filtered or unexported fields
}

func AddProxyFlags

func AddProxyFlags(proxyName string, withEnabledFlag bool, flags *flag.FlagSet) *ProxyFlags

Set up the command line args and environment variables for a proxy. The assumption here is that the app ultimately supports at least two different proxies, one for general usage and another for headless scraping. The general proxy should pass an empty proxy name. Other proxies should pass a unique name, which will be used in constructing the environment variable and command line argument names.

func (*ProxyFlags) Enabled

func (p *ProxyFlags) Enabled() bool

func (*ProxyFlags) Password

func (p *ProxyFlags) Password() string

func (*ProxyFlags) ProxyURL

func (p *ProxyFlags) ProxyURL() string

func (*ProxyFlags) Username

func (p *ProxyFlags) Username() string