Skip to main content

ScoredDocumentSource

Struct ScoredDocumentSource 

Source
pub struct ScoredDocumentSource { /* private fields */ }

Implementations§

Source§

impl ScoredDocumentSource

Source

pub fn new( table_name: &str, table: Arc<dyn TableRead>, input: ScoredInput, schema: Vec<String>, ordered_primary_key: Option<String>, predicate: Option<ProjectedPredicate>, ) -> Self

Source

pub fn new_with_metadata( table_name: &str, table: Arc<dyn TableRead>, input: ScoredInput, schema: Vec<String>, ordered_primary_key: Option<String>, predicate: Option<ProjectedPredicate>, metadata: RelationMetadataProjection, ) -> Self

Source

pub fn new_configured( table_name: &str, table: Arc<dyn TableRead>, input: ScoredInput, schema: Vec<String>, ordered_primary_key: Option<String>, predicate: Option<ProjectedPredicate>, attributes: ScoredSourceAttributes, ) -> Self

Build one physical scored source while optionally sharing the opaque score attribute with sibling scans that form one logical relation.

Source

pub fn with_serializable_read( self, read: Option<SerializableRelationRead>, ) -> Self

Source

pub fn with_scan_batch_bytes(self, bytes: usize) -> Self

Bound the bytes retained by an ordered shared or borrowed document cursor. The current row may exceed the allowance; the next row belongs to the next batch.

Source

pub fn with_index_only(self, index_only: bool) -> Self

Project rows from the index entries the table holds for every projected field. A row-locking read and a pinned recheck still read their documents.

Source

pub fn with_index_read_control(self, control: StorageReadControl) -> Self

Source

pub fn with_lock_origin(self, origin: Option<SharedLockOrigin>) -> Self

Source

pub fn with_table_oid(self, table_oid: i64) -> Self

Source

pub fn with_recheck_pins( self, pins: Option<Arc<Vec<RecheckDoc>>>, ) -> Result<Self, SQLError>

Pin this scan to a tuple-local recheck candidate’s tuples. A ranked input (retrieval predicate) was re-executed against the latest index state when the recheck rebuilt the scan, so a pinned tuple survives only if the retrieval still matches it, exactly like PostgreSQL re-evaluating the WHERE clause on the substituted tuple; its score is the re-executed retrieval score. A plain scan input keeps every pinned tuple and lets the residual predicates decide.

Source

pub fn with_qualifier(self, qualifier: &str) -> Self

Bind every visible column to its relation without changing public labels or copying values.

Source

pub fn without_wildcard_columns(self) -> Self

Open document fields are explicitly addressable without expanding the source’s declared wildcard row.

Source

pub fn with_row_type( self, qualifier: &str, row_type: Option<ColumnType>, ) -> Result<Self, SQLError>

Keep the catalog’s whole-row identity alongside selected fields and hidden retrieval metadata.

Trait Implementations§

Source§

impl RowSource for ScoredDocumentSource

Source§

fn schema(&self) -> &[String]

Stable column order for the rows produced by Self::next_row.
Source§

fn supports_batched_consumption(&self) -> bool

Native batch reads preserve the SQL evaluation and first-error order of consecutive single-row reads when the caller consumes the complete input. Custom sources must establish this before opting in.
Source§

fn physical_schema(&self) -> Option<&RowSchema>

Optional non-identity schema used by positional sources. This carries hidden lookup aliases and slot remaps that cannot be represented by the legacy column-name slice.
Source§

fn output_ordering(&self) -> &[PhysicalOrder]

Leading row order guaranteed by the source.
Source§

fn next_row(&mut self) -> ExecResult<Option<ResultRow>>

Pull the next row. Returns None when the source is exhausted.
Source§

fn next_batch(&mut self, max_rows: usize) -> ExecResult<Vec<ResultRow>>

Pull up to max_rows without forcing batch-capable sources through a row-at-a-time lock or backend call. The default preserves compatibility for iterator-like sources.
Source§

fn next_physical_batch( &mut self, max_rows: usize, ) -> ExecResult<Vec<PhysicalRow>>

Pull a positional batch directly. Backend-native sources override this to avoid constructing named maps at the scan boundary; compatibility sources are converted exactly once here.
Source§

fn collect_materialized( &mut self, sink: &mut MaterializedResultSink<'_>, ) -> ExecResult<bool>

Consume the complete source into the native public accumulator without transferring temporary row ownership. Unsupported sources decline before advancing their cursor.
Source§

fn consume_into_aggregate( &mut self, executor: &mut dyn AggregateExecutor, ) -> ExecResult<bool>

Feed backend-native projected rows directly to an aggregate. Sources that cannot preserve their normal filter and virtual-column semantics return false without advancing their cursor.
Source§

fn estimated_cardinality(&self) -> Option<u64>

Estimated total rows available from this source.

Auto Trait Implementations§

Blanket Implementations§

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<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.