Enum PartitionSpec 

pub enum PartitionSpec {
    Integer {
        from: i64,
        to: IntBound,
        chunk_size: u64,
        bounds: Bounds,
        to_unbounded: Option<bool>,
    },
    Timestamp {
        from: String,
        to: String,
        chunk_size: String,
        timezone: Option<String>,
    },
    Offset {
        total: CountBound,
        chunk_size: u64,
    },
}

A partitioned range. kind selects the variant.

Variants

Integer

Split an integer range — the shape for an API or table filtered by an id range (?id_from=&id_to=, WHERE id BETWEEN).

Fields

from: i64

Inclusive lower bound.

to: IntBound

Upper bound, interpreted per bounds. Either a literal, or a probe that discovers it ({from_source: …, value_path: …}).

chunk_size: u64

Values per chunk. Must be > 0.

bounds: Bounds

Whether to (and each chunk’s end) is inclusive or exclusive.

Required, with no default. Getting it wrong is silent: half-open chunks against an inclusive-bound source fetch one record twice per boundary; inclusive chunks against an exclusive source skip one per boundary. Neither raises.

to_unbounded: Option<bool>

Render the final chunk without an upper bound, so rows appended above to between planning and execution are still read.

Unset defaults to true when to is discovered and false when it is a literal: a probed bound is stale the moment it is read, so the open tail is what keeps late rows from being missed. An explicit value always wins, for a range the user knows is closed.

Timestamp

Split a time range — the same windowing faucet backfill uses, including its DST-correct calendar steps.

Fields

from: String

RFC3339, or a bare date interpreted as midnight in timezone.

to: String

Exclusive upper bound; time windows are always half-open.

chunk_size: String

Window size: 45s, 30m, 6h, 1d, 1w, or a bare integer = seconds. d/w are calendar steps, so 1d and 24h differ across a DST transition — deliberately.

timezone: Option<String>

IANA timezone for date boundaries and calendar steps. Defaults to UTC.

Offset

Split a countable result set into offset/limit slices — the parallel form of what a source’s serial offset pagination already does.

Fields

total: CountBound

Total rows in the result set. Either a literal, or a probe that discovers it.

chunk_size: u64

Rows per chunk. Must be > 0.

Implementations

impl PartitionSpec

pub fn validate(&self) -> CliResult<()>

Fail-fast validation, run by faucet validate and again before any run. Range/size errors surface from the planners; this covers what has to be checked before planning is even attempted.

pub fn token_names(&self) -> &'static [&'static str]

The token names this spec’s chunks will define, for error messages that tell the user what they can reference.

pub fn kind_str(&self) -> &'static str

Human label for logs and errors.

Trait Implementations

impl Clone for PartitionSpec

fn clone(&self) -> PartitionSpec

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PartitionSpec

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PartitionSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PartitionSpec

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for PartitionSpec

fn eq(&self, other: &PartitionSpec) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PartitionSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PartitionSpec