query

type Args struct {
	// required
	// Query: the query type
	Query string `` /* 129-byte string literal not displayed */
	// Ifaces: the interfaces to query
	Ifaces string `` /* 169-byte string literal not displayed */

	// QueryHosts: the hosts for which data is queried
	QueryHosts string `` /* 160-byte string literal not displayed */
	// QueryHostsResolverType specifies the resolver type which should be used to resolve hosts (default: string, comma-separated hosts list)
	QueryHostsResolverType string `` /* 180-byte string literal not displayed */

	// Hostname: the hostname from which data is queried
	Hostname string `` /* 143-byte string literal not displayed */
	// HostID: the host id from which data is queried
	HostID uint `` /* 140-byte string literal not displayed */

	// data filtering
	// Condition: the condition to filter data by
	Condition string `` /* 152-byte string literal not displayed */

	// counter addition
	// In: only show incoming packets/bytes
	In bool `json:"in,omitempty" yaml:"in,omitempty" query:"in" required:"false" doc:"Only show incoming packets/bytes" example:"false"`
	// Out: only show outgoing packets/bytes
	Out bool `` /* 126-byte string literal not displayed */
	// Sum: show sum of incoming/outgoing packets/bytes
	Sum bool `` /* 136-byte string literal not displayed */

	// time selection
	// First: the first timestamp to query
	First string `` /* 147-byte string literal not displayed */
	// Last: the last timestamp to query
	Last string `json:"last,omitempty" yaml:"last,omitempty" query:"last" required:"false" doc:"The last timestamp to query" example:"-24h"`

	// formatting
	// Format: the output format
	Format string `` /* 134-byte string literal not displayed */
	// SortBy: column to sort by
	SortBy string `` /* 160-byte string literal not displayed */
	// NumResults: number of results to return/print
	NumResults uint64 `` /* 174-byte string literal not displayed */
	// SortAscending: sort ascending instead of the default descending
	SortAscending bool `` /* 162-byte string literal not displayed */

	// do-and-exit arguments
	// List: only list interfaces and return
	List bool `json:"list,omitempty" yaml:"list,omitempty" query:"list" required:"false" hidden:"true"`
	// Version: only print version and return
	Version bool `json:"version,omitempty" yaml:"version,omitempty" query:"version" required:"false" hidden:"true"`

	// resolution
	// Note: Nested structures are not supported for form data, see individual parameters in definition of DNSResolution
	// DNSResolution: guide reverse DNS resolution of sip,dip results
	DNSResolution DNSResolution `json:"dns_resolution,omitempty" yaml:"dns_resolution,omitempty" doc:"Configures DNS resolution of sip,dip results"`

	// file system
	// MaxMemPct: maximum percentage of available host memory to use for query processing
	MaxMemPct int `` /* 224-byte string literal not displayed */
	// LowMem: use less memory for query processing
	LowMem bool `` /* 141-byte string literal not displayed */
	// KeepAlive: keepalive message interval for query processor
	KeepAlive time.Duration `` /* 175-byte string literal not displayed */

	// Caller stores who produced these args (caller)
	Caller string `` /* 144-byte string literal not displayed */

	// Live can be used to request live flow data (in addition to DB results)
	Live bool `` /* 166-byte string literal not displayed */
	// contains filtered or unexported fields
}

type DNSResolution struct {

	// Enabled: enable reverse DNS lookups. Example: false
	Enabled bool `json:"enabled" yaml:"enabled" query:"dns_enabled" doc:"Enable reverse DNS lookups" example:"false"`
	// Timeout: timeout for reverse DNS lookups
	Timeout time.Duration `` /* 178-byte string literal not displayed */
	// MaxRows: maximum number of rows to resolve
	MaxRows int `` /* 154-byte string literal not displayed */
	// contains filtered or unexported fields
}

type DetailError struct {
	huma.ErrorModel
}

type Option func(*Args)

type Runner interface {

	// Run takes a query statement, executes the underlying query and returns the result(s)
	Run(ctx context.Context, args *Args) (*results.Result, error)
}

type Statement struct {
	// Ifaces holds the list of all interfaces that should be queried
	Ifaces []string `json:"ifaces"`

	LabelSelector types.LabelSelector `json:"label_selector,omitempty"`

	// needed for feedback to user
	QueryType string `json:"query_type"`

	Condition string `json:"condition,omitempty"`

	// which direction is added
	Direction types.Direction `json:"direction"`

	// time selection
	First int64 `json:"from"`
	Last  int64 `json:"to"`

	// formatting
	Format        string            `json:"format"`
	NumResults    uint64            `json:"limit"`
	SortBy        results.SortOrder `json:"sort_by"`
	SortAscending bool              `json:"sort_ascending,omitempty"`
	Output        io.Writer         `json:"-"`

	// parameters for external calls
	Caller string `json:"caller,omitempty"` // who called the query

	// resolution parameters (probably part of table printer)
	DNSResolution DNSResolution `json:"dns_resolution,omitempty"`

	// file system
	MaxMemPct int  `json:"max_mem_pct,omitempty"`
	LowMem    bool `json:"low_mem,omitempty"`

	// query keepalive
	KeepAliveDuration time.Duration `json:"keepalive,omitempty"`

	// request live flow data (in addition to DB)
	Live bool `json:"live,omitempty"`
	// contains filtered or unexported fields
}

type TimeFormat struct {
	Name   string
	Format string
}