timeplus

type Client struct {
	*http.Client
	// contains filtered or unexported fields
}

type ClientOptions struct {
	BaseURL string
}

type Column struct {
	Name                    string `json:"name" binding:"required" example:"name"`
	Type                    string `json:"type" binding:"required" example:"string"`
	Default                 string `json:"default,omitempty"`
	Codec                   string `json:"codec"`
	TTLExpression           string `json:"ttl_expression,omitempty"`
	SkippingIndexExpression string `json:"skipping_index_expression,omitempty"`
}

type Dashboard struct {
	ID          string  `json:"id"`
	Name        string  `json:"name"`
	Description string  `json:"description"`
	Panels      []Panel `json:"panels"`
}

type MaterializedView struct {
	View

	TargetStream   string
	RetentionBytes int
	RetentionMS    int
	TTLExpression  string
}

type Panel struct {
	ID          string `json:"id"`
	Title       string `json:"title"`
	Description string `json:"description"`

	// e.g. {"x":0,"y":0,"w":6,"h":2,"nextX":6,"nextY":2}
	Position map[string]any `json:"position"`

	// e.g. `chart`, `markdown`
	VizType string `json:"viz_type"`

	// For chart, the viz_content is the SQL
	// For markdown, the viz_content is the markdown itself
	VizContent string `json:"viz_content"`

	// The JSON configuration of the viz
	// For chart, it is `{ "chart_type": "line", ...  }`
	// For markdown, it is `{ "favour": "github", ...  }`
	VizConfig map[string]any `json:"viz_config"`
}

type Sink struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Query       string `json:"query"`

	// Additional configurations such as broker url and etc. should be passed through `properties`
	Type string `json:"type"`

	// Additional properties that required to write the data to the sink (e.g. broker url). Please refer to the sinks documentation
	Properties map[string]any `json:"properties"`
}

type Source struct {
	ID          string         `json:"id"`
	Name        string         `json:"name"`
	Description string         `json:"description,omitempty"`
	Stream      string         `json:"stream"`
	Type        string         `json:"type"`
	Properties  map[string]any `json:"properties"`
}

type Stream struct {
	// Stream name should only contain a maximum of 64 letters, numbers, or _, and start with a letter
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Columns     []Column `json:"columns"`
	// This column will be used as the event time if specified
	EventTimeColumn string `json:"event_time_column,omitempty"`
	// The timezone of the `EventTimeColumn`
	TimestampTimezone       string `json:"event_time_timezone"`
	Shards                  int    `json:"shards,omitempty"`
	ReplicationFactor       int    `json:"replication_factor,omitempty"`
	OrderByExpression       string `json:"order_by_expression,omitempty"`
	OrderByGranularity      string `json:"order_by_granularity,omitempty"`
	PartitionByGranularity  string `json:"partition_by_granularity,omitempty"`
	HistoricalTTLExpression string `json:"ttl_expression,omitempty"` // API request
	TTL                     string `json:"ttl"`                      // API response

	// Default to `append`.
	Mode string `json:"mode,omitempty"`

	// Expression of primary key, required in `changelog_kv` and `versioned_kv` mode
	PrimaryKey string `json:"primary_key,omitempty"`

	// The max size a stream can grow. Any non-positive value means unlimited size. Default to 10 GiB.
	RetentionBytes int `json:"logstore_retention_bytes,omitempty" example:"10737418240"`

	// The max time the data can be retained in the stream. Any non-positive value means unlimited time. Default to 7 days.
	RetentionMS int `json:"logstore_retention_ms,omitempty" example:"604800000"`
}

type StreamMode string

type UDF struct {
	Name        string  `json:"name"`
	Description string  `json:"description"`
	Type        UDFType `json:"type"`

	// The input argument of the UDF, the type should be Timeplus data types,  not javascript types.
	// Only int8/16/32/64, uint8/16/32/64 are supported.
	Arguments []UDFArgument `json:"arguments"`

	// The erturn type of the UDF
	//   * For UDA: if it returns a single value, the return type is the corresponding data type of Timeplus.
	//     It supports the same types of input arguments, except for datetime, it only supports DateTime64(3).
	ReturnType string `json:"return_type" example:"float64"`

	// Only valid when `type` is `remote`.
	URL string `json:"url,omitempty"`

	// Only valid when `type` is `remote`.
	// This field is used to set the authentication method for remote UDF. It can be either `auth_header` or `none`.
	// When `auth_header` is set, you can configure `auth_context` to specify the HTTP header that be sent the remote URL
	AuthMethod UDFAuthMethod `json:"auth_method,omitempty"`

	// Only valid when `type` is `remote` and `auth_method` is `auth_header`
	AuthContext *UDFAuthContext `json:"auth_context,omitempty"`

	// Only valid when type is 'javascript'. Whether it is an aggregation function.
	IsAggrFunction bool `json:"is_aggregation,omitempty"`

	Source string `json:"source,omitempty"`
}

type UDFArgument struct {
	Name string `json:"name" binding:"required" example:"val"`
	Type string `json:"type" binding:"required" example:"float64"`
}

type UDFAuthContext struct {
	Name  string `json:"key_name"`
	Value string `json:"key_value"`
}

type UDFAuthMethod string

type UDFType string

type View struct {
	Name        string
	Description string
	Query       string
}