interstellar 0.2.0

A high-performance graph database with Gremlin-style traversals and GQL query language
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

# Interstellar Documentation

Welcome to the Interstellar documentation. Interstellar is a high-performance Rust graph database with dual query APIs: Gremlin-style fluent traversals and GQL (Graph Query Language).

## Getting Started

New to Interstellar? Start here:

- [Installation](getting-started/installation.md) - Add Interstellar to your project
- [Quick Start](getting-started/quick-start.md) - Create your first graph and run queries
- [Examples](getting-started/examples.md) - Walkthrough of included examples

## API Reference

Detailed API documentation for all query interfaces:

- [Gremlin API](api/gremlin.md) - Fluent traversal API reference
- [GQL API](api/gql.md) - Graph Query Language reference
- [Predicates](api/predicates.md) - Predicate functions (`eq`, `gt`, `within`, etc.)

## Concepts

Understand how Interstellar works:

- [Architecture](concepts/architecture.md) - High-level system design
- [Storage Backends](concepts/storage-backends.md) - InMemory vs MmapGraph
- [Traversal Model](concepts/traversal-model.md) - How traversals execute
- [Concurrency](concepts/concurrency.md) - Thread safety and snapshots

## Guides

Practical guides for common tasks:

- [Graph Modeling](guides/graph-modeling.md) - Schema design best practices
- [Querying](guides/querying.md) - Query patterns and techniques
- [Mutations](guides/mutations.md) - Adding, updating, and deleting data
- [Full-Text Search](guides/full-text-search.md) - Tantivy-backed text indexes (`full-text` feature)
- [Algorithms](guides/algorithms.md) - BFS, DFS, Dijkstra, A*, k-shortest paths, and more
- [Geospatial](guides/geospatial.md) - Point/Polygon values, R-tree index, spatial queries
- [Performance](guides/performance.md) - Optimization and tuning
- [Testing](guides/testing.md) - Testing graph-based code

## Reference

Detailed reference material:

- [Value Types](reference/value-types.md) - The `Value` enum and type system
- [Error Handling](reference/error-handling.md) - Error types and patterns
- [Feature Flags](reference/feature-flags.md) - Cargo features explained
- [Glossary](reference/glossary.md) - Terminology and definitions

---

## Quick Links

| Task | Go To |
|------|-------|
| Add Interstellar to my project | [Installation](getting-started/installation.md) |
| Write my first query | [Quick Start](getting-started/quick-start.md) |
| Query with Gremlin syntax | [Gremlin API](api/gremlin.md) |
| Query with SQL-like syntax | [GQL API](api/gql.md) |
| Use persistent storage | [Storage Backends](concepts/storage-backends.md) |
| Improve query performance | [Performance Guide](guides/performance.md) |
| Add full-text search | [Full-Text Search](guides/full-text-search.md) |
| Run graph algorithms | [Algorithms Guide](guides/algorithms.md) |
| Use geospatial queries | [Geospatial Guide](guides/geospatial.md) |

---

## Getting Help

- [GitHub Issues](https://github.com/your-org/interstellar/issues) - Report bugs or request features
- [Examples Directory](../examples/) - Runnable example programs

## Internal Documentation

For contributors and maintainers:

- `guiding-documents/` - Design documents for future features
- `specs/` - Implementation specifications
- `AGENTS.md` - Guidelines for AI coding agents