Skip to main content

AccessPath

Enum AccessPath 

Source
#[non_exhaustive]
pub enum AccessPath { FullScan, PartitionLookup, MultiPartitionLookup, ClusteringSlice, MetadataPartitionLookup, StreamingPartitionLookup, FallbackFullScan { reason: FallbackReason, }, }
Expand description

The access path a SELECT surface selected for a single SSTable-scan step.

This is the public, testable signal. Variant names are a shared contract with #958 (work counters) and #962 (fast-path unification); do not rename without updating those consumers and docs/access-paths.md.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

FullScan

Every SSTable for the table is scanned and rows are filtered in memory. This is the honest baseline when no usable restriction is present.

§

PartitionLookup

A single, fully-constrained partition (WHERE pk = ?) is served by a partition-targeted lookup that prunes SSTables (bloom/BTI presence) before scanning. Materializing path (#949 fast path).

§

MultiPartitionLookup

Several fully-constrained partitions (WHERE pk IN (...) / token fan-out) are served by repeated partition-targeted lookups. Reserved for #955; not yet produced by any surface, but named here so #955 can consume it.

§

ClusteringSlice

A partition is targeted and a clustering-key predicate (WHERE pk = ? AND ck </>/= ?) prunes rows within the partition. Reserved for #954; not yet produced by any surface.

§

MetadataPartitionLookup

The WRITETIME/TTL metadata-projection path resolved a single fully constrained partition via a targeted lookup (#962). The WHERE pk IN (...) metadata fan-out reports Self::MultiPartitionLookup instead (#1916).

§

StreamingPartitionLookup

The streaming SELECT path served a single fully-constrained partition via a partition-targeted lookup (the streaming analogue of Self::PartitionLookup).

§

FallbackFullScan

A targeted path was not selected and execution fell back to a full scan. The reason is from the documented closed set FallbackReason, so an accidental fallback cannot look like a targeted success.

Fields

§reason: FallbackReason

Why the targeted path was not taken.

Implementations§

Source§

impl AccessPath

Source

pub fn is_full_scan(&self) -> bool

True if this path scans the whole table (full scan or any fallback to one).

Tests use this to assert “this query did NOT do a full scan” without matching every fallback reason.

Source

pub fn is_targeted(&self) -> bool

True if this path targeted one or more specific partitions rather than scanning the whole table.

Source

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

A stable, lowercase label suitable for EXPLAIN-style output and JSON.

Trait Implementations§

Source§

impl Clone for AccessPath

Source§

fn clone(&self) -> AccessPath

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AccessPath

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for AccessPath

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for AccessPath

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for AccessPath

Source§

impl PartialEq for AccessPath

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for AccessPath

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for AccessPath

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more