-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8 from slaminad/update-readme
Update readme and add example
- Loading branch information
Showing
1 changed file
with
28 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,29 @@ | ||
# influxdb1-clientv2 | ||
The old clientv2 for InfluxDB 1.x | ||
influxdb1-clientv2 is the current Go client API for InfluxDB 1.x. A Go client for the 2.0 API will be coming soon. | ||
|
||
InfluxDB is an open-source distributed time series database, find more about [InfluxDB](https://www.influxdata.com/time-series-platform/influxdb/) at https://docs.influxdata.com/influxdb/latest | ||
|
||
## Usage | ||
To import into your Go project, run the following command in your terminal: | ||
`go get github.com/influxdata/influxdb1-client/v2` | ||
Then, in your import declaration section of your Go file, paste the following: | ||
`import "github.com/influxdata/influxdb1-client/v2"` | ||
|
||
## 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. | ||
``` go | ||
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) | ||
} | ||
} | ||
``` |