API Reference ExDataSketch v#0.10.0

Copy Markdown View Source

Modules

Production-grade streaming data sketching algorithms for Elixir.

Behaviour defining the computation backend for ExDataSketch.

Pure Elixir backend for ExDataSketch.

Rust NIF-accelerated backend for ExDataSketch.

Public facade for the EXSK binary frame.

CRC32C (Castagnoli polynomial, reflected, init 0xFFFFFFFF, xor-out 0xFFFFFFFF) — the checksum used by EXSK v2 frames.

EXSK v2 binary frame header.

Structured validation primitives for EXSK frames.

Bloom filter for probabilistic membership testing.

Broadway integration for sketch aggregation.

A GenServer that periodically accumulates and flushes sketch data.

Count-Min Sketch (CMS) for frequency estimation.

Counting Quotient Filter (CQF) for multiset membership with approximate counting.

ExDataSketch-native binary serialization codec (EXSK format).

Cuckoo filter for probabilistic membership testing with deletion support.

DDSketch quantiles sketch for value-relative-accuracy quantile estimation.

Apache DataSketches CompactSketch binary codec for Theta sketches.

Apache DataSketches KLL binary codec for ExDataSketch.KLL.

Minimal MurmurHash3_x64_128 implementation for DataSketches seed hash computation.

Error types for ExDataSketch.

Returned when binary data cannot be deserialized.

Returned when attempting to merge sketches with incompatible parameters.

Raised when a FilterChain stage composition is invalid.

Returned when an option value is invalid.

Raised when a stubbed function is called before its implementation is available.

Raised when an operation is not supported by a structure.

Capability-aware composition framework for chaining membership filters.

Flow integration for parallel sketch reduction.

FrequentItems sketch for approximate heavy-hitter detection using the SpaceSaving algorithm.

GenStage integration for sketch aggregation.

A GenStage consumer that accumulates events into a sketch.

A GenStage producer that emits accumulated sketch snapshots on demand.

A combined GenStage producer-consumer for sketch aggregation pipelines.

HyperLogLog (HLL) sketch for cardinality estimation.

Stable 64-bit hash interface for ExDataSketch.

Shared hash + sketch metadata block.

MurmurHash3_x64_128 (64-bit output).

Compatibility checks for hash configurations across merging sketches.

XXHash3 (64-bit) hash algorithm.

Invertible Bloom Lookup Table (IBLT) for set reconciliation.

Runtime dependency detection for optional integrations.

KLL (Karnin-Lang-Liberty) quantiles sketch for rank and quantile estimation.

A Phoenix.LiveDashboard.PageBuilder page listing every ExDataSketch telemetry event, its measurements, and the Telemetry.Metrics names ExDataSketch.Telemetry.Metrics.all/1 derives from them.

MisraGries sketch for deterministic heavy hitter detection.

Facade for quantile sketch algorithms.

Quotient filter for probabilistic membership testing with safe deletion and merge.

REQ (Relative Error Quantiles) sketch for tail-accuracy quantile estimation.

A supervised, named, concurrently-updatable sketch process with optional windowing and snapshotting.

Behaviour implemented by every concrete sketch module.

A supervisor for starting ExDataSketch.Server processes per tenant or key at runtime, addressed by an arbitrary term rather than a compile-time atom.

Behaviour, registry, and dispatching facade for ExDataSketch's persistence backends.

CubDB-backed persistence for sketches.

DETS-backed persistence for sketches.

ETS-backed persistence for sketches.

Ecto-backed persistence for sketches.

Migration helper for creating the ex_data_sketch_sketches table.

Ecto schema for the ex_data_sketch_sketches table.

Mnesia-backed persistence for sketches.

Stream-native sketch construction and reduction.

Structured telemetry event emission for ExDataSketch.

Ready-made Telemetry.Metrics definitions for every ExDataSketch telemetry event.

OpenTelemetry span integration for ExDataSketch telemetry events.

Theta Sketch for set operations on cardinalities.

UltraLogLog (ULL) sketch for cardinality estimation.

A ring of tumbling sub-sketches for answering "in the last N" questions without a user-side timer.

Xor filter for static, immutable probabilistic membership testing.

Mix Tasks

Generates a migration for the ex_data_sketch_sketches table.