Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

SCHEMABOUND Documentation — Choose Your Path

Different roles need different entry points into this documentation. Select the persona that matches your responsibilities to jump directly to relevant material, or use the full table of contents below for complete coverage.

For Product Managers & Executives

Focus on business outcomes, cost governance models, and strategic adoption decisions. You don’t need to understand implementation details — you need to know what SCHEMABOUND does and why it matters.

  • The Object Agent Mapping Paradigm — How OAM differs from traditional ORMs by mapping agent intent to data operations rather than simply mapping objects to relational rows
  • System Architecture Overview — High-level view of where SCHEMABOUND sits between your application and your data layer
  • AAU Billing Reference — Cost governance model: how Agentic Activity Units quantify governance cost per tool call (Read = 1x, Write = 3x, Governed = 5x)
  • Demo — Executive narrated demo showing SCHEMABOUND in action

Key takeaway: SCHEMABOUND reduces governance costs by providing fine-grained audit trails and policy enforcement without requiring you to rewrite existing code. The Hybrid operating mode lets you integrate legacy databases incrementally while Code-First schemas give you full control over new development.

For Backend & DevSecOps Engineers

Focus on operational configuration, security hardening, deployment procedures, and audit trail verification. You need exact environment variables, dependency ordering, and production-ready patterns.

  • Identity & Security Operations — mTLS setup, LDAP sync, JWT rotation, RBAC mapping, SCIM provisioning, session management, host hardening
  • Runtime Operations — Audit logging configuration, self-healing infrastructure workers, event publishing pipeline
  • Air-Gap Deployment — Production deployment in disconnected environments with hardware provisioning and remote attestation
  • C4 Model Diagrams — Visual models showing how SCHEMABOUND gRPC Server, EventBus, Auto-Rewind workers, and Chain Integrity verification interact

Key takeaway: Every agent action is captured in a tamper-evident SHA-256 hash chain exported via MultiTransportExporter to SIEM platforms. Configure mTLS with schemabound-certgen, rotate JWT secrets without downtime using SCHEMABOUND_JWT_SECRETS, and rely on the self-healing infrastructure workers to maintain deployment integrity automatically.

For Application Developers

Focus on SDK integration, rapid prototyping, component usage, and API reference. You need working code examples, dependency installation commands, and clear method signatures.

  • Tutorials — Rust, Python, .NET, TypeScript quick starts for spinning up your first SCHEMABOUND client
  • How-To Guides — Inject runtime context headers, execute multi-step control plane workflows, manage declarative migrations with sb-migrate
  • API Reference — Generated SDK documentation for all supported languages and protocols

Key takeaway: Install your language-specific SDK (schemabound, schemabound-python, Schemabound.Dotnet, or the TypeScript package), connect to the backend, and start writing queries. The LlmSchema derive macro generates JSON schemas automatically from your Rust structs; use ValidateQueryRequest for validation and ExecuteStepRequest for multi-step workflows.

Full Table of Contents

If you’re exploring SCHEMABOUND broadly or need coverage across all personas, use the complete navigation: