cmds

package
v1.0.0-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 22, 2024 License: GPL-3.0 Imports: 32 Imported by: 1

Documentation

Overview

Package cmds provides CLI tools for running various actions

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CopyCommand

type CopyCommand struct {
	copier.Options
	// contains filtered or unexported fields
}

CopyCommand

func (*CopyCommand) AddFlags

func (cmd *CopyCommand) AddFlags(fl *pflag.FlagSet)

func (*CopyCommand) HelpArgs

func (cmd *CopyCommand) HelpArgs() string

func (*CopyCommand) HelpDesc

func (cmd *CopyCommand) HelpDesc() (string, string)

func (*CopyCommand) HelpExample

func (cmd *CopyCommand) HelpExample() string

func (*CopyCommand) Parse

func (cmd *CopyCommand) Parse(args []string) error

func (*CopyCommand) Run

func (cmd *CopyCommand) Run() error

type DeleteCommand

type DeleteCommand struct {
	ExtraTables []string
	DryRun      bool
	FVID        int
	DBURL       string
	Adapter     tldb.Adapter // allow for mocks
}

func (*DeleteCommand) AddFlags

func (cmd *DeleteCommand) AddFlags(fl *pflag.FlagSet)

func (*DeleteCommand) HelpArgs

func (cmd *DeleteCommand) HelpArgs() string

func (*DeleteCommand) HelpDesc

func (cmd *DeleteCommand) HelpDesc() (string, string)

func (*DeleteCommand) Parse

func (cmd *DeleteCommand) Parse(args []string) error

Parse command line flags

func (*DeleteCommand) Run

func (cmd *DeleteCommand) Run() error

Run this command

type ExtractCommand

type ExtractCommand struct {
	// Default options
	copier.Options

	// extract specific arguments
	Prefix string
	// contains filtered or unexported fields
}

ExtractCommand

func (*ExtractCommand) AddFlags

func (cmd *ExtractCommand) AddFlags(fl *pflag.FlagSet)

func (*ExtractCommand) HelpArgs

func (cmd *ExtractCommand) HelpArgs() string

func (*ExtractCommand) HelpDesc

func (cmd *ExtractCommand) HelpDesc() (string, string)

func (*ExtractCommand) HelpExample

func (cmd *ExtractCommand) HelpExample() string

func (*ExtractCommand) Parse

func (cmd *ExtractCommand) Parse(args []string) error

func (*ExtractCommand) Run

func (cmd *ExtractCommand) Run() error

type FetchCommand

type FetchCommand struct {
	Options    fetch.Options
	CreateFeed bool
	Workers    int
	Fail       bool
	Limit      int
	DBURL      string
	DryRun     bool
	FeedIDs    []string
	Results    []FetchCommandResult
	Adapter    tldb.Adapter // allow for mocks
	// contains filtered or unexported fields
}

FetchCommand fetches feeds defined a DMFR database.

func (*FetchCommand) AddFlags

func (cmd *FetchCommand) AddFlags(fl *pflag.FlagSet)

func (*FetchCommand) HelpArgs

func (cmd *FetchCommand) HelpArgs() string

func (*FetchCommand) HelpDesc

func (cmd *FetchCommand) HelpDesc() (string, string)

func (*FetchCommand) Parse

func (cmd *FetchCommand) Parse(args []string) error

func (*FetchCommand) Run

func (cmd *FetchCommand) Run() error

Run executes this command.

type FetchCommandResult

type FetchCommandResult struct {
	Result           fetch.Result
	FeedVersion      *dmfr.FeedVersion
	ValidationResult *validator.Result
	FatalError       error
}

type FormatCommand

type FormatCommand struct {
	Filename string
	Save     bool
}

FormatCommand formats a DMFR file.

func (*FormatCommand) AddFlags

func (cmd *FormatCommand) AddFlags(fl *pflag.FlagSet)

func (*FormatCommand) HelpArgs

func (cmd *FormatCommand) HelpArgs() string

func (*FormatCommand) HelpDesc

func (cmd *FormatCommand) HelpDesc() (string, string)

func (*FormatCommand) Parse

func (cmd *FormatCommand) Parse(args []string) error

Parse command line options.

func (*FormatCommand) Run

func (cmd *FormatCommand) Run() error

Run this command.

type ImportCommand

type ImportCommand struct {
	Options      importer.Options
	Workers      int
	Limit        int
	Fail         bool
	DBURL        string
	CoverDate    string
	FetchedSince string
	Latest       bool
	DryRun       bool
	FeedIDs      []string
	FVIDs        []string
	FVSHA1       []string
	Results      []ImportCommandResult
	Adapter      tldb.Adapter // allow for mocks
	// contains filtered or unexported fields
}

ImportCommand imports FeedVersions into a database.

func (*ImportCommand) AddFlags

func (cmd *ImportCommand) AddFlags(fl *pflag.FlagSet)

func (*ImportCommand) HelpArgs

func (cmd *ImportCommand) HelpArgs() string

func (*ImportCommand) HelpDesc

func (cmd *ImportCommand) HelpDesc() (string, string)

func (*ImportCommand) Parse

func (cmd *ImportCommand) Parse(args []string) error

Parse command line flags

func (*ImportCommand) Run

func (cmd *ImportCommand) Run() error

Run this command

type ImportCommandResult

type ImportCommandResult struct {
	Result     importer.Result
	FatalError error
}

type LintCommand

type LintCommand struct {
	Filenames []string
}

LintCommand lints a DMFR file.

func (*LintCommand) AddFlags

func (cmd *LintCommand) AddFlags(fl *pflag.FlagSet)

func (*LintCommand) HelpArgs

func (cmd *LintCommand) HelpArgs() string

func (*LintCommand) HelpDesc

func (cmd *LintCommand) HelpDesc() (string, string)

func (*LintCommand) Parse

func (cmd *LintCommand) Parse(args []string) error

Parse command line options.

func (*LintCommand) Run

func (cmd *LintCommand) Run() error

Run this command.

type MergeCommand

type MergeCommand struct {
	Options copier.Options
	// contains filtered or unexported fields
}

MergeCommand

func (*MergeCommand) AddFlags

func (cmd *MergeCommand) AddFlags(fl *pflag.FlagSet)

func (*MergeCommand) HelpArgs

func (cmd *MergeCommand) HelpArgs() string

func (*MergeCommand) HelpDesc

func (cmd *MergeCommand) HelpDesc() (string, string)

func (*MergeCommand) Parse

func (cmd *MergeCommand) Parse(args []string) error

func (*MergeCommand) Run

func (cmd *MergeCommand) Run() error

type RebuildStatsCommand

type RebuildStatsCommand struct {
	Options RebuildStatsOptions
	Workers int
	DBURL   string
	FeedIDs []string
	FVIDs   []string
	FVSHA1  []string
	Adapter tldb.Adapter // allow for mocks
	// contains filtered or unexported fields
}

RebuildStatsCommand rebuilds feed version statistics

func (*RebuildStatsCommand) AddFlags

func (cmd *RebuildStatsCommand) AddFlags(fl *pflag.FlagSet)

func (*RebuildStatsCommand) HelpArgs

func (cmd *RebuildStatsCommand) HelpArgs() string

func (*RebuildStatsCommand) HelpDesc

func (cmd *RebuildStatsCommand) HelpDesc() (string, string)

func (*RebuildStatsCommand) Parse

func (cmd *RebuildStatsCommand) Parse(args []string) error

Parse command line flags

func (*RebuildStatsCommand) Run

func (cmd *RebuildStatsCommand) Run() error

Run this command

type RebuildStatsOptions

type RebuildStatsOptions struct {
	FeedVersionID           int
	Storage                 string
	ValidationReportStorage string
	SaveValidationReport    bool
}

type RebuildStatsResult

type RebuildStatsResult struct {
	Error error
}

type SyncCommand

type SyncCommand struct {
	DBURL   string
	Adapter tldb.Adapter
	sync.Options
}

SyncCommand syncs a DMFR to a database.

func (*SyncCommand) AddFlags

func (cmd *SyncCommand) AddFlags(fl *pflag.FlagSet)

func (*SyncCommand) HelpArgs

func (cmd *SyncCommand) HelpArgs() string

func (*SyncCommand) HelpDesc

func (cmd *SyncCommand) HelpDesc() (string, string)

func (*SyncCommand) Parse

func (cmd *SyncCommand) Parse(args []string) error

Parse command line options.

func (*SyncCommand) Run

func (cmd *SyncCommand) Run() error

Run this command.

type UnimportCommand

type UnimportCommand struct {
	ScheduleOnly bool
	ExtraTables  []string
	DryRun       bool
	FVIDs        []string
	FVSHA1       []string
	Extensions   []string
	FeedIDs      []string
	DBURL        string
	Workers      int
	Adapter      tldb.Adapter // allow for mocks
	// contains filtered or unexported fields
}

UnimportCommand imports FeedVersions into a database.

func (*UnimportCommand) AddFlags

func (cmd *UnimportCommand) AddFlags(fl *pflag.FlagSet)

func (*UnimportCommand) HelpArgs

func (cmd *UnimportCommand) HelpArgs() string

func (*UnimportCommand) HelpDesc

func (cmd *UnimportCommand) HelpDesc() (string, string)

func (*UnimportCommand) Parse

func (cmd *UnimportCommand) Parse(args []string) error

Parse command line flags

func (*UnimportCommand) Run

func (cmd *UnimportCommand) Run() error

Run this command

type ValidatorCommand

type ValidatorCommand struct {
	Options validator.Options

	OutputFile string
	DBURL      string
	FVID       int

	SaveValidationReport    bool
	ValidationReportStorage string
	// contains filtered or unexported fields
}

ValidatorCommand

func (*ValidatorCommand) AddFlags

func (cmd *ValidatorCommand) AddFlags(fl *pflag.FlagSet)

func (*ValidatorCommand) HelpArgs

func (cmd *ValidatorCommand) HelpArgs() string

func (*ValidatorCommand) HelpDesc

func (cmd *ValidatorCommand) HelpDesc() (string, string)

func (*ValidatorCommand) HelpExample

func (cmd *ValidatorCommand) HelpExample() string

func (*ValidatorCommand) Parse

func (cmd *ValidatorCommand) Parse(args []string) error

func (*ValidatorCommand) Run

func (cmd *ValidatorCommand) Run() error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL