Documentation
¶
Overview ¶
Package query groups the storage library's read seam and its language adapters.
Sub-packages:
- fetch: the dual-shape Request/Fetcher/Iterator contract — the language-agnostic seam every embedder query engine drives and every backend implements. This is the library's query surface (exposed via Storage.Fetcher); the storage library does not implement query languages.
- promql: an OPTIONAL adapter bridging the fetch contract to the Prometheus storage.Queryable, for embedders that drive the Prometheus PromQL engine. It is the only package importing github.com/prometheus/prometheus.
See ARCHITECTURE.md for the query layer's current state.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package fetch is the storage seam: the contract every query language compiles to and every data source (head, parts, cluster fan-out) implements.
|
Package fetch is the storage seam: the contract every query language compiles to and every data source (head, parts, cluster fan-out) implements. |
|
Package profile is the storage tier's EXPLAIN ANALYZE: a profiled tree of the fetch operators with per-node timing and I/O counters, showing where and how much time a query spent (which parts were scanned vs pruned, rows in/out, bytes decoded).
|
Package profile is the storage tier's EXPLAIN ANALYZE: a profiled tree of the fetch operators with per-node timing and I/O counters, showing where and how much time a query spent (which parts were scanned vs pruned, rows in/out, bytes decoded). |
|
Package promql is an optional adapter that bridges the storage fetch contract (query/fetch) to the Prometheus storage.Queryable interface.
|
Package promql is an optional adapter that bridges the storage fetch contract (query/fetch) to the Prometheus storage.Queryable interface. |
|
Package scale provides fetch-seam scale-out primitives: [Fetcher → Fetcher] decorators that any embedder's query engine composes over fetch.Fetcher (a per-tenant engine, a cluster fan-out, a cross-tenant fetch.Merge) without the library owning a query language.
|
Package scale provides fetch-seam scale-out primitives: [Fetcher → Fetcher] decorators that any embedder's query engine composes over fetch.Fetcher (a per-tenant engine, a cluster fan-out, a cross-tenant fetch.Merge) without the library owning a query language. |
Click to show internal directories.
Click to hide internal directories.