Struct PathSearchNode 

pub struct PathSearchNode {
    pub graph: String,
    pub search: Search,
    pub columns: PathColumns,
    pub input: Arc<LogicalPlan>,
    pub vertices: Option<Arc<LogicalPlan>>,
    pub starts: Arc<LogicalPlan>,
    pub targets: Option<Arc<LogicalPlan>>,
    pub known_only: bool,
    pub source: Expr,
    pub destination: Expr,
    pub id_type: DataType,
    /* private fields */
}

A search on a graph’s index, as a logical plan node. Its inputs:

1. the edge table’s rows, projected to the endpoints (the plan the index is built from, as for a traversal);
2. the start nodes: one column of keys, each once.

Fields

graph: String

search: Search

columns: PathColumns

input: Arc<LogicalPlan>

vertices: Option<Arc<LogicalPlan>>

The keys of the vertex tables the edges connect, one column, when they have them: the graph’s nodes, as an algorithm’s (#311).

starts: Arc<LogicalPlan>

targets: Option<Arc<LogicalPlan>>

The keys the paths may end at, one column, if they are known (see the module docs).

known_only: bool

Whether every node the starts can name is a node of the index (the start node’s table is the one the index’s nodes are the keys of): a start that is not one is no node, so it has no path, not even the path of no edges.

source: Expr

destination: Expr

id_type: DataType

Implementations

impl PathSearchNode

pub fn try_new( graph: String, search: Search, columns: PathColumns, input: Arc<LogicalPlan>, vertices: Option<Arc<LogicalPlan>>, starts: Arc<LogicalPlan>, targets: Option<Arc<LogicalPlan>>, known_only: bool, source: Expr, destination: Expr, ) -> Result<Self>

Trait Implementations

impl Clone for PathSearchNode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathSearchNode

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

Formats the value using the given formatter.

impl Eq for PathSearchNode

impl Hash for PathSearchNode

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for PathSearchNode

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PathSearchNode

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl UserDefinedLogicalNodeCore for PathSearchNode

fn necessary_children_exprs( &self, _output_columns: &[usize], ) -> Option<Vec<Vec<usize>>>

Every input is read whole: the endpoints, the vertex key, the one start column and the one target column.

fn prevent_predicate_push_down_columns(&self) -> HashSet<String>

A filter on the paths cannot move into the edges or the starts.

fn name(&self) -> &str

Return the plan’s name.

fn inputs(&self) -> Vec<&LogicalPlan>

Return the logical plan’s inputs.

fn schema(&self) -> &DFSchemaRef

Return the output schema of this logical plan node.

fn expressions(&self) -> Vec<Expr>

Returns all expressions in the current logical plan node. This should not include expressions of any inputs (aka non-recursively). These expressions are used for optimizer passes and rewrites.

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

Write a single line, human readable string to f for use in explain plan.

fn with_exprs_and_inputs( &self, _exprs: Vec<Expr>, inputs: Vec<LogicalPlan>, ) -> Result<Self>

Create a new UserDefinedLogicalNode with the specified children and expressions. This function is used during optimization when the plan is being rewritten and a new instance of the UserDefinedLogicalNode must be created.

fn check_invariants( &self, _check: InvariantLevel, ) -> Result<(), DataFusionError>

Perform check of invariants for the extension node.

fn supports_limit_pushdown(&self) -> bool

Returns true if a limit can be safely pushed down through this UserDefinedLogicalNode node.