middlewares

package
v0.2.26 Latest Latest
Warning

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

 Go to latest Published: Mar 2, 2023 License: MIT Imports: 11 Imported by: 37

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FlattenMapIntoColumns 

func FlattenMapIntoColumns(rows types.MapRow) types.MapRow

func PreserveColumnOrder 

func PreserveColumnOrder(oldColumns []types.FieldName, newColumns map[types.FieldName]interface{}) []types.FieldName

Types

type ColumnMiddlewareConfig 

type ColumnMiddlewareConfig struct {
	FieldRenames map[types.FieldName]types.FieldName `yaml:"renames"`
	// FIXME regex renames actually need to ordered
	RegexpRenames RegexpReplacements `yaml:"regexpRenames"`
}

type FieldsFilterMiddleware 

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

FieldsFilterMiddleware keeps columns that are in the fields list and removes columns that are in the filters list.

empty lists means that all columns are accepted.

The returned rows are SimpleRows

func NewFieldsFilterMiddleware 

func NewFieldsFilterMiddleware(fields []string, filters []string) *FieldsFilterMiddleware

func (*FieldsFilterMiddleware) Process 

func (ffm *FieldsFilterMiddleware) Process(table *types.Table) (*types.Table, error)

type FlattenObjectMiddleware 

type FlattenObjectMiddleware struct {
}

func NewFlattenObjectMiddleware 

func NewFlattenObjectMiddleware() *FlattenObjectMiddleware

func (*FlattenObjectMiddleware) Process 

func (fom *FlattenObjectMiddleware) Process(table *types.Table) (*types.Table, error)

type ObjectGoTemplateMiddleware 

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

func NewObjectGoTemplateMiddleware 

func NewObjectGoTemplateMiddleware(
	templateStrings map[types.FieldName]string,
) (*ObjectGoTemplateMiddleware, error)

NewObjectGoTemplateMiddleware creates a new template firmware used to process individual objects.

It will render the template for each object and return a single field.

TODO(manuel, 2023-02-02) Add support for passing in custom funcmaps See #110 https://github.com/go-go-golems/glazed/issues/110

func (*ObjectGoTemplateMiddleware) Process 

func (rgtm *ObjectGoTemplateMiddleware) Process(object map[string]interface{}) (map[string]interface{}, error)

Process will render each template for the input object and return an object with the newly created fields.

TODO(manuel, 2022-11-21) This should allow merging the new results straight back

type ObjectMiddleware 

type ObjectMiddleware interface {
	// Process transforms each individual object
	//
	// TODO(manuel, 2022-11-20) Make the Process monadic, to return one or more new objects
	// this way we can build filtering interfaces
	//
	// Although maybe this should just be the interface for a single object,
	// which in our standard case would be all the rows at once.
	// A single object JSON manipulation would be just a single "row"
	//
	// Furthermore, we could maybe use the `Row` type here instead of a map,
	// although I am not sure how much we would impact efficiency, and maybe this is
	// all premature.
	Process(object map[string]interface{}) (map[string]interface{}, error)
}

type PreserveColumnOrderMiddleware 

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

func NewPreserveColumnOrderMiddleware 

func NewPreserveColumnOrderMiddleware(columns []types.FieldName) *PreserveColumnOrderMiddleware

func (*PreserveColumnOrderMiddleware) Process 

func (scm *PreserveColumnOrderMiddleware) Process(table *types.Table) (*types.Table, error)

type RegexReplacement 

type RegexReplacement struct {
	Regexp      *regexp.Regexp
	Replacement string
}

type RegexpReplacement 

type RegexpReplacement struct {
	Regexp      *regexp.Regexp
	Replacement string
}

type RegexpReplacements 

type RegexpReplacements []*RegexpReplacement

func (*RegexpReplacements) UnmarshalYAML 

func (rr *RegexpReplacements) UnmarshalYAML(value *yaml.Node) error

type RegexpSkip 

type RegexpSkip struct {
	Regexp *regexp.Regexp
}

type RenameColumnMiddleware 

type RenameColumnMiddleware struct {
	Renames map[types.FieldName]types.FieldName
	// orderedmap *regexp.Regexp -> string
	RegexpRenames RegexpReplacements
}

func NewFieldRenameColumnMiddleware 

func NewFieldRenameColumnMiddleware(renames map[types.FieldName]types.FieldName) *RenameColumnMiddleware

func NewRegexpRenameColumnMiddleware 

func NewRegexpRenameColumnMiddleware(renames RegexpReplacements) *RenameColumnMiddleware

func NewRenameColumnMiddleware 

func NewRenameColumnMiddleware(
	renames map[types.FieldName]types.FieldName,
	regexpRenames RegexpReplacements,
) *RenameColumnMiddleware

func NewRenameColumnMiddlewareFromYAML 

func NewRenameColumnMiddlewareFromYAML(decoder *yaml.Decoder) (*RenameColumnMiddleware, error)

func (*RenameColumnMiddleware) Process 

func (r *RenameColumnMiddleware) Process(table *types.Table) (*types.Table, error)

func (*RenameColumnMiddleware) RenameColumns 

func (r *RenameColumnMiddleware) RenameColumns(
	columns []types.FieldName,
) ([]types.FieldName, map[types.FieldName]types.FieldName)

type ReorderColumnOrderMiddleware 

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

func NewReorderColumnOrderMiddleware 

func NewReorderColumnOrderMiddleware(columns []types.FieldName) *ReorderColumnOrderMiddleware

func (*ReorderColumnOrderMiddleware) Process 

func (scm *ReorderColumnOrderMiddleware) Process(table *types.Table) (*types.Table, error)

type ReplaceMiddleware 

type ReplaceMiddleware struct {
	Replacements      map[types.FieldName][]*Replacement
	RegexReplacements map[types.FieldName][]*RegexpReplacement
	RegexSkips        map[types.FieldName][]*RegexpSkip
	Skips             map[types.FieldName][]*Skip
}

func NewReplaceMiddleware 

func NewReplaceMiddleware(
	replacements map[types.FieldName][]*Replacement,
	regexReplacements map[types.FieldName][]*RegexpReplacement,
	regexSkips map[types.FieldName][]*RegexpSkip,
	skips map[types.FieldName][]*Skip,
) *ReplaceMiddleware

func NewReplaceMiddlewareFromYAML 

func NewReplaceMiddlewareFromYAML(b []byte) (*ReplaceMiddleware, error)

func (*ReplaceMiddleware) Process 

func (r *ReplaceMiddleware) Process(table *types.Table) (*types.Table, error)

type Replacement 

type Replacement struct {
	Pattern     string
	Replacement string
}

type RowGoTemplateMiddleware 

type RowGoTemplateMiddleware struct {

	// this field is used to replace "." in keys before passing them to the template,
	// in order to avoid having to use the `index` template function to access fields
	// that contain a ".", which is frequent due to flattening.
	RenameSeparator string
	// contains filtered or unexported fields
}

func NewRowGoTemplateMiddleware 

func NewRowGoTemplateMiddleware(
	templateStrings map[types.FieldName]string,
	renameSeparator string) (*RowGoTemplateMiddleware, error)

NewRowGoTemplateMiddleware creates a new RowGoTemplateMiddleware which is the simplest go template middleware.

It will render the template for each row and return the result as a new column called with the given title.

Because nested objects will be flattened to individual columns using the . separator, this will make fields inaccessible to the template. One way around this is to use {{ index . "field.subfield" }} in the template. Another is to pass a separator rename option.

TODO(manuel, 2023-02-02) Add support for passing in custom funcmaps See #110 https://github.com/go-go-golems/glazed/issues/110

func (*RowGoTemplateMiddleware) Process 

func (rgtm *RowGoTemplateMiddleware) Process(table *types.Table) (*types.Table, error)

type Skip 

type Skip struct {
	Pattern string
}

type SortColumnsMiddleware 

type SortColumnsMiddleware struct {
}

func NewSortColumnsMiddleware 

func NewSortColumnsMiddleware() *SortColumnsMiddleware

func (*SortColumnsMiddleware) Process 

func (scm *SortColumnsMiddleware) Process(table *types.Table) (*types.Table, error)

type TableMiddleware 

type TableMiddleware interface {
	// Process transforms a full table
	Process(table *types.Table) (*types.Table, error)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.