metricsview

type AST struct {
	// Root of the AST
	Root *SelectNode
	// List of CTEs to add to the query
	CTEs []*SelectNode

	// Contextual info for building the AST
	MetricsView *runtimev1.MetricsViewSpec
	Security    MetricsViewSecurity
	Query       *Query
	Dialect     drivers.Dialect
	// contains filtered or unexported fields
}

type AnnotationsQuery struct {
	MetricsView string     `json:"metrics_view" mapstructure:"metrics_view"`
	Measures    []string   `json:"measures" mapstructure:"measures"`
	TimeRange   *TimeRange `json:"time_range" mapstructure:"time_range"`
	Limit       *int64     `json:"limit" mapstructure:"limit"`
	Offset      *int64     `json:"offset" mapstructure:"offset"`
	TimeZone    string     `json:"time_zone" mapstructure:"time_zone"`
	TimeGrain   TimeGrain  `json:"time_grain" mapstructure:"time_grain"`
	Priority    int        `json:"priority" mapstructure:"priority"`
}

type Condition struct {
	Operator    Operator      `json:"op" mapstructure:"op"`
	Expressions []*Expression `json:"exprs" mapstructure:"exprs"`
}

type Dimension struct {
	Name    string            `json:"name" mapstructure:"name"`
	Compute *DimensionCompute `json:"compute" mapstructure:"compute"`
}

type DimensionCompute struct {
	TimeFloor *DimensionComputeTimeFloor `json:"time_floor" mapstructure:"time_floor"`
}

type DimensionComputeTimeFloor struct {
	Dimension string    `json:"dimension" mapstructure:"dimension"`
	Grain     TimeGrain `json:"grain" mapstructure:"grain"`
}

type ExprNode struct {
	Expr string
	Args []any
}

type Expression struct {
	Name      string     `json:"name" mapstructure:"name"`
	Value     any        `json:"val" mapstructure:"val"`
	Condition *Condition `json:"cond" mapstructure:"cond"`
	Subquery  *Subquery  `json:"subquery" mapstructure:"subquery"`
}

type FieldNode struct {
	Name        string
	DisplayName string
	Expr        string
	Unnest      bool
	TreatNullAs string // only used for measures
}

type JoinType string

type Measure struct {
	Name    string          `json:"name" mapstructure:"name"`
	Compute *MeasureCompute `json:"compute" mapstructure:"compute"`
}

type MeasureCompute struct {
	Count           bool                           `json:"count" mapstructure:"count"`
	CountDistinct   *MeasureComputeCountDistinct   `json:"count_distinct" mapstructure:"count_distinct"`
	ComparisonValue *MeasureComputeComparisonValue `json:"comparison_value" mapstructure:"comparison_value"`
	ComparisonDelta *MeasureComputeComparisonDelta `json:"comparison_delta" mapstructure:"comparison_delta"`
	ComparisonRatio *MeasureComputeComparisonRatio `json:"comparison_ratio" mapstructure:"comparison_ratio"`
	PercentOfTotal  *MeasureComputePercentOfTotal  `json:"percent_of_total" mapstructure:"percent_of_total"`
	URI             *MeasureComputeURI             `json:"uri" mapstructure:"uri"`
	ComparisonTime  *MeasureComputeComparisonTime  `json:"comparison_time" mapstructure:"comparison_time"`
}

type MeasureComputeComparisonDelta struct {
	Measure string `json:"measure" mapstructure:"measure"`
}

type MeasureComputeComparisonRatio struct {
	Measure string `json:"measure" mapstructure:"measure"`
}

type MeasureComputeComparisonTime struct {
	Dimension string `json:"dimension" mapstructure:"dimension"`
}

type MeasureComputeComparisonValue struct {
	Measure string `json:"measure" mapstructure:"measure"`
}

type MeasureComputeCountDistinct struct {
	Dimension string `json:"dimension" mapstructure:"dimension"`
}

type MeasureComputePercentOfTotal struct {
	Measure string   `json:"measure" mapstructure:"measure"`
	Total   *float64 `json:"total" mapstructure:"total"`
}

type MeasureComputeURI struct {
	Dimension string `json:"dimension" mapstructure:"dimension"`
}

type MetricsViewSecurity interface {
	CanAccessField(field string) bool
	RowFilter() string
	QueryFilter() *runtimev1.Expression
}

type Operator string

type OrderFieldNode struct {
	Name string
	Desc bool
}

type Query struct {
	MetricsView         string      `json:"metrics_view" mapstructure:"metrics_view"`
	Dimensions          []Dimension `json:"dimensions" mapstructure:"dimensions"`
	Measures            []Measure   `json:"measures" mapstructure:"measures"`
	PivotOn             []string    `json:"pivot_on" mapstructure:"pivot_on"`
	Spine               *Spine      `json:"spine" mapstructure:"spine"`
	Sort                []Sort      `json:"sort" mapstructure:"sort"`
	TimeRange           *TimeRange  `json:"time_range" mapstructure:"time_range"`
	ComparisonTimeRange *TimeRange  `json:"comparison_time_range" mapstructure:"comparison_time_range"`
	Where               *Expression `json:"where" mapstructure:"where"`
	Having              *Expression `json:"having" mapstructure:"having"`
	Limit               *int64      `json:"limit" mapstructure:"limit"`
	Offset              *int64      `json:"offset" mapstructure:"offset"`
	TimeZone            string      `json:"time_zone" mapstructure:"time_zone"`
	UseDisplayNames     bool        `json:"use_display_names" mapstructure:"use_display_names"`
	Rows                bool        `json:"rows" mapstructure:"rows"`
}

type SearchQuery struct {
	MetricsView string      `mapstructure:"metrics_view"`
	Dimensions  []string    `mapstructure:"dimensions"`
	Search      string      `mapstructure:"search"`
	Where       *Expression `mapstructure:"where"`
	Having      *Expression `mapstructure:"having"`
	TimeRange   *TimeRange  `mapstructure:"time_range"`
	Limit       *int64      `mapstructure:"limit"`
}

type SearchResult struct {
	Dimension string
	Value     any
}

type SelectNode struct {
	RawSelect            *ExprNode        // Raw SQL SELECT statement to use
	Alias                string           // Alias for the node used by outer SELECTs to reference it.
	IsCTE                bool             // Whether this node is a Common Table Expression
	DimFields            []FieldNode      // Dimensions fields to select
	MeasureFields        []FieldNode      // Measure fields to select
	FromTable            *string          // Underlying table expression to select from (if set, FromSelect must not be set)
	FromSelect           *SelectNode      // Sub-select to select from (if set, FromTable must not be set)
	SpineSelect          *SelectNode      // Sub-select that returns a spine of dimensions. Currently it will be right-joined onto FromSelect.
	LeftJoinSelects      []*SelectNode    // Sub-selects to left join onto FromSelect, to enable "per-dimension" measures
	CrossJoinSelects     []*SelectNode    // sub-selects to cross join onto FromSelect
	JoinComparisonSelect *SelectNode      // Sub-select to join onto FromSelect for comparison measures
	JoinComparisonType   JoinType         // Type of join to use for JoinComparisonSelect
	Unnests              []string         // Unnest expressions to add in the FROM clause
	Group                bool             // Whether the SELECT is grouped. If yes, it will group by all DimFields.
	Where                *ExprNode        // Expression for the WHERE clause
	TimeWhere            *ExprNode        // Expression for the time range to add to the WHERE clause
	Having               *ExprNode        // Expression for the HAVING clause. If HAVING is not allowed in the current context, it will added as a WHERE in a wrapping SELECT.
	OrderBy              []OrderFieldNode // Fields to order by
	Limit                *int64           // Limit for the query
	Offset               *int64           // Offset for the query
}

type Sort struct {
	Name string `json:"name" mapstructure:"name"`
	Desc bool   `json:"desc" mapstructure:"desc"`
}

type Spine struct {
	Where     *WhereSpine `json:"where" mapstructure:"where"`
	TimeRange *TimeSpine  `json:"time" mapstructure:"time"`
}

type Subquery struct {
	Dimension Dimension   `json:"dimension" mapstructure:"dimension"`
	Measures  []Measure   `json:"measures" mapstructure:"measures"`
	Where     *Expression `json:"where" mapstructure:"where"`
	Having    *Expression `json:"having" mapstructure:"having"`
}

type TimeGrain string

type TimeRange struct {
	Start         time.Time `json:"start" mapstructure:"start"`
	End           time.Time `json:"end" mapstructure:"end"`
	Expression    string    `json:"expression" mapstructure:"expression"`
	IsoDuration   string    `json:"iso_duration" mapstructure:"iso_duration"`
	IsoOffset     string    `json:"iso_offset" mapstructure:"iso_offset"`
	RoundToGrain  TimeGrain `json:"round_to_grain" mapstructure:"round_to_grain"`
	TimeDimension string    `json:"time_dimension" mapstructure:"time_dimension"` // optional time dimension to use for time-based operations, if not specified, the default time dimension in the metrics view is used
}

type TimeSpine struct {
	Start         time.Time `json:"start" mapstructure:"start"`
	End           time.Time `json:"end" mapstructure:"end"`
	Grain         TimeGrain `json:"grain" mapstructure:"grain"`
	TimeDimension string    `json:"time_dimension" mapstructure:"time_dimension"` // optional time dimension to use for time-based operations, if not specified, the default time dimension in the metrics view is used
}

type TimestampsResult struct {
	Min       time.Time
	Max       time.Time
	Watermark time.Time
	Now       time.Time
}

type WhereSpine struct {
	Expression *Expression `json:"expr" mapstructure:"expr"`
}