model

Documentation

Overview

Package model defines Data Transfer Object (Entity, Value Object)

Package model defines Data Transfer Object (Entity, Value Object)

Package model defines Data Transfer Object (Entity, Value Object)

Index

• type CSV
  • func (c *CSV) IsHeaderEmpty() bool
  • func (c *CSV) SetHeader(header Header)
  • func (c *CSV) SetRecord(record Record)
  • func (c *CSV) ToTable() *Table
• type Excel
  • func (e *Excel) ToTable() *Table
• type Header
• type Histories
  • func (h Histories) ToStringList() []string
  • func (h Histories) ToTable() *Table
• type History
• type JSON
  • func (j *JSON) ToTable() *Table
• type LTSV
  • func (l *LTSV) IsLabelEmpty() bool
  • func (l *LTSV) SetLabel(label Label)
  • func (l *LTSV) SetRecord(record Record)
  • func (l *LTSV) ToTable() *Table
• type Label
• type PrintMode
  • func (p PrintMode) String() string
• type Record
• type TSV
  • func (t *TSV) IsHeaderEmpty() bool
  • func (t *TSV) SetHeader(header Header)
  • func (t *TSV) SetRecord(record Record)
  • func (t *TSV) ToTable() *Table
• type Table
  • func (t *Table) IsEmptyHeader() bool
  • func (t *Table) IsEmptyName() bool
  • func (t *Table) IsEmptyRecords() bool
  • func (t *Table) IsSameHeaderColumnName() bool
  • func (t *Table) Print(out io.Writer, mode PrintMode)
  • func (t *Table) Valid() error

Types

type CSV

type CSV struct {
	Name    string
	Header  Header
	Records []Record
}

CSV is csv data with header.

func (*CSV) IsHeaderEmpty

func (c *CSV) IsHeaderEmpty() bool

IsHeaderEmpty return wherther header is empty or not

func (*CSV) SetHeader

func (c *CSV) SetHeader(header Header)

SetHeader set header column.

func (*CSV) SetRecord

func (c *CSV) SetRecord(record Record)

SetRecord set csv record.

func (*CSV) ToTable

func (c *CSV) ToTable() *Table

ToTable convert CSV to Table.

type Excel

type Excel struct {
	// Name is sheet name.
	Name string
	// Header is excel header.
	Header Header
	// Records is excel record.
	Records []Record
}

Excel is XLAM / XLSM / XLSX / XLTM / XLTX data with header.

func (*Excel) ToTable

func (e *Excel) ToTable() *Table

ToTable convert Excel to Table.

type Header

type Header []string

Header is CSV/TSV/Table header.

type Histories

type Histories []*History

Histories is sqly history all record.

func (Histories) ToStringList

func (h Histories) ToStringList() []string

ToStringList convert history to string list.

func (Histories) ToTable

func (h Histories) ToTable() *Table

ToTable convert History to Table.

type History

type History struct {
	// ID is history id. 1 is oldest
	ID int
	// Request is sqly history record that is user input from sqly prompt
	Request string
}

History is sqly history record.

type JSON

type JSON struct {
	// Name is json file name
	Name string
	// JSON is key and value
	JSON []map[string]interface{}
}

JSON is json data with indefinite keys

func (*JSON) ToTable

func (j *JSON) ToTable() *Table

ToTable convert JSON to Table.

type LTSV

type LTSV struct {
	Name    string
	Label   Label
	Records []Record
}

LTSV is Labeled Tab-separated Values data with label.

func (*LTSV) IsLabelEmpty

func (l *LTSV) IsLabelEmpty() bool

IsLabelEmpty return wherther label is empty or not

func (*LTSV) SetLabel

func (l *LTSV) SetLabel(label Label)

SetLabel set label column.

func (*LTSV) SetRecord

func (l *LTSV) SetRecord(record Record)

SetRecord set tsv record.

func (*LTSV) ToTable

func (l *LTSV) ToTable() *Table

ToTable convert TSV to Table.

type Label

type Label []string

Label is LTSV label.

type PrintMode

type PrintMode uint

PrintMode is enum to specify output method

const (
	// PrintModeTable print data in table format
	PrintModeTable PrintMode = iota
	// PrintModeMarkdownTable print data in markdown table format
	PrintModeMarkdownTable
	// PrintModeCSV print data in csv format
	PrintModeCSV
	// PrintModeTSV print data in tsv format
	PrintModeTSV
	// PrintModeLTSV print data in ltsv format
	PrintModeLTSV
	// PrintModeJSON print data in json format
	PrintModeJSON
	// PrintModeExcel print data in excel format
	PrintModeExcel
)

func (PrintMode) String

func (p PrintMode) String() string

String return string of PrintMode.

type Record

type Record []string

Record is CSV/TSV/Table records.

type TSV

type TSV struct {
	Name    string
	Header  Header
	Records []Record
}

TSV is tsv data with header.

func (*TSV) IsHeaderEmpty

func (t *TSV) IsHeaderEmpty() bool

IsHeaderEmpty return wherther header is empty or not

func (*TSV) SetHeader

func (t *TSV) SetHeader(header Header)

SetHeader set header column.

func (*TSV) SetRecord

func (t *TSV) SetRecord(record Record)

SetRecord set tsv record.

func (*TSV) ToTable

func (t *TSV) ToTable() *Table

ToTable convert TSV to Table.

type Table

type Table struct {
	// Name is table name.
	Name string
	// Header is table header.
	Header Header
	// Records is table records.
	Records []Record
}

Table is DB table.

func (*Table) IsEmptyHeader

func (t *Table) IsEmptyHeader() bool

IsEmptyHeader return wherther table header is empty or not

func (*Table) IsEmptyName

func (t *Table) IsEmptyName() bool

IsEmptyName return wherther table name is empty or not

func (*Table) IsEmptyRecords

func (t *Table) IsEmptyRecords() bool

IsEmptyRecords return wherther table records is empty or not

func (*Table) IsSameHeaderColumnName

func (t *Table) IsSameHeaderColumnName() bool

IsSameHeaderColumnName return whether the table has a header column with the same name

func (*Table) Print

func (t *Table) Print(out io.Writer, mode PrintMode)

Print print all record with header

func (*Table) Valid

func (t *Table) Valid() error

Valid check the contents of a Table.