Bluetape4k Graph 0.5 manual
Latest stable Based on Graph release 1.0.0
This manual describes the stable 1.0.0 contract at commit a405300799b36d4d6edb7267ad07ff34d4ad3afe. It covers the common model, paired synchronous/coroutine APIs, five supported backends, graph-io, and framework integration. Amazon Neptune is not supported in 1.0.0; backlog issues are not part of this contract.
Core capabilities
Section titled “Core capabilities”- Backend-independent graph model: The core model gives every backend the same vertex, edge, path, and element-ID vocabulary.
- Synchronous and coroutine APIs: Paired APIs keep repository, traversal, batch, merge, and transaction operations aligned across blocking and suspending execution.
- Five database backends: The backend selection guide compares Neo4j, Memgraph, Apache AGE, TinkerPop/TinkerGraph, and FalkorDB by query language, transaction behavior, and operational fit.
- Schema, traversal, and transactions: Schema and transactions explains labels, indexes, constraints, merge semantics, paths, and ownership boundaries.
- Graph import and export: graph-io formats, execution models, and OkIO security cover CSV, NDJSON, GraphML, compression, and authenticated encryption.
- Application integration and examples: Spring Boot, Ktor, and the learning path connect the common API to runnable domain examples and production checks.
Start with a decision
Section titled “Start with a decision”- Follow Getting started to import the ecosystem BOM and run one operation.
- Read the backend selection guide before adopting a driver.
- Learn the core model, paired APIs, and transaction boundary.
- Choose a learning path, then use the testing and operations guides before production.
The API center is GraphOperations and GraphSuspendOperations. Both return the backend-independent models defined under graph-core/model.
Manual map
Section titled “Manual map”- Architecture: repository layout, model, API composition, schema, merge/batch, traversal, and transactions.
- Backends: Neo4j, Memgraph, Apache AGE, TinkerPop/TinkerGraph, and FalkorDB.
- graph-io: format boundaries, execution models, OkIO compression and authenticated encryption.
- Frameworks: Ktor plugin and Spring Boot auto-configuration lifetimes.
- Guides: staged learning, tests, operations, cancellation, and benchmark interpretation.
Version selection belongs to bluetape4k-dependencies, not to individual graph libraries or the graph BOM. Every dependency example in this manual therefore imports the ecosystem BOM and leaves module coordinates unversioned.
Guides and concepts
Section titled “Guides and concepts”- Start: Getting started, learning path
- Architecture: repository map, core model, paired APIs, schema and transactions
- Backends: selection guide, Neo4j and Memgraph, Apache AGE, TinkerPop, FalkorDB
- graph-io: formats, execution model, OkIO security
- Frameworks: Spring Boot, Ktor
- Production guides: testing, operations, failure and cancellation, benchmark-based selection
Published libraries
Section titled “Published libraries”- Platform and core: graph BOM, graph core
- Backends: Neo4j, Memgraph, Apache AGE, TinkerPop, FalkorDB
- graph-io: core, CSV, Jackson 2, Jackson 3, GraphML, OkIO
- Frameworks: Spring Boot, Ktor
Examples
Section titled “Examples”- Modeling: code graph, knowledge graph, LinkedIn graph, recommendation
- Risk and operations: fraud detection, IAM access graph, observability graph, security attack path
- Systems: supply chain, data lineage, network topology, Ktor graph