Expand description
IronGraph SDK for embedded databases and remote API/Bolt connections.
Documents, vector search, graph algorithms, projects, and administration use the same
Query interface. Synchronous methods block the caller; asynchronous embedded methods
run native work on Tokio’s blocking pool and cancel active operations when dropped.
Structs§
- Bookmark
- Position of an applied database write.
- Embedded
Database - Database with synchronous and Tokio asynchronous access to the same native owner. Only one embedded instance can be active in a process. Close explicitly to observe shutdown errors.
- Embedded
Options - Options for one database process. Automatic embeddings install and warm the local model.
- Error
- Structured native or SDK error. Database error codes and retry information are preserved.
- Mutual
Tls - PEM paths for mutual TLS. Credentials are kept outside graph data.
- Operation
Options - Query
- One Cypher request covering the complete database query and administration surface.
- Query
Result - Lossless Query API result. Values retain their protocol type tags; 64-bit graph integers
remain decimal strings, and nodes, relationships, paths, vectors, and temporal values retain
their complete structure. Inspect
rows[row][column]withserde_json. - Remote
Client - Remote Query API or Bolt connection. Plain connections are restricted to loopback addresses;
remote connections require mutual TLS. Bolt requests require
Query::with_project. - Runtime
Status - Stream
Acknowledgement - Stream
Append - Stream
Fetch - Stream
Page - Stream
Payload - Stream
Record
Enums§
- Commit
Acknowledgement - Acknowledgement for a write applied by this single-node database.
- Embedding
Device - Independently selected text inference device.
- Embedding
Policy - Execution
Device