inferadb 0.1.5

Official Rust SDK for InferaDB
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

# InferaDB Rust SDK Documentation

Supplementary documentation for the InferaDB Rust SDK. For the main README and quickstart, see the [project root](../README.md).

## Getting Started

| Guide                                                  | Description                                            |
| ------------------------------------------------------ | ------------------------------------------------------ |
| [Installation](guides/installation.md)                 | Feature flags, optimized builds, TLS options, MSRV     |
| [Authentication](guides/authentication.md)             | Client credentials, bearer tokens, key management      |
| [Authorization API](guides/authorization-api.md)       | Permission checks, relationships, lookups, watch       |
| [Integration Patterns](guides/integration-patterns.md) | Framework integration (Axum, Actix-web, GraphQL, gRPC) |
| [Error Handling](guides/errors.md)                     | Error types, retries, graceful degradation             |
| [Testing](guides/testing.md)                           | MockClient, InMemoryClient, TestVault                  |

## Schema & Design

| Guide                                                        | Description                                    |
| ------------------------------------------------------------ | ---------------------------------------------- |
| [Schema Design Patterns](guides/schema-design.md)            | Role hierarchies, resource hierarchies, groups |
| [Authorization Scenarios](guides/authorization-scenarios.md) | Multi-tenant SaaS, document sharing, API keys  |
| [Schema Versioning](guides/schema-versioning.md)             | Safe schema updates, migrations, rollback      |

## Core Concepts

| Guide                                        | Description                                  |
| -------------------------------------------- | -------------------------------------------- |
| [Consistency & Watch](guides/consistency.md) | Consistency tokens, real-time change streams |
| [Caching](guides/caching.md)                 | Cache configuration, TTL, invalidation       |

## Management

| Guide                                   | Description                                        |
| --------------------------------------- | -------------------------------------------------- |
| [Management API](guides/management-api.md) | Organizations, vaults, schemas, members, audit     |
| [Advanced Features](guides/advanced.md) | Simulation, explain, export/import, type-safe APIs |

## Production

| Guide                                                  | Description                          |
| ------------------------------------------------------ | ------------------------------------ |
| [Observability](guides/observability.md)               | Tracing, metrics, OpenTelemetry      |
| [Performance Tuning](guides/performance-tuning.md)     | Connection pools, batching, latency  |
| [Production Checklist](guides/production-checklist.md) | Pre-deployment verification          |
| [Debugging Authorization](guides/debugging.md)         | Explain API, traces, troubleshooting |

## Reference

| Document                              | Description                 |
| ------------------------------------- | --------------------------- |
| [Troubleshooting](troubleshooting.md) | Common issues and solutions |

## Internal

| Document                                                 | Description                                    |
| -------------------------------------------------------- | ---------------------------------------------- |
| [SDK Development](internal/SDK_DEVELOPMENT.md)           | Complete API design document (source of truth) |
| [Agentic Development](internal/AGENTIC_DEVELOPMENT.md)   | Token-efficient AI agent reference             |
| [Competitive Analysis](internal/competitive-analysis.md) | SDK comparison with SpiceDB, OpenFGA, Oso      |

## Quick Links

- **[README.md](../README.md)** - Quickstart and installation
- **[CHANGELOG.md](../CHANGELOG.md)** - Version history