Skip to main content

Module plexus

Module plexus 

Source

Structs§

AggExpr
AggExprArgs
AggExprBuilder
AggFn
AggregateOp
AggregateOpArgs
AggregateOpBuilder
AndExpr
AndExprArgs
AndExprBuilder
ArithExpr
ArithExprArgs
ArithExprBuilder
ArithOp
BlockMarkerOp
BlockMarkerOpArgs
BlockMarkerOpBuilder
BoolLiteralExpr
BoolLiteralExprArgs
BoolLiteralExprBuilder
CapabilityOrderingContract
CapabilityVersionRange
Capability semver range declaration for engine compatibility.
CapabilityVersionRangeArgs
CapabilityVersionRangeBuilder
CaseArm
CaseArmArgs
CaseArmBuilder
CaseExpr
CaseExprArgs
CaseExprBuilder
CmpExpr
CmpExprArgs
CmpExprBuilder
CmpOp
ColDef
ColDefArgs
ColDefBuilder
ColKind
ColRefExpr
ColRefExprArgs
ColRefExprBuilder
ConstRowOp
Zero-input source op that emits exactly one empty row. Used as the seed row for standalone CREATE/INSERT without a preceding MATCH.
ConstRowOpArgs
ConstRowOpBuilder
ContainsExpr
ContainsExprArgs
ContainsExprBuilder
CreateNodeOp
CreateNodeOpArgs
CreateNodeOpBuilder
CreateRelOp
CreateRelOpArgs
CreateRelOpBuilder
DeleteOp
DeleteOpArgs
DeleteOpBuilder
EndsWithExpr
EndsWithExprArgs
EndsWithExprBuilder
EngineCapabilityDecl
FlatBuffer block for machine-readable engine capability declaration.
EngineCapabilityDeclArgs
EngineCapabilityDeclBuilder
ExistsExpr
ExistsExprArgs
ExistsExprBuilder
ExpandDir
ExpandOp
ExpandOpArgs
ExpandOpBuilder
ExpandVarLenOp
ExpandVarLenOpArgs
ExpandVarLenOpBuilder
Expr
ExprArgs
ExprBuilder
ExprNode
ExprNodeUnionTableOffset
FilterOp
FilterOpArgs
FilterOpBuilder
FloatLiteralExpr
FloatLiteralExprArgs
FloatLiteralExprBuilder
InExpr
InExprArgs
InExprBuilder
IntLiteralExpr
IntLiteralExprArgs
IntLiteralExprBuilder
IsNotNullExpr
IsNotNullExprArgs
IsNotNullExprBuilder
IsNullExpr
IsNullExprArgs
IsNullExprBuilder
LimitOp
LimitOpArgs
LimitOpBuilder
ListComprehensionExpr
ListComprehensionExprArgs
ListComprehensionExprBuilder
ListLiteralExpr
ListLiteralExprArgs
ListLiteralExprBuilder
LogicalType
Structured logical type for a column. Added in plan format 0.3.0 alongside the deprecated string field.
MapEntryExpr
MapEntryExprArgs
MapEntryExprBuilder
MapLiteralExpr
MapLiteralExprArgs
MapLiteralExprBuilder
MergeOp
MergeOpArgs
MergeOpBuilder
NotExpr
NotExprArgs
NotExprBuilder
NullLiteralExpr
NullLiteralExprArgs
NullLiteralExprBuilder
OpNode
OpNodeUnionTableOffset
OpOrderingDecl
OpOrderingDeclArgs
OpOrderingDeclBuilder
OptionalExpandOp
OptionalExpandOpArgs
OptionalExpandOpBuilder
OrExpr
OrExprArgs
OrExprBuilder
ParamExpr
ParamExprArgs
ParamExprBuilder
PathConstructOp
PathConstructOpArgs
PathConstructOpBuilder
PlanOp
PlanOpArgs
PlanOpBuilder
PlexusPlan
Root table for a serialized Plexus query plan.
PlexusPlanArgs
PlexusPlanBuilder
ProjectOp
ProjectOpArgs
ProjectOpBuilder
PropAccessExpr
PropAccessExprArgs
PropAccessExprBuilder
RemovePropertyOp
RemovePropertyOpArgs
RemovePropertyOpBuilder
RerankOp
RerankOpArgs
RerankOpBuilder
ReturnOp
ReturnOpArgs
ReturnOpBuilder
ScanNodesOp
ScanNodesOpArgs
ScanNodesOpBuilder
ScanRelsOp
ScanRelsOpArgs
ScanRelsOpBuilder
SemiExpandOp
SemiExpandOpArgs
SemiExpandOpBuilder
SetPropertyOp
SetPropertyOpArgs
SetPropertyOpBuilder
SortDir
SortOp
SortOpArgs
SortOpBuilder
StartsWithExpr
StartsWithExprArgs
StartsWithExprBuilder
StringLiteralExpr
StringLiteralExprArgs
StringLiteralExprBuilder
UnionOp
UnionOpArgs
UnionOpBuilder
UnwindOp
UnwindOpArgs
UnwindOpBuilder
VectorMetric
VectorScanOp
VectorScanOpArgs
VectorScanOpBuilder
VectorSimilarityExpr
VectorSimilarityExprArgs
VectorSimilarityExprBuilder
Version
Semantic version of the Plexus plan format. Embedded in every serialized PlexusPlan.
VersionArgs
VersionBuilder

Enums§

AggExprOffset
AggregateOpOffset
AndExprOffset
ArithExprOffset
BlockMarkerOpOffset
BoolLiteralExprOffset
CapabilityVersionRangeOffset
CaseArmOffset
CaseExprOffset
CmpExprOffset
ColDefOffset
ColRefExprOffset
ConstRowOpOffset
ContainsExprOffset
CreateNodeOpOffset
CreateRelOpOffset
DeleteOpOffset
EndsWithExprOffset
EngineCapabilityDeclOffset
ExistsExprOffset
ExpandOpOffset
ExpandVarLenOpOffset
ExprOffset
FilterOpOffset
FloatLiteralExprOffset
InExprOffset
IntLiteralExprOffset
IsNotNullExprOffset
IsNullExprOffset
LimitOpOffset
ListComprehensionExprOffset
ListLiteralExprOffset
MapEntryExprOffset
MapLiteralExprOffset
MergeOpOffset
NotExprOffset
NullLiteralExprOffset
OpOrderingDeclOffset
OptionalExpandOpOffset
OrExprOffset
ParamExprOffset
PathConstructOpOffset
PlanOpOffset
PlexusPlanOffset
ProjectOpOffset
PropAccessExprOffset
RemovePropertyOpOffset
RerankOpOffset
ReturnOpOffset
ScanNodesOpOffset
ScanRelsOpOffset
SemiExpandOpOffset
SetPropertyOpOffset
SortOpOffset
StartsWithExprOffset
StringLiteralExprOffset
UnionOpOffset
UnwindOpOffset
VectorScanOpOffset
VectorSimilarityExprOffset
VersionOffset

Constants§

ENUM_MAX_AGG_FNDeprecated
ENUM_MAX_ARITH_OPDeprecated
ENUM_MAX_CAPABILITY_ORDERING_CONTRACTDeprecated
ENUM_MAX_CMP_OPDeprecated
ENUM_MAX_COL_KINDDeprecated
ENUM_MAX_EXPAND_DIRDeprecated
ENUM_MAX_EXPR_NODEDeprecated
ENUM_MAX_LOGICAL_TYPEDeprecated
ENUM_MAX_OP_NODEDeprecated
ENUM_MAX_SORT_DIRDeprecated
ENUM_MAX_VECTOR_METRICDeprecated
ENUM_MIN_AGG_FNDeprecated
ENUM_MIN_ARITH_OPDeprecated
ENUM_MIN_CAPABILITY_ORDERING_CONTRACTDeprecated
ENUM_MIN_CMP_OPDeprecated
ENUM_MIN_COL_KINDDeprecated
ENUM_MIN_EXPAND_DIRDeprecated
ENUM_MIN_EXPR_NODEDeprecated
ENUM_MIN_LOGICAL_TYPEDeprecated
ENUM_MIN_OP_NODEDeprecated
ENUM_MIN_SORT_DIRDeprecated
ENUM_MIN_VECTOR_METRICDeprecated
ENUM_VALUES_AGG_FNDeprecated
ENUM_VALUES_ARITH_OPDeprecated
ENUM_VALUES_CAPABILITY_ORDERING_CONTRACTDeprecated
ENUM_VALUES_CMP_OPDeprecated
ENUM_VALUES_COL_KINDDeprecated
ENUM_VALUES_EXPAND_DIRDeprecated
ENUM_VALUES_EXPR_NODEDeprecated
ENUM_VALUES_LOGICAL_TYPEDeprecated
ENUM_VALUES_OP_NODEDeprecated
ENUM_VALUES_SORT_DIRDeprecated
ENUM_VALUES_VECTOR_METRICDeprecated
PLEXUS_PLAN_EXTENSION
PLEXUS_PLAN_IDENTIFIER

Functions§

finish_plexus_plan_buffer
finish_size_prefixed_plexus_plan_buffer
plexus_plan_buffer_has_identifier
plexus_plan_size_prefixed_buffer_has_identifier
root_as_plexus_plan
Verifies that a buffer of bytes contains a PlexusPlan and returns it. Note that verification is still experimental and may not catch every error, or be maximally performant. For the previous, unchecked, behavior use root_as_plexus_plan_unchecked.
root_as_plexus_plan_unchecked
Assumes, without verification, that a buffer of bytes contains a PlexusPlan and returns it.
root_as_plexus_plan_with_opts
Verifies, with the given options, that a buffer of bytes contains a PlexusPlan and returns it. Note that verification is still experimental and may not catch every error, or be maximally performant. For the previous, unchecked, behavior use root_as_plexus_plan_unchecked.
size_prefixed_root_as_plexus_plan
Verifies that a buffer of bytes contains a size prefixed PlexusPlan and returns it. Note that verification is still experimental and may not catch every error, or be maximally performant. For the previous, unchecked, behavior use size_prefixed_root_as_plexus_plan_unchecked.
size_prefixed_root_as_plexus_plan_unchecked
Assumes, without verification, that a buffer of bytes contains a size prefixed PlexusPlan and returns it.
size_prefixed_root_as_plexus_plan_with_opts
Verifies, with the given verifier options, that a buffer of bytes contains a size prefixed PlexusPlan and returns it. Note that verification is still experimental and may not catch every error, or be maximally performant. For the previous, unchecked, behavior use root_as_plexus_plan_unchecked.