Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Controller ¶
type ProxyRequest ¶
type ProxyRequest struct {
// Compiler converts the query to a specification to run against the data.
Compiler flux.Compiler
// Dialect is the result encoder
Dialect flux.Dialect
}
ProxyRequest specifies a query request and the dialect for the results.
type QueryDialect ¶
type QueryDialect struct {
Header *bool `json:"header"`
Delimiter string `json:"delimiter"`
CommentPrefix string `json:"commentPrefix"`
DateTimeFormat string `json:"dateTimeFormat"`
Annotations []string `json:"annotations"`
}
QueryDialect is the formatting options for the query response.
type QueryRequest ¶
type QueryRequest struct {
Type string `json:"type"`
Query string `json:"query"`
// Flux fields
Extern json.RawMessage `json:"extern,omitempty"`
AST json.RawMessage `json:"ast,omitempty"`
Dialect QueryDialect `json:"dialect"`
Now time.Time `json:"now"`
// PreferNoContent specifies if the Response to this request should
// contain any result. This is done for avoiding unnecessary
// bandwidth consumption in certain cases. For example, when the
// query produces side effects and the results do not matter. E.g.:
// from(...) |> ... |> to()
// For example, tasks do not use the results of queries, but only
// care about their side effects.
// To obtain a QueryRequest with no result, add the header
// `Prefer: return-no-content` to the HTTP request.
PreferNoContent bool
// PreferNoContentWithError is the same as above, but it forces the
// Response to contain an error if that is a Flux runtime error encoded
// in the response body.
// To obtain a QueryRequest with no result but runtime errors,
// add the header `Prefer: return-no-content-with-error` to the HTTP request.
PreferNoContentWithError bool
}
QueryRequest is a flux query request.
func (QueryRequest) ProxyRequest ¶
func (r QueryRequest) ProxyRequest() *ProxyRequest
ProxyRequest returns a request to proxy from the flux.
func (QueryRequest) Validate ¶
func (r QueryRequest) Validate() error
Validate checks the query request and returns an error if the request is invalid.
func (QueryRequest) WithDefaults ¶
func (r QueryRequest) WithDefaults() QueryRequest
WithDefaults adds default values to the request.
Click to show internal directories.
Click to hide internal directories.