368 lines
17 KiB
HTML
368 lines
17 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>0004: SurrealDB Database - VAPORA Platform Documentation</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="Comprehensive documentation for VAPORA, an intelligent development orchestration platform built entirely in Rust.">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="icon" href="../favicon.svg">
|
|
<link rel="shortcut icon" href="../favicon.png">
|
|
<link rel="stylesheet" href="../css/variables.css">
|
|
<link rel="stylesheet" href="../css/general.css">
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
|
|
<!-- Provide site root and default themes to javascript -->
|
|
<script>
|
|
const path_to_root = "../";
|
|
const default_light_theme = "light";
|
|
const default_dark_theme = "dark";
|
|
</script>
|
|
<!-- Start loading toc.js asap -->
|
|
<script src="../toc.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="mdbook-help-container">
|
|
<div id="mdbook-help-popup">
|
|
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
|
<div>
|
|
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
|
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
|
<p>Press <kbd>?</kbd> to show this help</p>
|
|
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="body-container">
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
let theme = localStorage.getItem('mdbook-theme');
|
|
let sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
|
let theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
const html = document.documentElement;
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add("js");
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
let sidebar = null;
|
|
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<!-- populated by js -->
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
|
<noscript>
|
|
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
|
</noscript>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">VAPORA Platform Documentation</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
<a href="https://github.com/vapora-platform/vapora" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
<a href="https://github.com/vapora-platform/vapora/edit/main/docs/src/../adrs/0004-surrealdb-database.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="adr-004-surrealdb-como-database-Único"><a class="header" href="#adr-004-surrealdb-como-database-Único">ADR-004: SurrealDB como Database Único</a></h1>
|
|
<p><strong>Status</strong>: Accepted | Implemented
|
|
<strong>Date</strong>: 2024-11-01
|
|
<strong>Deciders</strong>: Backend Architecture Team
|
|
<strong>Technical Story</strong>: Selecting unified multi-model database for relational, graph, and document workloads</p>
|
|
<hr />
|
|
<h2 id="decision"><a class="header" href="#decision">Decision</a></h2>
|
|
<p>Usar <strong>SurrealDB 2.3</strong> como base de datos única (no PostgreSQL + Neo4j, no MongoDB puro).</p>
|
|
<hr />
|
|
<h2 id="rationale"><a class="header" href="#rationale">Rationale</a></h2>
|
|
<ol>
|
|
<li><strong>Multi-Model en una sola DB</strong>: Relational (SQL), graph (queries), document (JSON) sin múltiples conexiones</li>
|
|
<li><strong>Multi-Tenancy Nativa</strong>: SurrealDB scopes permiten aislamiento a nivel de database sin lógica en aplicación</li>
|
|
<li><strong>WebSocket Connection</strong>: Soporte nativo de conexiones bidireccionales (vs REST)</li>
|
|
<li><strong>SurrealQL</strong>: Sintaxis SQL-like + graph traversal en una sola query language</li>
|
|
<li><strong>VAPORA Requirements</strong>: Almacena projects (relational), agent relationships (graph), execution history (document)</li>
|
|
</ol>
|
|
<hr />
|
|
<h2 id="alternatives-considered"><a class="header" href="#alternatives-considered">Alternatives Considered</a></h2>
|
|
<h3 id="-postgresql--neo4j-two-database-approach"><a class="header" href="#-postgresql--neo4j-two-database-approach">❌ PostgreSQL + Neo4j (Two Database Approach)</a></h3>
|
|
<ul>
|
|
<li><strong>Pros</strong>: Maduro, comunidad grande, especializados</li>
|
|
<li><strong>Cons</strong>: Sincronización entre dos DBs, dos conexiones, transacciones distribuidas complejas</li>
|
|
</ul>
|
|
<h3 id="-mongodb-puro-document-only"><a class="header" href="#-mongodb-puro-document-only">❌ MongoDB Puro (Document Only)</a></h3>
|
|
<ul>
|
|
<li><strong>Pros</strong>: Flexible, escalable</li>
|
|
<li><strong>Cons</strong>: Sin soporte graph nativo, requiere aplicación para traversal, sin SQL</li>
|
|
</ul>
|
|
<h3 id="-surrealdb-chosen"><a class="header" href="#-surrealdb-chosen">✅ SurrealDB (CHOSEN)</a></h3>
|
|
<ul>
|
|
<li>Unifica relational + graph + document</li>
|
|
<li>Multi-tenancy built-in</li>
|
|
<li>WebSocket para real-time</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="trade-offs"><a class="header" href="#trade-offs">Trade-offs</a></h2>
|
|
<p><strong>Pros</strong>:</p>
|
|
<ul>
|
|
<li>✅ Una sola DB para todos los modelos de datos</li>
|
|
<li>✅ Scopes para isolamiento de tenants (no en aplicación)</li>
|
|
<li>✅ Transactions ACID</li>
|
|
<li>✅ SurrealQL es SQL + graph en una query</li>
|
|
<li>✅ WebSocket bidireccional</li>
|
|
</ul>
|
|
<p><strong>Cons</strong>:</p>
|
|
<ul>
|
|
<li>⚠️ Ecosistema más pequeño que PostgreSQL</li>
|
|
<li>⚠️ Drivers/herramientas menos maduras</li>
|
|
<li>⚠️ Soporte de clusters más limitado (vs Postgres)</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="implementation"><a class="header" href="#implementation">Implementation</a></h2>
|
|
<p><strong>Database Connection</strong>:</p>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span><span class="boring">fn main() {
|
|
</span>// crates/vapora-backend/src/main.rs:48-59
|
|
let db = surrealdb::Surreal::new::<surrealdb::engine::remote::ws::Ws>(
|
|
&config.database.url
|
|
).await?;
|
|
|
|
db.signin(surrealdb::opt::auth::Root {
|
|
username: "root",
|
|
password: "root",
|
|
}).await?;
|
|
|
|
db.use_ns("vapora").use_db("main").await?;
|
|
<span class="boring">}</span></code></pre></pre>
|
|
<p><strong>Scope-Based Multi-Tenancy</strong>:</p>
|
|
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
|
|
</span><span class="boring">fn main() {
|
|
</span>// All queries use scope for tenant isolation
|
|
db.query("SELECT * FROM projects WHERE tenant_id = $tenant_id")
|
|
.bind(("tenant_id", tenant_id))
|
|
.await?
|
|
<span class="boring">}</span></code></pre></pre>
|
|
<p><strong>Key Files</strong>:</p>
|
|
<ul>
|
|
<li><code>/crates/vapora-backend/src/main.rs:45-59</code> (connection setup)</li>
|
|
<li><code>/crates/vapora-backend/src/services/</code> (query implementations)</li>
|
|
<li><code>/crates/vapora-shared/src/models.rs</code> (Project, Task, Agent models with tenant_id)</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="verification"><a class="header" href="#verification">Verification</a></h2>
|
|
<pre><code class="language-bash"># Connect to SurrealDB
|
|
surreal sql --conn ws://localhost:8000 --user root --pass root
|
|
|
|
# Verify namespace and database exist
|
|
USE ns vapora db main;
|
|
INFO FOR DATABASE;
|
|
|
|
# Test multi-tenant query
|
|
SELECT * FROM projects WHERE tenant_id = 'workspace:123';
|
|
|
|
# Test graph traversal
|
|
SELECT
|
|
*,
|
|
->assigned_to->agents AS assigned_agents
|
|
FROM tasks
|
|
WHERE project_id = 'project:123';
|
|
|
|
# Run backend tests with SurrealDB
|
|
cargo test -p vapora-backend -- --nocapture
|
|
</code></pre>
|
|
<p><strong>Expected Output</strong>:</p>
|
|
<ul>
|
|
<li>SurrealDB connects via WebSocket</li>
|
|
<li>Projects table exists and is queryable</li>
|
|
<li>Graph relationships (->assigned_to) resolve</li>
|
|
<li>Multi-tenant queries filter correctly</li>
|
|
<li>79+ backend tests pass</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="consequences"><a class="header" href="#consequences">Consequences</a></h2>
|
|
<h3 id="data-model-changes"><a class="header" href="#data-model-changes">Data Model Changes</a></h3>
|
|
<ul>
|
|
<li>All tables must include <code>tenant_id</code> field for scoping</li>
|
|
<li>Relations use SurrealDB's <code>-></code> edge syntax for graph queries</li>
|
|
<li>No foreign key constraints (SurrealDB uses references instead)</li>
|
|
</ul>
|
|
<h3 id="query-patterns"><a class="header" href="#query-patterns">Query Patterns</a></h3>
|
|
<ul>
|
|
<li>Services layer queries must include tenant_id filter (defense-in-depth)</li>
|
|
<li>SurrealQL instead of raw SQL learning curve for team</li>
|
|
<li>Graph traversal enables efficient knowledge graph queries</li>
|
|
</ul>
|
|
<h3 id="scaling-considerations"><a class="header" href="#scaling-considerations">Scaling Considerations</a></h3>
|
|
<ul>
|
|
<li>Horizontal scaling requires clustering (vs Postgres replication)</li>
|
|
<li>Backup/recovery different from traditional databases (see ADR-020)</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="references"><a class="header" href="#references">References</a></h2>
|
|
<ul>
|
|
<li><a href="https://surrealdb.com/docs/surrealql/queries">SurrealDB Documentation</a></li>
|
|
<li><code>/crates/vapora-backend/src/services/</code> (query patterns)</li>
|
|
<li><code>/crates/vapora-shared/src/models.rs</code> (model definitions with tenant_id)</li>
|
|
<li>ADR-025 (Multi-Tenancy with Scopes)</li>
|
|
</ul>
|
|
<hr />
|
|
<p><strong>Related ADRs</strong>: ADR-001 (Workspace), ADR-025 (Multi-Tenancy)</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../../adrs/0003-leptos-frontend.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../../adrs/0005-nats-jetstream.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="../../adrs/0003-leptos-frontend.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../../adrs/0005-nats-jetstream.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="../elasticlunr.min.js"></script>
|
|
<script src="../mark.min.js"></script>
|
|
<script src="../searcher.js"></script>
|
|
|
|
<script src="../clipboard.min.js"></script>
|
|
<script src="../highlight.js"></script>
|
|
<script src="../book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|