API Reference InfluxElixir v#0.1.35

Copy Markdown View Source

Modules

Elixir client library for InfluxDB v3 with v2 compatibility.

v2 bucket CRUD operations for backwards compatibility.

v3 database CRUD operations via /api/v3/configure/database.

Health and ping checks for InfluxDB instances.

v3 token management via /api/v3/configure/token.

OTP Application entry point for InfluxElixir.

Behaviour defining the InfluxDB client contract.

Production InfluxDB client implementation using Finch.

In-memory InfluxDB client for fast, isolated testing.

InfluxDB 3's rules for database names and counts, as Client.Local applies them to create_database/3, to a write that creates its database and to start/1 (all verified against InfluxDB 3 Core).

The Flux subset InfluxElixir.Client.Local answers, with InfluxDB 2's semantics (verified against influxdb:2.7; see docs/design/2026-09-24_local-flux-pipeline.md).

Answers a query's format: option for InfluxElixir.Client.Local as Client.HTTP answers it from InfluxDB 3 (verified against Core)

The InfluxQL SELECT subset InfluxElixir.Client.Local answers, shaped the way InfluxDB 3 answers it (verified against the engine; see docs/design/2026-09-23_local-influxql.md).

DataFusion's identifier rules, applied to a SQL text before InfluxElixir.Client.Local.SQLParser reads it (verified against InfluxDB 3 Core)

The ETS store behind InfluxElixir.Client.Local: the one module that knows the key layout.

Connection configuration validation and defaults.

Named connection manager for InfluxDB instances.

Per-connection supervisor using :rest_for_one strategy.

Arrow Flight gRPC client for high-throughput query transport.

Minimal FlatBuffer binary reader for Arrow IPC metadata.

Protobuf message definitions for the Apache Arrow Flight protocol.

A chunk of Arrow IPC data streamed from a DoGet call.

Describes how to locate or identify a Flight (a named dataset or query).

A Ticket paired with a list of Locations that can serve the data.

Metadata returned by GetFlightInfo, describing a result set.

gRPC service definition for the Arrow Flight protocol.

Generated gRPC client stub for FlightService.

Initial client message in the Handshake RPC.

Server response in the Handshake RPC.

A URI identifying where a Flight service is available.

An opaque bytes token identifying a result set.

Arrow IPC record batch decoder for Arrow Flight query results.

v2 Flux query executor for backwards compatibility.

v3 InfluxQL query executor for legacy query compatibility.

Parses InfluxDB query responses in JSON, JSONL, and Flux annotated CSV formats, and passes Parquet bodies through untouched.

v3 SQL query builder and executor.

Streaming JSONL query results as a lazy Elixir Stream.

Raised while consuming a streaming query result when the request cannot produce rows.

Top-level supervisor for InfluxElixir.

Telemetry event emission for write and query operations.

Test setup helpers for consuming applications.

GenServer-based batch writer with configurable flush intervals, batch sizes, retry with exponential backoff, and backpressure.

Encodes Point structs into InfluxDB line protocol format.

Point struct representing a single InfluxDB data point.

Direct single-request write to InfluxDB.