columns

package

v0.22.1 Latest Latest Go to latest Published: Sep 2, 2026 License: MIT Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/allthebacteria/atb-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package columns is the registry of columns available to atb query --columns.

Index ¶

func Names() []string
func Validate(names []string) error
type Column
- func All() []Column
- func Lookup(name string) (Column, bool)
type Source

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Names ¶

func Names() []string

Names returns every column name in the same order as All.

func Validate ¶

func Validate(names []string) error

Validate returns an error for the first name that is not a column. The error names the closest columns when any are close and always points at the command that lists them, so a typo stops the query instead of producing a blank column.

Types ¶

type Column ¶

type Column struct {
	Name        string
	Source      Source
	Description string
	// InIndex reports whether the SQLite index can answer the column. Columns
	// without it force the query onto the parquet files, which is slower.
	InIndex bool
}

Column is one column that --columns accepts.

func All ¶

func All() []Column

All returns every column, grouped by source in canonical order.

func Lookup ¶

func Lookup(name string) (Column, bool)

Lookup finds a column by its exact name.

type Source ¶

type Source string

Source is the table a column is read from.

const (
	Assembly      Source = "assembly"
	AssemblyStats Source = "assembly_stats"
	CheckM2       Source = "checkm2"
	Sylph         Source = "sylph"
	MLST          Source = "mlst"
	ENA           Source = "ena_20250506"
)

Source Files ¶

View all Source files

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