table

Documentation

Index

• func Copy(t flux.Table) (flux.BufferedTable, error)
• func Diff(want, got flux.TableIterator, opts ...DiffOption) string
• func Sort(tables flux.TableIterator) (flux.TableIterator, error)
• func Stringify(table flux.Table) string
• type DiffOption
  • func DiffContext(n int) DiffOption
• type Iterator
  • func (t Iterator) Do(f func(flux.Table) error) error
• type ProfilerResult
  • func NewProfilerResult(tables ...flux.Table) ProfilerResult
  • func (r *ProfilerResult) Name() string
  • func (r *ProfilerResult) Tables() flux.TableIterator

Functions

func Copy

func Copy(t flux.Table) (flux.BufferedTable, error)

Copy returns a buffered copy of the table and consumes the input table. If the input table is already buffered, it "consumes" the input and returns the same table.

The buffered table can then be copied additional times using the BufferedTable.Copy method.

This method should be used sparingly if at all. It will retain each of the buffers of data coming out of a table so the entire table is materialized in memory. For large datasets, this could potentially cause a problem. The allocator is meant to catch when this happens and prevent it.

func Diff

func Diff(want, got flux.TableIterator, opts ...DiffOption) string

Diff will perform a diff between two table iterators. This will sort the tables within the table iterators and produce a diff of the full output.

func Sort

func Sort(tables flux.TableIterator) (flux.TableIterator, error)

Sort will read a TableIterator and produce another TableIterator where the keys are sorted.

This method will buffer all of the data since it needs to ensure all of the tables are read to avoid any deadlocks. Be careful using this method in performance sensitive areas.

func Stringify

func Stringify(table flux.Table) string

Stringify will read a table and turn it into a human-readable string.

Types

type DiffOption

type DiffOption interface {
	// contains filtered or unexported methods
}

func DiffContext

func DiffContext(n int) DiffOption

type Iterator

type Iterator []flux.Table

func (Iterator) Do

func (t Iterator) Do(f func(flux.Table) error) error

type ProfilerResult

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

func NewProfilerResult

func NewProfilerResult(tables ...flux.Table) ProfilerResult

func (*ProfilerResult) Name

func (r *ProfilerResult) Name() string

func (*ProfilerResult) Tables

func (r *ProfilerResult) Tables() flux.TableIterator