generate

Documentation

Index

• Variables
• type CleanLevel
  • func (i *CleanLevel) Set(v string) error
  • func (i CleanLevel) String() string
  • func (i CleanLevel) Type() string
• type Generator
  • func (g *Generator) Run(ctx context.Context, path string, gen gen.SeriesGenerator) ([]string, error)
• type SchemaPlan
  • func (p *SchemaPlan) PrintPlan(w io.Writer)
  • func (p *SchemaPlan) String() string
• type SchemaSpec
  • func (s *SchemaSpec) AddFlags(cmd *cobra.Command, fs *pflag.FlagSet)
  • func (s *SchemaSpec) Plan(sp *StoragePlan) (*SchemaPlan, error)
• type StoragePlan
  • func (p *StoragePlan) PrintPlan(w io.Writer)
  • func (p *StoragePlan) String() string
  • func (p *StoragePlan) TimeSpan() time.Duration
• type StorageSpec
  • func (a *StorageSpec) AddFlags(cmd *cobra.Command, fs *pflag.FlagSet)
  • func (a *StorageSpec) Plan() (*StoragePlan, error)
• type TagCardinalities
  • func (t TagCardinalities) Cardinality() int
  • func (t *TagCardinalities) Set(tags string) error
  • func (t TagCardinalities) String() string
  • func (t *TagCardinalities) Type() string

Variables

var Command = &cobra.Command{
	Use:   "generate <schema.toml>",
	Short: "Generate time series data sets using TOML schema",
	Long: `
This command will generate time series data direct to disk using schema 
defined in a TOML file. Use the help-schema subcommand to produce a TOML 
file to STDOUT, which includes documentation describing the available options.



NOTES:

* The influxd server should not be running when using the generate tool
  as it modifies the index and TSM data.
* This tool is intended for development and testing purposes only and 
  SHOULD NOT be run on a production server.
`,
	Args: cobra.ExactArgs(1),
	RunE: generateFE,
}

Types

type CleanLevel

type CleanLevel int

const (
	// CleanLevelNone will not remove any data files.
	CleanLevelNone CleanLevel = iota

	// CleanLevelTSM will only remove TSM data files.
	CleanLevelTSM

	// CleanLevelAll will remove all TSM and index data files.
	CleanLevelAll
)

func (*CleanLevel) Set

func (i *CleanLevel) Set(v string) error

func (CleanLevel) String

func (i CleanLevel) String() string

func (CleanLevel) Type

func (i CleanLevel) Type() string

type Generator

type Generator struct {

	// Clean specifies whether to clean any of the data related files
	Clean CleanLevel
	// contains filtered or unexported fields
}

func (*Generator) Run

func (g *Generator) Run(ctx context.Context, path string, gen gen.SeriesGenerator) ([]string, error)

type SchemaPlan

type SchemaPlan struct {
	StoragePlan     *StoragePlan
	Tags            TagCardinalities
	PointsPerSeries int
}

func (*SchemaPlan) PrintPlan

func (p *SchemaPlan) PrintPlan(w io.Writer)

func (*SchemaPlan) String

func (p *SchemaPlan) String() string

type SchemaSpec

type SchemaSpec struct {
	Tags            TagCardinalities
	PointsPerSeries int
}

func (*SchemaSpec) AddFlags

func (s *SchemaSpec) AddFlags(cmd *cobra.Command, fs *pflag.FlagSet)

func (*SchemaSpec) Plan

func (s *SchemaSpec) Plan(sp *StoragePlan) (*SchemaPlan, error)

type StoragePlan

type StoragePlan struct {
	Organization string
	Bucket       string
	StartTime    time.Time
	EndTime      time.Time
	Clean        CleanLevel
	Path         string
}

func (*StoragePlan) PrintPlan

func (p *StoragePlan) PrintPlan(w io.Writer)

func (*StoragePlan) String

func (p *StoragePlan) String() string

func (*StoragePlan) TimeSpan

func (p *StoragePlan) TimeSpan() time.Duration

TimeSpan returns the total duration for which the data set.

type StorageSpec

type StorageSpec struct {
	Organization string
	Bucket       string
	StartTime    string
	EndTime      string
	Clean        CleanLevel
}

func (*StorageSpec) AddFlags

func (a *StorageSpec) AddFlags(cmd *cobra.Command, fs *pflag.FlagSet)

func (*StorageSpec) Plan

func (a *StorageSpec) Plan() (*StoragePlan, error)

type TagCardinalities

type TagCardinalities []int

func (TagCardinalities) Cardinality

func (t TagCardinalities) Cardinality() int

func (*TagCardinalities) Set

func (t *TagCardinalities) Set(tags string) error

func (TagCardinalities) String

func (t TagCardinalities) String() string

func (*TagCardinalities) Type

func (t *TagCardinalities) Type() string