display

Documentation

Index

• func ClearCurrentLine()
• func ColumnNames(columns []*queryresult.ColumnDef) []string
• func ColumnValueAsString(val interface{}, col *queryresult.ColumnDef, opts ...ColumnValueOption) (result string, err error)
• func ColumnValuesAsString(values []interface{}, columns []*queryresult.ColumnDef, ...) ([]string, error)
• func DisplayErrorTiming(t time.Time)
• func ParseJSONOutputColumnValue(val interface{}, col *queryresult.ColumnDef) (interface{}, error)
• func PrintInstallReports(reports PluginInstallReports, isUpdateReport bool)
• func ShowOutput(ctx context.Context, result *queryresult.Result, opts ...DisplayOption) int
• func ShowPaged(ctx context.Context, content string)
• func ShowVarsListJson(vars []*modconfig.Variable)
• func ShowVarsListTable(vars []*modconfig.Variable)
• func ShowWrappedTable(headers []string, rows [][]string, opts *ShowWrappedTableOptions)
• type ColumnValueOption
  • func WithNullString(nullString string) ColumnValueOption
• type DisplayConfiguration
• type DisplayOption
  • func DisableTiming() DisplayOption
  • func EnableTiming() DisplayOption
  • func ShowTimingOnOutput(output string) DisplayOption
• type PluginInstallReport
  • func (i *PluginInstallReport) String() string
• type PluginInstallReports
  • func (i PluginInstallReports) Len() int
  • func (i PluginInstallReports) Less(lIdx, rIdx int) bool
  • func (i PluginInstallReports) Swap(lIdx, rIdx int)
• type PluginRemoveReport
• type PluginRemoveReports
  • func (r PluginRemoveReports) Print()
• type ShowWrappedTableOptions

Functions

func ClearCurrentLine

func ClearCurrentLine()

func ColumnNames

func ColumnNames(columns []*queryresult.ColumnDef) []string

ColumnNames :: extract names from columns

func ColumnValueAsString

func ColumnValueAsString(val interface{}, col *queryresult.ColumnDef, opts ...ColumnValueOption) (result string, err error)

ColumnValueAsString converts column value to string

func ColumnValuesAsString

func ColumnValuesAsString(values []interface{}, columns []*queryresult.ColumnDef, opts ...ColumnValueOption) ([]string, error)

ColumnValuesAsString converts a slice of columns into strings

func DisplayErrorTiming

func DisplayErrorTiming(t time.Time)

DisplayErrorTiming shows the time taken for the query to fail

func ParseJSONOutputColumnValue

func ParseJSONOutputColumnValue(val interface{}, col *queryresult.ColumnDef) (interface{}, error)

ParseJSONOutputColumnValue segregate data types, ignore string conversion for certain data types : JSON, JSONB, BOOL and so on..

func PrintInstallReports

func PrintInstallReports(reports PluginInstallReports, isUpdateReport bool)

PrintInstallReports Prints out the installation reports onto the console

func ShowOutput

func ShowOutput(ctx context.Context, result *queryresult.Result, opts ...DisplayOption) int

ShowOutput displays the output using the proper formatter as applicable

func ShowPaged

func ShowPaged(ctx context.Context, content string)

ShowPaged displays the `content` in a system dependent pager

func ShowVarsListJson

func ShowVarsListJson(vars []*modconfig.Variable)

func ShowVarsListTable

func ShowVarsListTable(vars []*modconfig.Variable)

func ShowWrappedTable

func ShowWrappedTable(headers []string, rows [][]string, opts *ShowWrappedTableOptions)

Types

type ColumnValueOption

type ColumnValueOption func(opt *columnValueSettings)

func WithNullString

func WithNullString(nullString string) ColumnValueOption

type DisplayConfiguration

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

type DisplayOption

type DisplayOption = func(config *DisplayConfiguration)

func DisableTiming

func DisableTiming() DisplayOption

DisableTiming disables display of timing data forcefully

func EnableTiming

func EnableTiming() DisplayOption

EnableTiming enables display of timing data forcefully

func ShowTimingOnOutput

func ShowTimingOnOutput(output string) DisplayOption

ShowTimingOnOutput only enables timing if the current output mode is the one provided and if --timing is set

type PluginInstallReport

type PluginInstallReport struct {
	Skipped        bool
	Plugin         string
	SkipReason     string
	DocURL         string
	Version        string
	IsUpdateReport bool
}

func (*PluginInstallReport) String

func (i *PluginInstallReport) String() string

type PluginInstallReports

type PluginInstallReports []*PluginInstallReport

func (PluginInstallReports) Len

func (i PluginInstallReports) Len() int

making the type compatible with sort.Interface so that we can use the sort package utilities

func (PluginInstallReports) Less

func (i PluginInstallReports) Less(lIdx, rIdx int) bool

func (PluginInstallReports) Swap

func (i PluginInstallReports) Swap(lIdx, rIdx int)

type PluginRemoveReport

type PluginRemoveReport struct {
	Image       *ociinstaller.SteampipeImageRef
	ShortName   string
	Connections []modconfig.Connection
}

type PluginRemoveReports

type PluginRemoveReports []PluginRemoveReport

func (PluginRemoveReports) Print

func (r PluginRemoveReports) Print()

type ShowWrappedTableOptions

type ShowWrappedTableOptions struct {
	AutoMerge        bool
	HideEmptyColumns bool
	Truncate         bool
}