Skip to content

Commit a56616b

Browse files
author
Documenter.jl
committed
build based on 700c03c 
1 parent 7295599 commit a56616b

14 files changed

Lines changed: 167 additions & 36 deletions

File tree

‎dev/.documenter-siteinfo.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-05-25T05:08:04","julia_version":"1.12.6"}}
1+
{"documenter":{"documenter_version":"1.17.0","generation_timestamp":"2026-05-25T05:30:30","julia_version":"1.12.6"}}

‎dev/api/index.html‎

Lines changed: 30 additions & 32 deletions
Large diffs are not rendered by default.

‎dev/auth/index.html‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Authentication · SurrealDB.jl</title><meta name="title" content="Authentication · SurrealDB.jl"/><meta property="og:title" content="Authentication · SurrealDB.jl"/><meta property="twitter:title" content="Authentication · SurrealDB.jl"/><meta name="description" content="Documentation for SurrealDB.jl."/><meta property="og:description" content="Documentation for SurrealDB.jl."/><meta property="twitter:description" content="Documentation for SurrealDB.jl."/><meta property="og:url" content="https://danvinci.github.io/surrealdb/auth/"/><meta property="twitter:url" content="https://danvinci.github.io/surrealdb/auth/"/><link rel="canonical" href="https://danvinci.github.io/surrealdb/auth/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">SurrealDB.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><span class="tocitem">Guide</span><ul><li><a class="tocitem" href="../records/">Record IDs</a></li><li><a class="tocitem" href="../wire/">Wire format</a></li><li class="is-active"><a class="tocitem" href>Authentication</a><ul class="internal"><li><a class="tocitem" href="#State-replay-on-reconnect"><span>State replay on reconnect</span></a></li><li><a class="tocitem" href="#Refresh-tokens"><span>Refresh tokens</span></a></li></ul></li><li><a class="tocitem" href="../live/">Live queries</a></li><li><a class="tocitem" href="../transactions/">Transactions</a></li><li><a class="tocitem" href="../reconnect/">Reconnect</a></li><li><a class="tocitem" href="../errors/">Errors</a></li><li><a class="tocitem" href="../integrations/">Integrations</a></li><li><a class="tocitem" href="../debugging/">Debugging</a></li></ul></li><li><a class="tocitem" href="../api/">API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Guide</a></li><li class="is-active"><a href>Authentication</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Authentication</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/danvinci/surrealdb" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/danvinci/surrealdb/blob/main/docs/src/auth.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Authentication"><a class="docs-heading-anchor" href="#Authentication">Authentication</a><a id="Authentication-1"></a><a class="docs-heading-anchor-permalink" href="#Authentication" title="Permalink"></a></h1><p>Four signin variants cover the SurrealDB auth surface:</p><pre><code class="language-julia hljs">SurrealDB.signin!(db, SurrealDB.RootAuth(&quot;root&quot;, &quot;root&quot;))
3+
4+
SurrealDB.signin!(db, SurrealDB.NamespaceAuth(&quot;ns&quot;, &quot;user&quot;, &quot;pass&quot;))
5+
6+
SurrealDB.signin!(db, SurrealDB.ScopedAuth(&quot;ns&quot;, &quot;db&quot;, &quot;account&quot;,
7+
Dict(&quot;email&quot; =&gt; &quot;a@b.c&quot;, &quot;pass&quot; =&gt; &quot;x&quot;)))
8+
9+
SurrealDB.authenticate!(db, jwt_token)
10+
SurrealDB.invalidate!(db)</code></pre><h2 id="State-replay-on-reconnect"><a class="docs-heading-anchor" href="#State-replay-on-reconnect">State replay on reconnect</a><a id="State-replay-on-reconnect-1"></a><a class="docs-heading-anchor-permalink" href="#State-replay-on-reconnect" title="Permalink"></a></h2><p>If the WebSocket drops mid-session, the SDK replays the session state on reconnect before flipping status back to <code>STATUS_CONNECTED</code>:</p><ol><li><code>use ns/db</code></li><li><code>authenticate(token)</code></li><li>Every <code>let!</code> session variable</li><li>Every live subscription (re-issues <code>LIVE SELECT</code>, overwrites <code>sub.query_id</code>)</li></ol><p>Observers never see a half-restored session.</p><h2 id="Refresh-tokens"><a class="docs-heading-anchor" href="#Refresh-tokens">Refresh tokens</a><a id="Refresh-tokens-1"></a><a class="docs-heading-anchor-permalink" href="#Refresh-tokens" title="Permalink"></a></h2><p>Scoped access methods that issue refresh tokens (<code>DEFINE ACCESS ... WITH REFRESH</code>) cause <code>signin!</code>/<code>signup!</code> to store both the access JWT and the refresh token as a <a href="../api/#SurrealDB.Tokens"><code>Tokens</code></a> value. A background timer exchanges the refresh token for a new pair <code>refresh_lead_time</code> seconds before the access JWT expires:</p><pre><code class="language-julia hljs">db = SurrealDB.connect(&quot;ws://localhost:8000&quot;;
11+
refresh_lead_time = 30.0,
12+
auth = SurrealDB.ScopedAuth(&quot;ns&quot;, &quot;db&quot;, &quot;account&quot;,
13+
Dict(&quot;email&quot; =&gt; &quot;a@b.c&quot;, &quot;pass&quot; =&gt; &quot;x&quot;)))
14+
15+
SurrealDB.tokens(db) # Tokens(access=&quot;eyJ…&quot;, refresh=&quot;abc…&quot;)
16+
SurrealDB.refresh!(db) # manual rotation; returns the new access JWT</code></pre><p><a href="../api/#SurrealDB.refresh!"><code>refresh!</code></a> throws <code>NotAllowedError</code> when no refresh token is available. The proactive timer skips while a reconnect is in flight; the reconnect path re-schedules.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../wire/">« Wire format</a><a class="docs-footer-nextpage" href="../live/">Live queries »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Monday 25 May 2026 05:30">Monday 25 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

‎dev/debugging/index.html‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<!DOCTYPE html>
2+
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Debugging · SurrealDB.jl</title><meta name="title" content="Debugging · SurrealDB.jl"/><meta property="og:title" content="Debugging · SurrealDB.jl"/><meta property="twitter:title" content="Debugging · SurrealDB.jl"/><meta name="description" content="Documentation for SurrealDB.jl."/><meta property="og:description" content="Documentation for SurrealDB.jl."/><meta property="twitter:description" content="Documentation for SurrealDB.jl."/><meta property="og:url" content="https://danvinci.github.io/surrealdb/debugging/"/><meta property="twitter:url" content="https://danvinci.github.io/surrealdb/debugging/"/><link rel="canonical" href="https://danvinci.github.io/surrealdb/debugging/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">SurrealDB.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><span class="tocitem">Guide</span><ul><li><a class="tocitem" href="../records/">Record IDs</a></li><li><a class="tocitem" href="../wire/">Wire format</a></li><li><a class="tocitem" href="../auth/">Authentication</a></li><li><a class="tocitem" href="../live/">Live queries</a></li><li><a class="tocitem" href="../transactions/">Transactions</a></li><li><a class="tocitem" href="../reconnect/">Reconnect</a></li><li><a class="tocitem" href="../errors/">Errors</a></li><li><a class="tocitem" href="../integrations/">Integrations</a></li><li class="is-active"><a class="tocitem" href>Debugging</a><ul class="internal"><li><a class="tocitem" href="#Lifecycle-events"><span>Lifecycle events</span></a></li><li><a class="tocitem" href="#Embedded-mode"><span>Embedded mode</span></a></li></ul></li></ul></li><li><a class="tocitem" href="../api/">API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Guide</a></li><li class="is-active"><a href>Debugging</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Debugging</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/danvinci/surrealdb" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/danvinci/surrealdb/blob/main/docs/src/debugging.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Debugging"><a class="docs-heading-anchor" href="#Debugging">Debugging</a><a id="Debugging-1"></a><a class="docs-heading-anchor-permalink" href="#Debugging" title="Permalink"></a></h1><p>RPC traces emit on Julia&#39;s <code>@debug</code> channel. Enable with <code>JULIA_DEBUG=SurrealDB</code>:</p><pre><code class="nohighlight hljs">┌ Debug: SurrealDB ws RPC → rid=2 method=use params=Any[&quot;test&quot;, &quot;test&quot;]
3+
┌ Debug: SurrealDB ws RPC ← rid=2 has_error=false</code></pre><p>Traces cover both WebSocket and HTTP transports.</p><h2 id="Lifecycle-events"><a class="docs-heading-anchor" href="#Lifecycle-events">Lifecycle events</a><a id="Lifecycle-events-1"></a><a class="docs-heading-anchor-permalink" href="#Lifecycle-events" title="Permalink"></a></h2><p>For connection-lifecycle observability without the <code>@debug</code> flood, subscribe to lifecycle events instead — see <a href="../reconnect/">Reconnect and lifecycle</a>.</p><h2 id="Embedded-mode"><a class="docs-heading-anchor" href="#Embedded-mode">Embedded mode</a><a id="Embedded-mode-1"></a><a class="docs-heading-anchor-permalink" href="#Embedded-mode" title="Permalink"></a></h2><p>The embedded backend wraps <code>libsurreal</code> via FFI. Errors surface as <a href="../api/#SurrealDB.EmbeddedFFIError"><code>EmbeddedFFIError</code></a> with <code>.op</code> (the failing FFI call) and <code>.message</code> (the underlying error).</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../integrations/">« Integrations</a><a class="docs-footer-nextpage" href="../api/">API Reference »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.17.0 on <span class="colophon-date" title="Monday 25 May 2026 05:30">Monday 25 May 2026</span>. Using Julia version 1.12.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)