Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/offa/influxdb-cxx
InfluxDB C++ client library.
https://github.com/offa/influxdb-cxx
cpp cpp20 influxdb influxdb-client influxdb-cxx
Last synced: 3 days ago
JSON representation
InfluxDB C++ client library.
- Host: GitHub
- URL: https://github.com/offa/influxdb-cxx
- Owner: offa
- License: mit
- Created: 2020-09-08T15:28:54.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-11-18T20:39:56.000Z (about 2 months ago)
- Last Synced: 2025-01-05T06:12:52.257Z (10 days ago)
- Topics: cpp, cpp20, influxdb, influxdb-client, influxdb-cxx
- Language: C++
- Homepage:
- Size: 560 KB
- Stars: 125
- Watchers: 7
- Forks: 46
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# influxdb-cxx
[](https://github.com/offa/influxdb-cxx/actions/workflows/ci.yml)
[](https://github.com/offa/influxdb-cxx/releases)
[](LICENSE)
[](https://conan.io/center/recipes/influxdb-cxx)
InfluxDB C++ client library
- Batch write
- Data exploration
- Supported transports
- HTTP/HTTPS
- UDP
- Unix datagram socket
- TCP
*Fork of the unmaintained [awegrzyn/influxdb-cxx](https://github.com/awegrzyn/influxdb-cxx) project.*
## Installation
### Build requirements
- CMake 3.12+
- C++20 compiler
### Dependencies
- [**cpr**](https://github.com/libcpr/cpr) (required)i)
- **boost 1.78+** (optional – see [Transports](#transports))
i) *cpr* needs to provide [CMake support](https://github.com/libcpr/cpr#find_package); some systems need to call `ldconfig` after *.so* installation.
### Generic
```bash
mkdir build && cd build
cmake ..
sudo make install
```
## Quick start
### Include in CMake project
The InfluxDB library is exported as target `InfluxData::InfluxDB`.
```cmake
project(example)
find_package(InfluxDB)
add_executable(example-influx main.cpp)
target_link_libraries(example-influx PRIVATE InfluxData::InfluxDB)
```
This target is also provided when the project is included as a subdirectory.
```cmake
project(example)
add_subdirectory(influxdb-cxx)
add_executable(example-influx main.cpp)
target_link_libraries(example-influx PRIVATE InfluxData::InfluxDB)
```
### Basic write
```cpp
// Provide complete URI
auto influxdb = influxdb::InfluxDBFactory::Get("http://localhost:8086?db=test");
influxdb->write(influxdb::Point{"test"}
.addField("value", 10)
.addTag("host", "localhost")
);
```
### Batch write
```cpp
auto influxdb = influxdb::InfluxDBFactory::Get("http://localhost:8086?db=test");
// Write batches of 100 points
influxdb->batchOf(100);
for (;;) {
influxdb->write(influxdb::Point{"test"}.addField("value", 10));
}
```
###### Note:
When batch write is enabled, call `flushBatch()` to flush pending batches.
This is of particular importance to ensure all points are written prior to destruction.
```cpp
auto influxdb = influxdb::InfluxDBFactory::Get("http://localhost:8086?db=test");
influxdb->batchOf(3);
influxdb->write(influxdb::Point{"test"}.addField("value", 1));
influxdb->write(influxdb::Point{"test"}.addField("value", 2));
// Flush batches, both points are written
influxdb->flushBatch();
```
### Query
```cpp
// Available over HTTP only
auto influxdb = influxdb::InfluxDBFactory::Get("http://localhost:8086?db=test");
/// Pass an IFQL to get list of points
std::vector points = influxdb->query("SELECT * FROM test");
```
### Execute cmd
```cpp
auto influxdb = influxdb::InfluxDBFactory::Get("http://localhost:8086?db=test");
// Execute a command and receive it's response
const auto response = influxdb->execute("SHOW DATABASES");
```
## Transports
Supported transports:
| Name | Dependency | URI protocol | Sample URI |
| ----------- |:-----------:|:--------------:| -------------------------------------:|
| HTTP | cpri) | `http`/`https` | `http://localhost:8086?db=` |
| TCP | boost | `tcp` | `tcp://localhost:8094` |
| UDP | boost | `udp` | `udp://localhost:8094` |
| Unix socket | boost | `unix` | `unix:///tmp/telegraf.sock` |
i) boost is needed to support queries.
### Configuration by URI
An underlying transport is configurable by passing an URI. `[protocol]` determines the actual transport type:
```cpp
auto influxdb = influxdb::InfluxDBFactory::Get("http://localhost:8086?db=test");
```
URI Format:
```
[protocol]://[username:password@]host:port[?db=database]
# Auth token:
[protocol]://[token@]host:port[?db=database]
```
### Additional transport configuration *(HTTP only)*
The HTTP transport supports additional configurations beyond the limited URI parameters:
```cpp
auto influxdb = InfluxDBBuilder::http("http://localhost:8086?db=test")
.setTimeout(std::chrono::seconds{20})
.setAuthToken("")
.connect();
```
## InfluxDB v2.x compatibility
The support for InfluxDB v2.x is limited at the moment. It's possible to use the v1.x compatibility backend though.
Please visit [*InfluxDB 1.x compatibility API* docs](https://docs.influxdata.com/influxdb/v2.6/reference/api/influxdb-1x/) for more information.
To create a v1.x compatible user (as described [here](https://docs.influxdata.com/influxdb/v2.6/reference/cli/influx/v1/auth/)):
```sh
influx v1 auth create --read-bucket ${BUCKET_ID} --write-bucket ${BUCKET_ID} --username ${USERNAME} --password ${PASSWORD}
```
## Thread safety
This library is not thread-safe. Using it in a multi-threaded environment without proper synchronization mechanisms may lead to unexpected behavior and data corruption.