api

Documentation

Index

• type ConfigDefinitions
• type Definition
• type GlobSpec
• type Source
• type Spec

Types

type ConfigDefinitions

type ConfigDefinitions struct {
	Globs map[string][]string `yaml:"Globs"`
}

type Definition

type Definition struct {
	Name                string      `yaml:"Name"`
	Author              string      `yaml:"Author"`
	Description         string      `yaml:"Description"`
	Email               string      `yaml:"Email"`
	Reference           string      `yaml:"Reference"`
	Categories          []string    `yaml:"Categories"`
	SQLiteIdentifyQuery string      `yaml:"SQLiteIdentifyQuery"`
	SQLiteIdentifyValue interface{} `yaml:"SQLiteIdentifyValue"`
	Globs               []string    `yaml:"Globs"`
	FilenameRegex       string      `yaml:"FilenameRegex"`
	Sources             []Source    `yaml:"Sources"`
}

type GlobSpec

type GlobSpec struct {
	Glob     string   `json:"glob"`
	Tags     []string `json:"tags"`
	Filename string   `json:"name"`
}

type Source

type Source struct {
	Name string `yaml:"name"`
	// Specialized VQL to post process the rows. Default is a
	// passthrough `SELECT * FROM Rows`
	VQL                 string      `yaml:"VQL"`
	SQL                 string      `yaml:"SQL"`
	SQLiteIdentifyQuery string      `json:"id_query"`
	SQLiteIdentifyValue interface{} `json:"id_value"`
	Filename            string      `json:"filename"`
}

type Spec

type Spec struct {
	Globs []GlobSpec `json:"globs"`

	// map[string]Source
	Sources *ordereddict.Dict `json:"sources"`
}

This is the main data structure that will be used by the application.