README
¶
influxdb-client
influxdb-client is a fork from the official InfluxDB Go client. The fork was created to fix a few problems with the original client that weren't accepted upstream -- namely adding support for CSV queries.
It's a Go client API for InfluxDB 1.x.
Usage
To import into your Go project, run the following command in your terminal:
go get bitbucket.org/kelvininc/influxdb-client
Then, in your import declaration section of your Go file, paste the following:
import "bitbucket.org/kelvininc/influxdb-client"
Example
The following example creates a new client to the InfluxDB host on localhost:8086 and runs a
query for the measurement cpu_load from the mydb database.
func ExampleClient_query() {
c, err := client.NewHTTPClient(client.HTTPConfig{
Addr: "http://localhost:8086",
})
if err != nil {
fmt.Println("Error creating InfluxDB Client: ", err.Error())
}
defer c.Close()
q := client.NewQuery("SELECT count(value) FROM cpu_load", "mydb", "")
if response, err := c.Query(q); err == nil && response.Error() == nil {
fmt.Println(response.Results)
}
}
Documentation
¶
Overview ¶
Package client is the current official Go client for InfluxDB.
Index ¶
Constants ¶
const ( // UDPPayloadSize is a reasonable default payload size for UDP packets that // could be travelling over the internet. UDPPayloadSize = 512 )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BatchPoints ¶
type BatchPoints interface {
// AddPoint adds the given point to the Batch of points.
AddPoint(p *Point)
// AddPoints adds the given points to the Batch of points.
AddPoints(ps []*Point)
// Points lists the points in the Batch.
Points() []*Point
// Precision returns the currently set precision of this Batch.
Precision() string
// SetPrecision sets the precision of this batch.
SetPrecision(s string) error
// Database returns the currently set database of this Batch.
Database() string
// SetDatabase sets the database of this Batch.
SetDatabase(s string)
// WriteConsistency returns the currently set write consistency of this Batch.
WriteConsistency() string
// SetWriteConsistency sets the write consistency of this Batch.
SetWriteConsistency(s string)
// RetentionPolicy returns the currently set retention policy of this Batch.
RetentionPolicy() string
// SetRetentionPolicy sets the retention policy of this Batch.
SetRetentionPolicy(s string)
}
BatchPoints is an interface into a batched grouping of points to write into InfluxDB together. BatchPoints is NOT thread-safe, you must create a separate batch for each goroutine.
func NewBatchPoints ¶
func NewBatchPoints(conf BatchPointsConfig) (BatchPoints, error)
NewBatchPoints returns a BatchPoints interface based on the given config.
type BatchPointsConfig ¶
type BatchPointsConfig struct {
// Precision is the write precision of the points, defaults to "ns".
Precision string
// Database is the database to write points to.
Database string
// RetentionPolicy is the retention policy of the points.
RetentionPolicy string
// Write consistency is the number of servers required to confirm write.
WriteConsistency string
}
BatchPointsConfig is the config data needed to create an instance of the BatchPoints struct.
type CSVResponse ¶
type CSVResponse struct {
// Body is the content of the response.
Body io.ReadCloser
// ContentLength is the length of the Body.
ContentLength int64
}
CSVResponse represents a list of statement results in CSV form.
type ChunkedResponse ¶
type ChunkedResponse struct {
// contains filtered or unexported fields
}
ChunkedResponse represents a response from the server that uses chunking to stream the output.
func NewChunkedResponse ¶
func NewChunkedResponse(r io.Reader) *ChunkedResponse
NewChunkedResponse reads a stream and produces responses from the stream.
func (*ChunkedResponse) NextResponse ¶
func (r *ChunkedResponse) NextResponse() (*Response, error)
NextResponse reads the next line of the stream and returns a response.
type Client ¶
type Client interface {
// Ping checks that status of cluster, and will always return 0 time and no
// error for UDP clients.
Ping(timeout time.Duration) (time.Duration, string, error)
// Write takes a BatchPoints object and writes all Points to InfluxDB.
Write(bp BatchPoints) error
// Query makes an InfluxDB Query on the database. This will fail if using
// the UDP client.
Query(q Query) (*Response, error)
// QueryAsChunk makes an InfluxDB Query on the database. This will fail if using
// the UDP client.
QueryAsChunk(q Query) (*ChunkedResponse, error)
// QueryAsCSV makes an InfluxDB Query on the database. This will fail if using
// the UDP client.
QueryAsCSV(q Query) (*CSVResponse, error)
// Close releases any resources a Client may be using.
Close() error
}
Client is a client interface for writing & querying the database.
func NewHTTPClient ¶
func NewHTTPClient(conf HTTPConfig) (Client, error)
NewHTTPClient returns a new Client from the provided config. Client is safe for concurrent use by multiple goroutines.
func NewUDPClient ¶
NewUDPClient returns a client interface for writing to an InfluxDB UDP service from the given config.
type HTTPConfig ¶
type HTTPConfig struct {
// Addr should be of the form "http://host:port"
// or "http://[ipv6-host%zone]:port".
Addr string
// Username is the influxdb username, optional.
Username string
// Password is the influxdb password, optional.
Password string
// UserAgent is the http User Agent, defaults to "InfluxDBClient".
UserAgent string
// Timeout for influxdb writes, defaults to no timeout.
Timeout time.Duration
// InsecureSkipVerify gets passed to the http client, if true, it will
// skip https certificate verification. Defaults to false.
InsecureSkipVerify bool
// TLSConfig allows the user to set their own TLS config for the HTTP
// Client. If set, this option overrides InsecureSkipVerify.
TLSConfig *tls.Config
// Proxy configures the Proxy function on the HTTP client.
Proxy func(req *http.Request) (*url.URL, error)
}
HTTPConfig is the config data needed to create an HTTP Client.
type Point ¶
type Point struct {
// contains filtered or unexported fields
}
Point represents a single data point.
func NewPoint ¶
func NewPoint( name string, tags map[string]string, fields map[string]interface{}, t ...time.Time, ) (*Point, error)
NewPoint returns a point with the given timestamp. If a timestamp is not given, then data is sent to the database without a timestamp, in which case the server will assign local time upon reception. NOTE: it is recommended to send data with a timestamp.
func NewPointFrom ¶
NewPointFrom returns a point from the provided models.Point.
func (*Point) PrecisionString ¶
PrecisionString returns a line-protocol string of the Point, with the timestamp formatted for the given precision.
type Query ¶
type Query struct {
Command string
Database string
RetentionPolicy string
Precision string
Chunked bool
ChunkSize int
Parameters map[string]interface{}
}
Query defines a query to send to the server.
func NewQuery ¶
NewQuery returns a query object. The database and precision arguments can be empty strings if they are not needed for the query.
func NewQueryWithParameters ¶
func NewQueryWithParameters(command, database, precision string, parameters map[string]interface{}) Query
NewQueryWithParameters returns a query object. The database and precision arguments can be empty strings if they are not needed for the query. parameters is a map of the parameter names used in the command to their values.
func NewQueryWithRP ¶
NewQueryWithRP returns a query object. The database, retention policy, and precision arguments can be empty strings if they are not needed for the query. Setting the retention policy only works on InfluxDB versions 1.6 or greater.
type Result ¶
type Result struct {
StatementId int `json:"statement_id"`
Series []models.Row
Messages []*Message
Err string `json:"error,omitempty"`
}
Result represents a resultset returned from a single statement.
type UDPConfig ¶
type UDPConfig struct {
// Addr should be of the form "host:port"
// or "[ipv6-host%zone]:port".
Addr string
// PayloadSize is the maximum size of a UDP client message, optional
// Tune this based on your network. Defaults to UDPPayloadSize.
PayloadSize int
}
UDPConfig is the config data needed to create a UDP Client.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package models implements basic objects used throughout the TICK stack.
|
Package models implements basic objects used throughout the TICK stack. |
|
pkg
|
|
|
escape
Package escape contains utilities for escaping parts of InfluxQL and InfluxDB line protocol.
|
Package escape contains utilities for escaping parts of InfluxQL and InfluxDB line protocol. |