format

package

Go to main page

Versions in this module

v0

v0.30.0

May 6, 2026

Changes in this version

+ func IsRawJSON(c Cell) bool

+ type JSONLFormatter struct

+ func NewJSONLFormatter(out io.Writer) *JSONLFormatter

+ func (f *JSONLFormatter) FinishFormat() error

+ func (f *JSONLFormatter) InitFormat(columnNames []string, config FormatConfig, previewRows []Row) error

+ func (f *JSONLFormatter) WriteRow(row Row) error

type Mode

+ const ModeJSONL

+ type RawJSONCell struct

+ func (c RawJSONCell) WithText(s string) Cell

type ValueFormatMode

+ const JSONValues

v0.29.0

Mar 22, 2026

Changes in this version

+ func CalculateWidthWithStrategy(ws enums.WidthStrategy, columnNames []string, verboseHeaders []string, ...) []int

+ func IsNoWrap(c Cell) bool

+ type ColumnHint struct

+ PreferredMinWidth int

type FormatConfig

+ TabVisualize bool

+ WidthStrategy enums.WidthStrategy

+ type GreedyFrequencyStrategy struct

+ func (GreedyFrequencyStrategy) CalculateWidths(wc *widthCalculator, availableWidth int, headers []string, rows []Row, ...) []int

+ type MarginalCostStrategy struct

+ func (MarginalCostStrategy) CalculateWidths(wc *widthCalculator, availableWidth int, headers []string, rows []Row, ...) []int

+ type NoWrapCell struct

+ func (c NoWrapCell) WithText(s string) Cell

+ type ProportionalStrategy struct

+ func (ProportionalStrategy) CalculateWidths(wc *widthCalculator, availableWidth int, headers []string, rows []Row, ...) []int

+ type WidthStrategy interface

+ CalculateWidths func(wc *widthCalculator, availableWidth int, headers []string, rows []Row, ...) []int

+ func NewWidthStrategy(ws enums.WidthStrategy) WidthStrategy

v0.28.0

Mar 9, 2026

Changes in this version

+ func Formatters(row Row) []any

+ func RegisterFormatFunc(factory FormatFuncFactory, modes ...Mode)

+ func RegisterStreamingFormatter(factory StreamingFormatterFactory, modes ...Mode)

+ func RegisterValueFormatMode(vfm ValueFormatMode, modes ...Mode)

+ func Texts(row Row) []string

+ type Cell interface

+ Format func() string

+ RawText func() string

+ WithText func(text string) Cell

type FormatConfig

+ Styled bool

+ type FormatFuncFactory func(mode Mode) (FormatFunc, error)

+ type Mode string

+ const ModeCSV

+ const ModeHTML

+ const ModeTab

+ const ModeTable

+ const ModeTableComment

+ const ModeTableDetailComment

+ const ModeUnspecified

+ const ModeVertical

+ const ModeXML

+ func (m Mode) IsTableMode() bool

+ type PlainCell struct

+ Text string

+ func (c PlainCell) Format() string

+ func (c PlainCell) RawText() string

+ func (c PlainCell) WithText(s string) Cell

type Row

+ func StringsToRow(ss ...string) Row

+ type StreamingFormatterFactory func(mode Mode, out io.Writer, config FormatConfig) (StreamingFormatter, error)

+ type StyledCell struct

+ Style string

+ Text string

+ func (c StyledCell) Format() string

+ func (c StyledCell) RawText() string

+ func (c StyledCell) WithText(s string) Cell

type TableStreamingFormatter

+ func NewTableFormatterForBuffered(out io.Writer, config FormatConfig, screenWidth int, mode Mode, ...) *TableStreamingFormatter

+ type ValueFormatMode int

+ const DisplayValues

+ const SQLLiteralValues

+ func ValueFormatModeFor(mode Mode) ValueFormatMode

v0.27.0

Mar 1, 2026

Changes in this version

+ func CalculateWidth(columnNames []string, verboseHeaders []string, wc *widthCalculator, ...) []int

+ func ExecuteWithFormatter(formatter StreamingFormatter, rows []Row, columnNames []string, ...) error

+ func ExtractTableNameFromQuery(sql string) (string, error)

+ func MaxByWithIdx[O cmp.Ordered, E any](fallback E, f func(E) O, seq iter.Seq[E]) (int, E)

+ func MaxWithIdx[E cmp.Ordered](fallback E, seq iter.Seq[E]) (int, E)

+ func ParseSimpleTablePath(input string) (*ast.Path, error)

+ func WriteTable(w io.Writer, rows []Row, columnNames []string, config FormatConfig, ...) error

+ func WriteTableWithParams(w io.Writer, rows []Row, columnNames []string, config FormatConfig, ...) error

+ type CSVFormatter struct

+ func NewCSVFormatter(out io.Writer, skipHeaders bool) *CSVFormatter

+ func (f *CSVFormatter) FinishFormat() error

+ func (f *CSVFormatter) InitFormat(columnNames []string, config FormatConfig, previewRows []Row) error

+ func (f *CSVFormatter) WriteRow(row Row) error

+ type FormatConfig struct

+ PreviewRows int64

+ SQLBatchSize int64

+ SQLTableName string

+ SkipColumnNames bool

+ TabWidth int

+ Verbose bool

+ type FormatFunc func(out io.Writer, rows []Row, columnNames []string, config FormatConfig, ...) error

+ func FormatSQL(mode enums.DisplayMode) FormatFunc

+ func NewFormatter(mode enums.DisplayMode) (FormatFunc, error)

+ type HTMLFormatter struct

+ func NewHTMLFormatter(out io.Writer, skipHeaders bool) *HTMLFormatter

+ func (f *HTMLFormatter) FinishFormat() error

+ func (f *HTMLFormatter) InitFormat(columnNames []string, config FormatConfig, previewRows []Row) error

+ func (f *HTMLFormatter) WriteRow(row Row) error

+ type Row = []string

+ type SQLFormatter struct

+ func NewSQLFormatter(out io.Writer, mode enums.DisplayMode, tableName string, batchSize int64) (*SQLFormatter, error)

+ func (f *SQLFormatter) Finish() error

+ func (f *SQLFormatter) WriteHeader(columnNames []string) error

+ func (f *SQLFormatter) WriteRow(values []string) error

+ type SQLStreamingFormatter struct

+ func NewSQLStreamingFormatter(out io.Writer, config FormatConfig, mode enums.DisplayMode) (*SQLStreamingFormatter, error)

+ func (s *SQLStreamingFormatter) FinishFormat() error

+ func (s *SQLStreamingFormatter) InitFormat(columnNames []string, config FormatConfig, previewRows []Row) error

+ func (s *SQLStreamingFormatter) WriteRow(row Row) error

+ type StreamingFormatter interface

+ FinishFormat func() error

+ InitFormat func(columnNames []string, config FormatConfig, previewRows []Row) error

+ WriteRow func(row Row) error

+ func NewStreamingFormatter(mode enums.DisplayMode, out io.Writer, config FormatConfig) (StreamingFormatter, error)

+ type TabFormatter struct

+ func NewTabFormatter(out io.Writer, skipHeaders bool) *TabFormatter

+ func (f *TabFormatter) FinishFormat() error

+ func (f *TabFormatter) InitFormat(columnNames []string, config FormatConfig, previewRows []Row) error

+ func (f *TabFormatter) WriteRow(row Row) error

+ type TableParams struct

+ ColumnAlign []tw.Align

+ VerboseHeaders []string

+ type TableStreamingFormatter struct

+ func NewTableStreamingFormatter(out io.Writer, config FormatConfig, screenWidth int, previewSize int) *TableStreamingFormatter

+ func (f *TableStreamingFormatter) FinishFormat() error

+ func (f *TableStreamingFormatter) InitFormat(columnNames []string, config FormatConfig, previewRows []Row) error

+ func (f *TableStreamingFormatter) WriteRow(row Row) error

+ type VerticalFormatter struct

+ func NewVerticalFormatter(out io.Writer) *VerticalFormatter

+ func (f *VerticalFormatter) FinishFormat() error

+ func (f *VerticalFormatter) InitFormat(columnNames []string, config FormatConfig, previewRows []Row) error

+ func (f *VerticalFormatter) WriteRow(row Row) error

+ type WidthCount struct

+ func (wc WidthCount) Count() int

+ func (wc WidthCount) Length() int

+ type XMLFormatter struct

+ func NewXMLFormatter(out io.Writer, skipHeaders bool) *XMLFormatter

+ func (f *XMLFormatter) FinishFormat() error

+ func (f *XMLFormatter) InitFormat(columnNames []string, config FormatConfig, previewRows []Row) error

+ func (f *XMLFormatter) WriteRow(row Row) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL