ArcFlow
Company
Managed Services
Markets
  • News
  • LOG IN
  • GET STARTED

OZ brings Visual Intelligence to physical venues, a managed edge layer that lets real-world environments see, understand, and act in real time.

Talk to us

ArcFlow

  • World Models
  • Sensors

Managed Services

  • OZ VI Venue 1
  • Case Studies

Markets

  • Sports
  • Broadcasting
  • Robotics

Company

  • About
  • Technology
  • Careers
  • Contact

Ready to see it live?

Talk to the OZ team about deploying at your venues, from a single pilot match to a full regional rollout.

Schedule a deployment review

© 2026 OZ. All rights reserved.

LinkedIn
ArcFlow Docs
Get Started
  • Get Started
  • Quickstart
  • Installation
  • Project Setup
  • Platforms
  • Bindings
  • Licensing
  • Pricing
Capabilities
  • Vector Search
  • Graph Algorithms
  • Sync
  • MCP Server (AI Agents)
  • Live Queries
  • Programs
  • Temporal
  • Spatial
  • Trusted RAG
  • Behavior Graph
  • Agent-Native
  • Event Sourcing
  • GPU Acceleration
  • Intent Relay
Concepts
  • World Model
  • Graph Model
  • Query Language (GQL)
  • Graph Patterns
  • SQL vs GQL
  • Parameters
  • Query Results
  • Persistence & WAL
  • Error Handling
  • Observations & Evidence
  • Confidence & Provenance
  • Proof Artifacts & Gates
  • Skills
GQL / WorldCypher
  • Overview
  • MATCH
  • WHERE
  • RETURN
  • OPTIONAL MATCH
  • CREATE
  • SET
  • MERGE
  • DELETE
  • REMOVE
  • WITH
  • UNION
  • UNWIND
  • CASE
  • Spatial Queries
  • Temporal Queries
  • Algorithms Reference
  • Triggers
Schema
  • Overview
  • Indexes
  • Constraints
  • Data Types
Functions
  • Built-in Functions
  • Aggregations
  • Procedures
  • Shortest Path
  • EXPLAIN
  • PROFILE
Skills
  • Overview
  • CREATE SKILL
  • PROCESS NODE
  • REPROCESS EDGES
Operations
  • CLI
  • REPL Commands
  • Snapshot & Restore
  • Server Modes & PG Wire
  • Persistence
  • Import & Export
  • Docker
  • Architecture
  • Cloud Architecture
  • Sync Protocol (Deep Dive)
Guides
  • Agent Integration
  • World Model
  • Graph Model Fundamentals
  • Trusted RAG
  • Using Skills
  • Behavior Graphs
  • Swarm & Multi-Agent
  • Migration Guide
  • Filesystem Workspace
  • From SQL to GQL
  • ArcFlow for Coding Agents
  • Data Quality & Pipeline Integrity
  • Code Intelligence
Tutorials
  • Knowledge Graph
  • Entity Linking
  • Vector Search
  • Graph Algorithms
Recipes
  • CRUD
  • Multi-MATCH
  • MERGE (Upsert)
  • Full-Text Search
  • Temporal Queries
  • Batch Projection
  • GraphRAG
Use Cases
  • Agent Tooling
  • Knowledge Management
  • RAG Pipeline
  • Fraud Detection
  • Sports Analytics
  • Grounded Neural Objects
  • Behavior Graphs
  • Autonomous Systems
  • Digital Twins
  • Robotics & Perception
Reference
  • TypeScript API
  • GQL Conformance
  • Compatibility Matrix
  • Glossary
  • Data Types
  • Operators
  • Error Codes
  • Known Issues

Procedures

This reference is designed for both human developers and AI coding agents. Every entry includes complete CALL syntax and return columns that can be used directly in queries.

100+ CALL procedures: Database Introspection (20), Graph Algorithms (27), Embedding (5), Knowledge Graph (6), Temporal (9), Live Queries (5), System (14), Auth (7), Health (3), Extensions (5), and Behavior Graph (3). All return tabular results.

CALL db.procedures()

Returns the full list of available procedures (column: name).

Database Introspection (20)#

Core procedures for inspecting database state, schema, and metadata.

ProcedureReturn ColumnsDescriptionSince
CALL db.nodeCount()countTotal node count0.19.0
CALL db.relCount()countTotal relationship count0.19.0
CALL db.labels()labelAll node labels in use0.19.0
CALL db.types()typeAll relationship types in use0.19.0
CALL db.keys()keyAll property keys in use0.19.0
CALL db.version()name, version, crates, wavesEngine version and build info0.19.0
CALL db.stats()nodes, relationships, skillsDatabase statistics summary0.20.0
CALL db.stats.json()jsonAll metadata as single JSON object5.0.0
CALL db.schema()label, properties, countSchema overview: labels, property keys per label, counts, and relationship patterns4.0.0
CALL db.indexes()label, propertyAll indexes with target label and property0.19.0
CALL db.constraints()label, property, typeAll constraints with target and type0.19.0
CALL db.procedures()nameList all available procedure names0.20.0
CALL db.help()procedure, description, exampleQuick-reference of key procedures with examples5.0.0
CALL db.tutorial()step, title, query, descriptionInteractive 6-step walkthrough for new users5.0.0
CALL db.doctor()check, status, detailDiagnostic health check: 5 checks + HEALTHY/ISSUES_FOUND summary4.0.0
CALL db.export()snapshot, nodes, relationships, generationExport full graph as JSON snapshot3.0.0
CALL db.import('<json>')status, nodes_before, nodes_afterImport graph from JSON snapshot (mutating)5.0.0
CALL db.import.csv('<csv>', '<Label>')importedImport CSV rows as nodes with given label (mutating)5.0.0
CALL db.clear()status, nodes_removed, rels_removedDelete all nodes, relationships, and indexes (mutating)5.0.0
CALL db.demo()(demo graph)Load sample social network graph with example queries (mutating)5.0.0
-- Get a schema overview
CALL db.schema()

Returns one row per label with property keys and node count, plus relationship patterns.

-- Run diagnostics
CALL db.doctor()

Returns rows for each check (node_count, relationship_integrity, index_consistency, constraints, generation) plus a summary row with HEALTHY or ISSUES_FOUND status.

Graph Algorithms (27)#

Centrality (5)#

ProcedureReturn ColumnsDescriptionSince
CALL algo.pageRank()nodeId, name, rankPageRank (20 iterations, damping 0.85). GPU-accelerated when available.0.26.0
CALL algo.confidencePageRank()nodeId, name, confidence, rankPageRank weighted by node confidence scores5.0.0
CALL algo.betweenness()nodeId, name, betweennessBetweenness centrality scores3.0.0
CALL algo.closeness()nodeId, name, closenessCloseness centrality scores3.0.0
CALL algo.degreeCentrality()nodeId, name, centralityDegree centrality scores3.0.0
CALL algo.pageRank()

Returns one row per node, sorted by rank. Uses 20 iterations with damping factor 0.85.

Community Detection (5)#

ProcedureReturn ColumnsDescriptionSince
CALL algo.connectedComponents()nodeId, name, componentConnected component IDs0.26.0
CALL algo.communityDetection()nodeId, name, communityCommunity IDs via label propagation. GPU-accelerated when available.0.26.0
CALL algo.louvain()nodeId, name, communityCommunity IDs via Louvain modularity optimization. GPU-accelerated when available.3.0.0
CALL algo.leiden()nodeId, communityCommunity IDs via Leiden algorithm (20 iterations)5.0.0
CALL algo.kCore()nodeId, name, corenessK-core decomposition values3.0.0
CALL algo.louvain()

Returns one row per node with hierarchical community assignment.

Graph Metrics (4)#

ProcedureReturn ColumnsDescriptionSince
CALL algo.density()densityGraph density ratio (0.0 to 1.0)3.0.0
CALL algo.diameter()diameterGraph diameter (longest shortest path)3.0.0
CALL algo.triangleCount()trianglesTotal triangle count in the graph. GPU-accelerated when available.3.0.0
CALL algo.clusteringCoefficient()nodeId, name, coefficientPer-node clustering coefficients. GPU-accelerated when available.3.0.0
CALL algo.triangleCount()

Returns a single row with the total number of triangles.

Path Analysis (4)#

ProcedureReturn ColumnsDescriptionSince
CALL algo.allPairsShortestPath()source, target, distanceShortest path distances between all node pairs (capped at 100 rows). GPU-accelerated when available.3.0.0
CALL algo.confidencePath(startId, endId)path, cost, lengthShortest path between two nodes weighted by confidence5.0.0
CALL algo.dijkstra(startId, endId, 'weight')path, distanceWeighted shortest path10.0.0
CALL algo.astar(startId, endId, 'weight', 'heuristic')path, distanceHeuristic-guided shortest path (A*)10.0.0
-- Find confidence-weighted shortest path between node 1 and node 5
CALL algo.confidencePath(1, 5)

Returns the path as "id1 -> id2 -> id3", total cost, and hop count.

Similarity and Spatial (6)#

ProcedureReturn ColumnsDescriptionSince
CALL algo.nodeSimilarity()node1, node2, similarityPairs of nodes with Jaccard similarity scores (top 20)4.0.0
CALL algo.similarNodes()nodeId, scoreNodes similar to the first vector-bearing node (cosine similarity)5.0.0
CALL algo.nearestNodes(point, label, k)node, distanceK nearest nodes by exact spatial distance (ArcFlow Spatial Index, ≥ 2000/s at 11K entities)5.0.0
CALL algo.objectsInFrustum($frustum)node, distanceEntities within a camera frustum (6-plane containment, < 2ms for 50 entities)10.0.0
CALL algo.nearestVisible($pos, label, k)node, distanceNearest entities with direct line-of-sight from a point10.0.0
CALL spatial.raycast(origin, direction, maxDist)hit, distanceFirst node along a ray within max distance10.0.0

Vector Search and RAG (5)#

ProcedureReturn ColumnsDescriptionSince
CALL algo.vectorSearch()nodeId, score, labelsVector similarity search over vector index. Accepts optional query vector argument. GPU-accelerated when available.5.0.0
CALL algo.hybridSearch()nodeId, score, hopsCombined vector + graph traversal search5.0.0
CALL algo.graphRAG()nodeId, score, hops, labelsGraph-augmented retrieval for RAG pipelines. Accepts optional query vector argument.5.0.0
CALL algo.graphRAGContext()context, node_count, tokens_approxFormatted LLM context from graph retrieval. Accepts optional query vector and max_tokens arguments.5.0.0
CALL algo.graphRAGTrusted()nodeId, trusted_score, hops, observationTrusted RAG with confidence-filtered context, ranked by observation class5.0.0
-- Vector similarity search with a query vector
CALL algo.vectorSearch([0.1, 0.9, 0.3])

Returns nodes ranked by cosine similarity to the query vector.

-- Trusted RAG pipeline
CALL algo.graphRAGTrusted()

Returns nodes with trusted_score, observation class (observed > inferred > predicted), filtering low-trust paths.

Embedding Algorithms (5)#

Generate node embeddings for downstream vector search, classification, and similarity tasks.

ProcedureReturn ColumnsDescriptionSince
CALL algo.node2vec(dims, walkLen, walks)(sets node.embedding)Structural random walk embeddings10.0.0
CALL algo.struc2vec(dims)(sets node.embedding)Structural equivalence embeddings10.0.0
CALL algo.graphSAGE(dims)(sets node.embedding)Inductive neighborhood aggregation embeddings10.0.0
CALL algo.staleEmbeddings()nodeId, nameNodes whose embeddings are outdated (property changed after last embed)10.0.0
CALL algo.classify($vec, 'indexName', {k: 10})nodeId, label, confidenceClassify by similarity to labeled examples in a vector index10.0.0
-- Embed all nodes with 128-dimensional Node2Vec vectors
CALL algo.node2vec(128, 80, 10)
 
-- Find stale embeddings after property updates
CALL algo.staleEmbeddings()

Knowledge Graph Algorithms (6)#

Algorithms for reasoning over facts, confidence, and semantic relationships.

ProcedureReturn ColumnsDescriptionSince
CALL algo.entityResolution()nodeId1, nodeId2, similarityFind nodes referring to the same real-world entity10.0.0
CALL algo.factContradiction()nodeId1, nodeId2, contradiction_type, confidenceDetect contradictory facts in the graph10.0.0
CALL algo.relationshipStrength()fromId, toId, strengthScore relationship strength by frequency, recency, mutual links10.0.0
CALL algo.compoundingScore()nodeId, scoreComposite confidence propagated through fact chains10.0.0
CALL algo.entityFreshness()nodeId, name, freshness, last_observed_atFreshness of each entity based on last observation10.0.0
CALL algo.semanticDedup()nodeId1, nodeId2, similarityNear-duplicate nodes via embedding similarity10.0.0
-- Find entities that may refer to the same person
CALL algo.entityResolution()

Auth & Governance (7)#

API key management and audit log procedures.

ProcedureReturn ColumnsDescriptionSince
CALL db.auth.whoami()identity, role, scopesCurrent authenticated identity9.0.0
CALL db.auth.policies()resource, action, allowedACL policy definitions9.0.0
CALL db.auth.check('resource', 'action')allowed, reasonCheck if current identity has permission9.0.0
CALL db.auth.createApiKey('name')key, created_atCreate a new API key (write)9.0.0
CALL db.auth.revokeApiKey('key')revokedRevoke an API key (write)9.0.0
CALL db.auth.listApiKeys()name, created_at, last_usedList all API keys9.0.0
CALL db.auth.auditLog()timestamp, identity, action, resourceRecent auth audit events9.0.0

Temporal (9)#

Procedures for temporal queries, clock management, and change tracking.

ProcedureReturn ColumnsDescriptionSince
CALL db.clock()name, tickCurrent engine clock name and tick value4.0.0
CALL db.clockDomains()domain, countAll registered clock domains with node counts4.0.0
CALL db.temporalCompare()changeCount, fromSequence, toSequence, operationCompare mutations from sequence 0 to current4.0.0
CALL db.temporalGate()valid, violationCount, violationCheck temporal gate consistency; lists violations if any4.0.0
CALL db.temporalReplay()sequence, operation, timestampReplay all WAL mutations from sequence 04.0.0
CALL db.nodesAsOf()nodeId, labels, createdAtReturn all nodes that existed at or before current time4.0.0
CALL db.changesSince()sequence, operationRecent mutations (last 100 entries)5.0.0
CALL db.mutations()sequence, operation, timestampRecent mutation log (last 50 entries) with timestamps5.0.0
CALL db.fingerprint()fingerprintDeterministic FNV hash of current graph state (hex string)5.0.0
-- See recent mutations with timestamps
CALL db.mutations()

Returns rows with sequence number, operation description, and timestamp.

-- Point-in-time query (query modifier, not a CALL procedure)
MATCH (n:Person) AS OF seq N
RETURN n.name

Note: AS OF is a query modifier, not a CALL procedure.

Live Queries (5)#

Procedures for live queries: topics, subscriptions, live views, and causal chains.

ProcedureReturn ColumnsDescriptionSince
CALL db.topics()id, name, eventsAll registered event topics with event counts3.0.0
CALL db.subscriptions()name, topic, query, activeActive subscriptions with topic bindings3.0.0
CALL db.liveQueries()name, queryActive live query registrations3.0.0
CALL db.causalChain()origin, depth, target, target_labels, confidenceTraces CAUSES chains from all Action nodes (depth 10)3.0.0
CALL db.views()name, queryMaterialized view definitions4.0.0
CALL db.causalChain()

Finds all :Action nodes and traces outgoing CAUSES relationships up to depth 10, returning each hop with confidence scores.

System (14)#

Procedures for backend management, validation, and observability.

ProcedureReturn ColumnsDescriptionSince
CALL db.backends()id, available, messageAvailable compute backends (CPU, CUDA, Metal) with status5.0.0
CALL db.storageInfo()format, nodesStorage backend details (format, generation, node/rel counts, mutation sequence)5.0.0
CALL db.validateQuery()valid, warningsParse and validate a query without executing5.0.0
CALL db.vectorIndexes()name, label, property, dimensions, similarityAll vector indexes with configuration5.0.0
CALL db.observationClasses()class, countObservation class counts (observed, inferred, predicted)4.0.0
CALL db.nodesByObservation.observed()_id, _labels, _observation_class, _confidenceAll nodes with observation class "observed"5.0.0
CALL db.nodesByObservation.inferred()_id, _labels, _observation_class, _confidenceAll nodes with observation class "inferred"5.0.0
CALL db.nodesByObservation.predicted()_id, _labels, _observation_class, _confidenceAll nodes with observation class "predicted"5.0.0
CALL db.nodesByPlane.semantic()_id, _labels, _authority_planeNodes in the semantic authority plane5.0.0
CALL db.nodesByPlane.scene()_id, _labels, _authority_planeNodes in the scene authority plane5.0.0
CALL db.proofGates()gate, status, evidenceProof gate definitions and their validation status5.0.0
CALL db.proofArtifacts()artifact, type, detailGenerated proof artifacts5.0.0
CALL db.executionContext()context, fallback_disabled, backends_availableCurrent execution context (backend, GPU availability)5.0.0
CALL db.affordances()from, to, confidenceAll AFFORDS relationships in the graph5.0.0
-- Check available GPU backends
CALL db.backends()

Returns one row per backend (cpu, metal, cuda) with availability and status message.

-- Query by observation class
CALL db.nodesByObservation.observed()

Returns all nodes classified as "observed" with their confidence scores.

Spatial System (3)#

Coordinate frame management and spatial query observability.

ProcedureReturn ColumnsDescriptionSince
CALL db.spatialMetadata()crs, meters_per_unit, up_axis, handedness, calibration_versionCurrent coordinate frame settings. Hard error raised on mismatch at ingest.10.0.0
CALL arcflow.spatial.dispatch_stats()lane_chosen, estimated_candidates, actual_candidates, prefilter_us, rtree_us, gpu_transfer_us, kernel_us, total_usLast spatial query execution metrics. lane_chosen: CpuLive, CpuBatch, GpuLocal, GpuMulti.10.0.0
CALL arcflow.spatial.trigger_stats()query_name, node_id, predicate_type, evaluation_us, firedLive geofence trigger metrics — one row per predicate evaluation since last reset.10.0.0
-- Inspect current coordinate frame
CALL db.spatialMetadata()
 
-- Check dispatch lane after a spatial query
CALL arcflow.spatial.dispatch_stats()

Health (3)#

ProcedureReturn ColumnsDescriptionSince
CALL db.replicationStatus()mode, replica_count, writes_enabledReplication mode, replica count, and write status5.0.0
CALL db.checkpointMeta()generation, nodesLast checkpoint generation, node/rel counts, mutation sequence5.0.0
CALL db.schemaRegistry()label, property, typeRegistered schema versions with property types5.0.0
CALL db.replicationStatus()

Returns the current replication mode (standalone/primary/replica), replica count, and whether writes are enabled.

Extension Procedures (5)#

Additional domain-specific procedures.

ProcedureReturn ColumnsDescriptionSince
CALL vector.search()nodeId, score, labelsAlias for algo.vectorSearch — searches first available vector index5.0.0
CALL swarm.agents()id, type, status, positionAll registered agent definitions8.0.0
CALL swarm.register('agent_id', 'agent_type')id, type, statusRegister a new agent (requires agent_id argument)8.0.0
CALL swarm.agentCount()active, totalNumber of active and total registered agents8.0.0
CALL geo.cells()cell_id, name, status, entities, agentsSpatial grid cells with entity/agent counts9.0.0
-- Register a drone agent
CALL swarm.register('drone_01', 'drone')

Behavior Graph (3)#

Behavior tree procedures backed by the world model. Nodes labeled :BehaviorNode form the tree; CHILD relationships define structure.

ProcedureReturn ColumnsDescriptionSince
CALL behavior.tick('treeName')tree, status, running, success, failureTick a behavior tree: evaluate from root, propagate SUCCESS/FAILURE/RUNNING9.0.0
CALL behavior.status('treeName')nodeId, name, type, status, lastTickCurrent status of all nodes in a behavior tree9.0.0
CALL behavior.nodes()nodeId, name, type, childrenList all behavior tree nodes with child counts9.0.0
-- Tick a behavior tree named "patrol"
CALL behavior.tick('patrol')
-- List all behavior nodes
CALL behavior.nodes()

See Also#

  • Built-in Functions -- 83 scalar functions (17 math, 11 aggregation, 23 string, ...)
  • EXPLAIN -- query plan introspection
  • PROFILE -- query execution profiling
  • RAG Pipeline Guide -- building RAG with ArcFlow
Try it
Open ↗⌘↵ to run
Loading engine…
← PreviousAggregationsNext →Shortest Path