node

Documentation

Index

• type Node
  • func New(config *types.ExecutionConfig) *Node
  • func (n *Node) API() (*network.Server, error)
  • func (n *Node) EnsureGraphNodePropertyIndex(label, property string) error
  • func (n *Node) GraphReachable(ctx context.Context, startLabel, startProperty string, startValue any, ...) ([]any, uint, error)
  • func (n *Node) Handler() (http.Handler, error)
  • func (n *Node) ObjectStoreStats() (objectstore.Stats, bool)
  • func (n *Node) Open(ctx context.Context) (err error)
  • func (n *Node) OpenLocalSQLReader() (*sql.DB, error)
  • func (n *Node) Ready() bool
  • func (n *Node) Shutdown() error
  • func (n *Node) SpeculateSQL(ctx context.Context, fn func(*sql.Tx) error) error
  • func (n *Node) Start(ctx context.Context) error

Types

type Node

type Node struct {
	// contains filtered or unexported fields
}

Node is the main runtime container.

func New

func New(config *types.ExecutionConfig) *Node

New creates a new Node.

func (*Node) API

func (n *Node) API() (*network.Server, error)

API returns the in-process Go API used by the HTTP adapter.

func (*Node) EnsureGraphNodePropertyIndex

func (n *Node) EnsureGraphNodePropertyIndex(label, property string) error

func (*Node) GraphReachable

func (n *Node) GraphReachable(ctx context.Context, startLabel, startProperty string, startValue any, edgeType, nodeLabel string, filters map[string]any, resultProperty string, maxDepth uint32, maxResults, maxScannedEdges uint) ([]any, uint, error)

func (*Node) Handler

func (n *Node) Handler() (http.Handler, error)

Handler returns the optional HTTP server adapter after Open succeeds.

func (*Node) ObjectStoreStats

func (n *Node) ObjectStoreStats() (objectstore.Stats, bool)

func (*Node) Open

func (n *Node) Open(ctx context.Context) (err error)

Open starts the embedded engine and its private peer transport without serving HTTP.

func (*Node) OpenLocalSQLReader

func (n *Node) OpenLocalSQLReader() (*sql.DB, error)

OpenLocalSQLReader returns a caller-owned read-only handle to this node's materialized SQL state.

func (*Node) Ready

func (n *Node) Ready() bool

Ready reports whether local startup recovery and catch-up have completed. It does not prove current quorum availability.

func (*Node) Shutdown

func (n *Node) Shutdown() error

Shutdown gracefully shuts down the node.

func (*Node) SpeculateSQL

func (n *Node) SpeculateSQL(ctx context.Context, fn func(*sql.Tx) error) error

SpeculateSQL delegates a rollback-only planning transaction to the SQL materializer. Replicated commits must still use the normal Execute API.

func (*Node) Start

func (n *Node) Start(ctx context.Context) error

Start opens the embedded engine and serves the optional public HTTP adapter.