client

README

InfluxDB Go Client Library

Please refer to http://godoc.org/github.com/influxdb/influxdb/client for documentation.

Currently Used:

You can see a use of the client libray in the InfluxDB CLI.

Documentation

Index

• func EpochToTime(epoch int64, precision string) (time.Time, error)
• func SetPrecision(t time.Time, precision string) time.Time
• type BatchPoints
  • func (bp *BatchPoints) UnmarshalJSON(b []byte) error
• type Client
  • func NewClient(c Config) (*Client, error)
  • func (c *Client) Addr() string
  • func (c *Client) Dump(db string) (io.ReadCloser, error)
  • func (c *Client) Ping() (time.Duration, string, error)
  • func (c *Client) Query(q Query) (*Results, error)
  • func (c *Client) Write(bp BatchPoints) (*Results, error)
• type Config
• type Point
  • func (p *Point) MarshalJSON() ([]byte, error)
  • func (p *Point) UnmarshalJSON(b []byte) error
• type Query
• type Result
  • func (r *Result) MarshalJSON() ([]byte, error)
  • func (r *Result) UnmarshalJSON(b []byte) error
• type Results
  • func (r Results) Error() error
  • func (r *Results) MarshalJSON() ([]byte, error)
  • func (r *Results) UnmarshalJSON(b []byte) error

Functions

func EpochToTime

func EpochToTime(epoch int64, precision string) (time.Time, error)

EpochToTime takes a unix epoch time and uses precision to return back a time.Time

func SetPrecision

func SetPrecision(t time.Time, precision string) time.Time

SetPrecision will round a time to the specified precision

Types

type BatchPoints

type BatchPoints struct {
	Points          []Point           `json:"points,omitempty"`
	Database        string            `json:"database,omitempty"`
	RetentionPolicy string            `json:"retentionPolicy,omitempty"`
	Tags            map[string]string `json:"tags,omitempty"`
	Timestamp       time.Time         `json:"timestamp,omitempty"`
	Precision       string            `json:"precision,omitempty"`
}

BatchPoints is used to send batched data in a single write. Database and Points are required If no retention policy is specified, it will use the databases default retention policy. If tags are specified, they will be "merged" with all points. If a point already has that tag, it is ignored. If timestamp is specified, it will be applied to any point with an empty timestamp. Precision can be specified if the timestamp is in epoch format (integer). Valid values for Precision are n, u, ms, s, m, and h

func (*BatchPoints) UnmarshalJSON

func (bp *BatchPoints) UnmarshalJSON(b []byte) error

UnmarshalJSON decodes the data into the BatchPoints struct

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is used to make calls to the server.

func NewClient

func NewClient(c Config) (*Client, error)

NewClient will instantiate and return a connected client to issue commands to the server.

func (*Client) Addr

func (c *Client) Addr() string

Addr provides the current url as a string of the server the client is connected to.

func (*Client) Dump

func (c *Client) Dump(db string) (io.ReadCloser, error)

Dump connects to server and retrieves all data stored for specified database. If successful, Dump returns the entire response body, which is an io.ReadCloser

func (*Client) Ping

func (c *Client) Ping() (time.Duration, string, error)

Ping will check to see if the server is up Ping returns how long the requeset took, the version of the server it connected to, and an error if one occured.

func (*Client) Query

func (c *Client) Query(q Query) (*Results, error)

Query sends a command to the server and returns the Results

func (*Client) Write

func (c *Client) Write(bp BatchPoints) (*Results, error)

Write takes BatchPoints and allows for writing of multiple points with defaults If successful, error is nil and Results is nil If an error occurs, Results may contain additional information if populated.

type Config

type Config struct {
	URL       url.URL
	Username  string
	Password  string
	UserAgent string
}

Config is used to specify what server to connect to. URL: The URL of the server connecting to. Username/Password are optional. They will be passed via basic auth if provided. UserAgent: If not provided, will default "InfluxDBClient",

type Point

type Point struct {
	Name      string
	Tags      map[string]string
	Timestamp time.Time
	Fields    map[string]interface{}
	Precision string
}

Point defines the fields that will be written to the database Name, Timestamp, and Fields are required Precision can be specified if the timestamp is in epoch format (integer). Valid values for Precision are n, u, ms, s, m, and h

func (*Point) MarshalJSON

func (p *Point) MarshalJSON() ([]byte, error)

MarshalJSON will format the time in RFC3339Nano Precision is also ignored as it is only used for writing, not reading Or another way to say it is we always send back in nanosecond precision

func (*Point) UnmarshalJSON

func (p *Point) UnmarshalJSON(b []byte) error

UnmarshalJSON decodes the data into the Point struct

type Query

type Query struct {
	Command  string
	Database string
}

Query is used to send a command to the server. Both Command and Database are required.

type Result

type Result struct {
	Series []influxql.Row
	Err    error
}

Result represents a resultset returned from a single statement.

func (*Result) MarshalJSON

func (r *Result) MarshalJSON() ([]byte, error)

MarshalJSON encodes the result into JSON.

func (*Result) UnmarshalJSON

func (r *Result) UnmarshalJSON(b []byte) error

UnmarshalJSON decodes the data into the Result struct

type Results

type Results struct {
	Results []Result
	Err     error
}

Results represents a list of statement results.

func (Results) Error

func (r Results) Error() error

Error returns the first error from any statement. Returns nil if no errors occurred on any statements.

func (*Results) MarshalJSON

func (r *Results) MarshalJSON() ([]byte, error)

MarshalJSON encodes the result into JSON.

func (*Results) UnmarshalJSON

func (r *Results) UnmarshalJSON(b []byte) error

UnmarshalJSON decodes the data into the Results struct