Struct GraphOperationDefinition 

pub struct GraphOperationDefinition {
    pub algorithm: GraphAlgorithm,
    pub name: &'static str,
    pub layout_requirement: GraphLayoutRequirement,
    pub empty_input_policy: EmptyGraphInputPolicy,
}

Registry-level metadata for a graph operation.

One entry per GraphAlgorithm variant. The registry is the place new algorithms must declare their layout requirement, stable SQL name, and any future metadata fields (parameter schema, weighted-edge support, etc.) so the planner, executor, and SQL surface stay in sync.

Fields

algorithm: GraphAlgorithm

Algorithm variant described by this registry row.

name: &'static str

Stable identifier used in plan display, runtime metrics, and SQL function naming (cugraph_<name>).

layout_requirement: GraphLayoutRequirement

cuGraph layout requirement for this operation.

empty_input_policy: EmptyGraphInputPolicy

Engine-owned empty-edge and side-input behavior.

Implementations

impl GraphOperationDefinition

pub const fn source_vertex_requirement(&self) -> GraphSourceVertexRequirement

Source-vertex requirement for this algorithm.

pub const fn weight_policy(&self) -> GraphWeightPolicy

Weight-column policy for this algorithm.

pub const fn output_schema_kind(&self) -> GraphOutputSchemaKind

Base output-schema descriptor for this algorithm.

pub const fn required_graph_directedness(&self) -> Option<bool>

Required graph directedness, when the cuGraph operation only accepts one graph property.

pub const fn empty_input_policy(&self) -> EmptyGraphInputPolicy

Engine-owned contract for empty graph inputs.

pub fn output_schema(&self) -> SchemaRef

Native base result schema for this algorithm.

See stable_graph_result_schema for BFS’s raw result contract and the SQL adapter’s separate vertex-result schema.

pub fn base_result_schema(&self) -> SchemaRef

Native base result schema for this algorithm.

pub fn default_graph_options( &self, defaults: &GraphConstructionOptions, ) -> GraphConstructionOptions

Shared graph-construction defaults after algorithm-level overrides.

pub fn default_params(&self) -> GraphAlgorithmParams

Default native parameter payload for metadata and planning projections.

Source-vertex algorithms use 0 as a placeholder because the real source vertex remains a required SQL/parser input with no default value.

pub fn result_schema_for_params( &self, params: &GraphAlgorithmParams, ) -> SchemaRef

Result schema for an algorithm parameter payload.

This preserves native-owned parameter-sensitive schema semantics. SQL adapters may still apply a final user-facing overlay for modes that are not part of the native IR.

Trait Implementations

impl Clone for GraphOperationDefinition

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for GraphOperationDefinition

impl Debug for GraphOperationDefinition

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

Formats the value using the given formatter.

impl Eq for GraphOperationDefinition

impl Hash for GraphOperationDefinition

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 GraphOperationDefinition

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for GraphOperationDefinition