irondb

Documentation

Overview

Package irondb provides proxy origin support for IRONdb databases.

Index

• func NewClient(name string, o *bo.Options, router http.Handler, cache cache.Cache, ...) (backends.Backend, error)
• type Client
  • func (c *Client) CAQLHandler(w http.ResponseWriter, r *http.Request)
  • func (c *Client) DefaultHealthCheckConfig() *ho.Options
  • func (c *Client) DefaultPathConfigs(o *bo.Options) map[string]*po.Options
  • func (c *Client) FastForwardRequest(r *http.Request) (*http.Request, error)
  • func (c *Client) FetchHandler(w http.ResponseWriter, r *http.Request)
  • func (c *Client) FindHandler(w http.ResponseWriter, r *http.Request)
  • func (c *Client) HistogramHandler(w http.ResponseWriter, r *http.Request)
  • func (c *Client) ParseTimeRangeQuery(r *http.Request) (*timeseries.TimeRangeQuery, *timeseries.RequestOptions, bool, error)
  • func (c *Client) ProxyHandler(w http.ResponseWriter, r *http.Request)
  • func (c *Client) RawHandler(w http.ResponseWriter, r *http.Request)
  • func (c *Client) RegisterHandlers(map[string]http.Handler)
  • func (c *Client) RollupHandler(w http.ResponseWriter, r *http.Request)
  • func (c *Client) SetExtent(r *http.Request, trq *timeseries.TimeRangeQuery, extent *timeseries.Extent)
  • func (c *Client) StateHandler(w http.ResponseWriter, r *http.Request)
  • func (c *Client) TextHandler(w http.ResponseWriter, r *http.Request)

Functions

func NewClient

func NewClient(name string, o *bo.Options, router http.Handler,
	cache cache.Cache, _ backends.Backends,
	_ types.Lookup) (backends.Backend, error)

NewClient returns a new Client Instance

Types

type Client

type Client struct {
	backends.TimeseriesBackend
	// contains filtered or unexported fields
}

Client values provide access to IRONdb and implement the Trickster proxy client interface.

func (*Client) CAQLHandler

func (c *Client) CAQLHandler(w http.ResponseWriter, r *http.Request)

CAQLHandler handles CAQL requests for timeseries data and processes them through the delta proxy cache.

func (*Client) DefaultHealthCheckConfig

func (c *Client) DefaultHealthCheckConfig() *ho.Options

DefaultHealthCheckConfig returns the default HealthCheck Config for this backend provider

func (*Client) DefaultPathConfigs

func (c *Client) DefaultPathConfigs(o *bo.Options) map[string]*po.Options

DefaultPathConfigs returns the default PathConfigs for the given Provider

func (*Client) FastForwardRequest

func (c *Client) FastForwardRequest(r *http.Request) (*http.Request, error)

FastForwardRequest returns an *http.Request crafted to collect Fast Forward data from the Origin, based on the provided HTTP Request

func (*Client) FetchHandler

func (c *Client) FetchHandler(w http.ResponseWriter, r *http.Request)

FetchHandler handles requests for numeric timeseries data with specified spans and processes them through the delta proxy cache.

func (*Client) FindHandler

func (c *Client) FindHandler(w http.ResponseWriter, r *http.Request)

FindHandler handles requests to find metirc information and processes them through the object proxy cache.

func (*Client) HistogramHandler

func (c *Client) HistogramHandler(w http.ResponseWriter, r *http.Request)

HistogramHandler handles requests for historgam timeseries data and processes them through the delta proxy cache.

func (*Client) ParseTimeRangeQuery

func (c *Client) ParseTimeRangeQuery(
	r *http.Request) (*timeseries.TimeRangeQuery, *timeseries.RequestOptions,
	bool, error)

ParseTimeRangeQuery parses the key parts of a TimeRangeQuery from the inbound HTTP Request.

func (*Client) ProxyHandler

func (c *Client) ProxyHandler(w http.ResponseWriter, r *http.Request)

ProxyHandler sends a request through the basic reverse proxy to the origin for non-cacheable API calls.

func (*Client) RawHandler

func (c *Client) RawHandler(w http.ResponseWriter, r *http.Request)

RawHandler handles requests for raw numeric timeseries data and processes them through the delta proxy cache.

func (*Client) RegisterHandlers

func (c *Client) RegisterHandlers(map[string]http.Handler)

func (*Client) RollupHandler

func (c *Client) RollupHandler(w http.ResponseWriter, r *http.Request)

RollupHandler handles requests for numeric timeseries data with specified spans and processes them through the delta proxy cache.

func (*Client) SetExtent

func (c *Client) SetExtent(r *http.Request, trq *timeseries.TimeRangeQuery, extent *timeseries.Extent)

SetExtent will change the upstream request query to use the provided Extent.

func (*Client) StateHandler

func (c *Client) StateHandler(w http.ResponseWriter, r *http.Request)

StateHandler handles requests for state data and processes them through the basic reverse proxy to the origin for non-cacheable API calls.

func (*Client) TextHandler

func (c *Client) TextHandler(w http.ResponseWriter, r *http.Request)

TextHandler handles requests for text timeseries data and processes them through the delta proxy cache.