LogicalOperator

Enum LogicalOperator 

Source
pub enum LogicalOperator {
    ScanByLabel {
        variable: String,
        label: String,
        properties: HashMap<String, PropertyValue>,
    },
    Filter {
        input: Box<LogicalOperator>,
        predicate: BooleanExpression,
    },
    Expand {
        input: Box<LogicalOperator>,
        source_variable: String,
        target_variable: String,
        target_label: String,
        relationship_types: Vec<String>,
        direction: RelationshipDirection,
        relationship_variable: Option<String>,
        properties: HashMap<String, PropertyValue>,
        target_properties: HashMap<String, PropertyValue>,
    },
    VariableLengthExpand {
        input: Box<LogicalOperator>,
        source_variable: String,
        target_variable: String,
        relationship_types: Vec<String>,
        direction: RelationshipDirection,
        relationship_variable: Option<String>,
        min_length: Option<u32>,
        max_length: Option<u32>,
        target_properties: HashMap<String, PropertyValue>,
    },
    Project {
        input: Box<LogicalOperator>,
        projections: Vec<ProjectionItem>,
    },
    Join {
        left: Box<LogicalOperator>,
        right: Box<LogicalOperator>,
        join_type: JoinType,
    },
    Distinct {
        input: Box<LogicalOperator>,
    },
    Sort {
        input: Box<LogicalOperator>,
        sort_items: Vec<SortItem>,
    },
    Offset {
        input: Box<LogicalOperator>,
        offset: u64,
    },
    Limit {
        input: Box<LogicalOperator>,
        count: u64,
    },
}
Expand description

A logical plan operator - describes what operation to perform

Variants§

§

ScanByLabel

Scan all nodes with a specific label

Fields

§variable: String
§label: String
§

Filter

Apply a filter predicate (WHERE clause)

Fields

§

Expand

Traverse relationships (the core graph operation)

Represents a single-hop relationship traversal: (source)-[rel]->(target)

Fields

§input: Box<LogicalOperator>

The input operator (typically a node scan or previous expand)

§source_variable: String

Variable name for the source node (e.g., “a” in (a)-[]->(b))

§target_variable: String

Variable name for the target node (e.g., “b” in (a)-[]->(b))

§target_label: String

Label of the target node (e.g., “Person”, “Book”) This is essential for looking up the correct schema during planning

§relationship_types: Vec<String>

Types of relationships to traverse (e.g., [“KNOWS”, “FRIEND_OF”])

§direction: RelationshipDirection

Direction of traversal (Outgoing, Incoming, or Undirected)

§relationship_variable: Option<String>

Optional variable name for the relationship itself (e.g., “r” in -[r]->)

§properties: HashMap<String, PropertyValue>

Property filters to apply on the relationship

§target_properties: HashMap<String, PropertyValue>

Property filters to apply on the target node

§

VariableLengthExpand

Variable-length path expansion (*1..2 syntax)

Represents multi-hop relationship traversals: (source)-[rel*min..max]->(target) This is implemented by unrolling into multiple fixed-length paths and unioning them

Fields

§input: Box<LogicalOperator>

The input operator (typically a node scan)

§source_variable: String

Variable name for the source node

§target_variable: String

Variable name for the target node (reachable in min..max hops)

§relationship_types: Vec<String>

Types of relationships to traverse in each hop

§direction: RelationshipDirection

Direction of traversal for each hop

§relationship_variable: Option<String>

Optional variable name for the relationship pattern

§min_length: Option<u32>

Minimum number of hops (defaults to 1 if None)

§max_length: Option<u32>

Maximum number of hops (defaults to system max if None)

§target_properties: HashMap<String, PropertyValue>

Property filters to apply on target nodes

§

Project

Project specific columns (RETURN clause)

Fields

§projections: Vec<ProjectionItem>
§

Join

Join multiple disconnected patterns

Fields

§join_type: JoinType
§

Distinct

Apply DISTINCT

Fields

§

Sort

Apply ORDER BY

Fields

§sort_items: Vec<SortItem>
§

Offset

Apply SKIP/OFFSET

Fields

§offset: u64
§

Limit

Apply LIMIT

Fields

§count: u64

Trait Implementations§

Source§

impl Clone for LogicalOperator

Source§

fn clone(&self) -> LogicalOperator

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LogicalOperator

Source§

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

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

impl<'de> Deserialize<'de> for LogicalOperator

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 PartialEq for LogicalOperator

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for LogicalOperator

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 LogicalOperator

Auto Trait Implementations§

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

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

§

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
§

impl<T> From<T> for T

§

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
§

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

§

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
§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

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

Source§

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

Source§

impl<T> ErasedDestructor for T
where T: 'static,