# README
InfluxDB IOx Client for Go
Package influxdbiox is the official Go client for InfluxDB/IOx.
InfluxDB/IOx uses Arrow Flight gRPC for queries. This client makes it easy to use that interface.
Take a look at the godoc for usage.
SQL
Package ioxsql contains an implementation of the database/sql driver interface.
Tests
This project does not run tests as part of CI. Most tests depend on a running instance of InfluxDB/IOx, and each creates its own database. To start an in-memory instance, from the InfluxDB/IOx repository root:
$ cargo build
$ ./target/debug/influxdb_iox run all-in-one
Then run the tests like any golang test:
$ go test ./...
# Packages
Package ioxsql is the compatibility layer from influxdbiox to database/sql.
# Functions
ClientConfigFromAddressString constructs an instance of *ClientConfig from an address string.
ClientConfigFromJSONString constructs an instance of *ClientConfig from a JSON string.
NewClient instantiates a connection with the InfluxDB/IOx gRPC services.
WriteTokenFromHTTPResponse fetches the IOx write token, if available, from the http.Response object.
# Constants
ColumnType_BOOL is a bool.
ColumnType_F64 is an float64.
ColumnType_I64 is an int64.
ColumnType_STRING is a string.
ColumnType_TAG is a tag value.
ColumnType_TIME is a timestamp.
ColumnType_U64 is an uint64.
ColumnTypeUnknown is an invalid column type.
# Structs
Client is the primary handle to interact with InfluxDB/IOx.
ClientConfig contains all the options used to establish a connection.
QueryRequest represents a prepared query.
# Type aliases
ColumnType defines the column data types IOx can represent.