# Send SurrealDB 3 to your agent Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually. ## Fast path - Download the package from Yavira. - Extract it into a folder your agent can access. - Paste one of the prompts below and point your agent at the extracted folder. ## Suggested prompts ### New install ```text I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Then review README.md for any prerequisites, environment setup, or post-install checks. Tell me what you changed and call out any manual steps you could not complete. ``` ### Upgrade existing ```text I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Then review README.md for any prerequisites, environment setup, or post-install checks. Summarize what changed and any follow-up checks I should run. ``` ## Machine-readable fields ```json { "schemaVersion": "1.0", "item": { "slug": "surrealdb", "name": "SurrealDB 3", "source": "tencent", "type": "skill", "category": "开发工具", "sourceUrl": "https://clawhub.ai/24601/surrealdb", "canonicalUrl": "https://clawhub.ai/24601/surrealdb", "targetPlatform": "OpenClaw" }, "install": { "downloadUrl": "/downloads/surrealdb", "sourceDownloadUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=surrealdb", "sourcePlatform": "tencent", "targetPlatform": "OpenClaw", "packageFormat": "ZIP package", "primaryDoc": "SKILL.md", "includedAssets": [ "AGENTS.md", "CHANGELOG.md", "CONTRIBUTING.md", "README.md", "SECURITY.md", "SKILL.md" ], "downloadMode": "redirect", "sourceHealth": { "source": "tencent", "status": "healthy", "reason": "direct_download_ok", "recommendedAction": "download", "checkedAt": "2026-05-07T17:22:31.273Z", "expiresAt": "2026-05-14T17:22:31.273Z", "httpStatus": 200, "finalUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=afrexai-annual-report", "contentType": "application/zip", "probeMethod": "head", "details": { "probeUrl": "https://wry-manatee-359.convex.site/api/v1/download?slug=afrexai-annual-report", "contentDisposition": "attachment; filename=\"afrexai-annual-report-1.0.0.zip\"", "redirectLocation": null, "bodySnippet": null }, "scope": "source", "summary": "Source download looks usable.", "detail": "Yavira can redirect you to the upstream package for this source.", "primaryActionLabel": "Download for OpenClaw", "primaryActionHref": "/downloads/surrealdb" }, "validation": { "installChecklist": [ "Use the Yavira download entry.", "Review SKILL.md after the package is downloaded.", "Confirm the extracted package contains the expected setup assets." ], "postInstallChecks": [ "Confirm the extracted package includes the expected docs or setup files.", "Validate the skill or prompts are available in your target agent workspace.", "Capture any manual follow-up steps the agent could not complete." ] } }, "links": { "detailUrl": "https://openagent3.xyz/skills/surrealdb", "downloadUrl": "https://openagent3.xyz/downloads/surrealdb", "agentUrl": "https://openagent3.xyz/skills/surrealdb/agent", "manifestUrl": "https://openagent3.xyz/skills/surrealdb/agent.json", "briefUrl": "https://openagent3.xyz/skills/surrealdb/agent.md" } } ``` ## Documentation ### SurrealDB 3 Skill Expert-level SurrealDB 3 architecture, development, and operations. Covers SurrealQL, multi-model data modeling, graph traversal, vector search, security, deployment, performance tuning, SDK integration, and the full SurrealDB ecosystem. ### For AI Agents Get a full capabilities manifest, decision trees, and output contracts: uv run {baseDir}/scripts/onboard.py --agent See AGENTS.md for the complete structured briefing. CommandWhat It Doesuv run {baseDir}/scripts/doctor.pyHealth check: verify surreal CLI, connectivity, versionsuv run {baseDir}/scripts/doctor.py --checkQuick pass/fail check (exit code only)uv run {baseDir}/scripts/schema.py introspectDump full schema of a running SurrealDB instanceuv run {baseDir}/scripts/schema.py tablesList all tables with field counts and indexesuv run {baseDir}/scripts/onboard.py --agentJSON capabilities manifest for agent integration ### Prerequisites surreal CLI -- brew install surrealdb/tap/surreal (macOS) or see install docs Python 3.10+ -- Required for skill scripts uv -- brew install uv (macOS) or pip install uv or see uv docs Optional: Docker -- For containerized SurrealDB instances (docker run surrealdb/surrealdb:v3) SDK of choice -- JavaScript, Python, Go, Rust, Java, .NET, C, PHP, or Dart Security note: This skill's documentation references package manager installs (brew, pip, cargo, npm, Docker) as the recommended install method. If you encounter curl | sh examples in the rules files, prefer your OS package manager or download-and-review workflow instead. ### Quick Start Credential warning: Examples below use root/root for local development only. Never use default credentials against production or shared instances. Create scoped, least-privilege users for non-local environments. # Start SurrealDB in-memory for LOCAL DEVELOPMENT ONLY surreal start memory --user root --pass root --bind 127.0.0.1:8000 # Start with persistent RocksDB storage (local dev) surreal start rocksdb://data/mydb.db --user root --pass root # Start with SurrealKV (time-travel queries supported, local dev) surreal start surrealkv://data/mydb --user root --pass root # Connect via CLI REPL (local dev) surreal sql --endpoint http://localhost:8000 --user root --pass root --ns test --db test # Import a SurrealQL file surreal import --endpoint http://localhost:8000 --user root --pass root --ns test --db test schema.surql # Export the database surreal export --endpoint http://localhost:8000 --user root --pass root --ns test --db test backup.surql # Check version surreal version # Run the skill health check uv run {baseDir}/scripts/doctor.py ### Environment Variables VariableDescriptionDefaultSURREAL_ENDPOINTSurrealDB server URLhttp://localhost:8000SURREAL_USERRoot or namespace usernamerootSURREAL_PASSRoot or namespace passwordrootSURREAL_NSDefault namespacetestSURREAL_DBDefault databasetest These map directly to the surreal sql CLI flags (--endpoint, --user, --pass, --ns, --db) and are recognized by official SurrealDB SDKs. ### SurrealQL Mastery Full coverage of the SurrealQL query language: CREATE, SELECT, UPDATE, UPSERT, DELETE, RELATE, INSERT, LIVE SELECT, DEFINE, REMOVE, INFO, subqueries, transactions, futures, and all built-in functions (array, crypto, duration, geo, math, meta, object, parse, rand, string, time, type, vector). See: rules/surrealql.md ### Multi-Model Data Modeling Design schemas that leverage SurrealDB's multi-model capabilities -- document collections, graph edges, relational references, vector embeddings, time-series data, and geospatial coordinates -- all in a single database with a single query language. See: rules/data-modeling.md ### Graph Queries First-class graph traversal without JOINs. RELATE creates typed edges between records. Traverse with -> (outgoing), <- (incoming), and <-> (bidirectional) operators. Filter, aggregate, and recurse at any depth. See: rules/graph-queries.md ### Vector Search Built-in vector similarity search using HNSW and brute-force indexes. Define vector fields, create indexes with configurable distance metrics (cosine, euclidean, manhattan, minkowski), and query with vector::similarity::* functions. Build RAG pipelines and semantic search directly in SurrealQL. See: rules/vector-search.md ### Security and Permissions Row-level security via DEFINE TABLE ... PERMISSIONS, namespace/database/record-level access control, DEFINE ACCESS for JWT/token-based auth, DEFINE USER for system users, and $auth/$session runtime variables for permission predicates. See: rules/security.md ### Deployment and Operations Single-binary deployment, Docker, Kubernetes (Helm charts), storage engine selection (memory, RocksDB, SurrealKV, TiKV for distributed), backup/restore, monitoring, and production hardening. See: rules/deployment.md ### Performance Tuning Index strategies (unique, search, vector HNSW, MTree), query optimization with EXPLAIN, connection pooling, storage engine trade-offs, batch operations, and resource limits. See: rules/performance.md ### SDK Integration Official SDKs for JavaScript/TypeScript (Node.js, Deno, Bun, browser), Python, Go, Rust, Java, .NET, C, PHP, and Dart. Connection protocols (HTTP, WebSocket), authentication flows, live query subscriptions, and typed record handling. See: rules/sdks.md ### Surrealism WASM Extensions New in SurrealDB 3: extend the database with custom functions, analyzers, and logic written in Rust and compiled to WASM. Define, deploy, and manage Surrealism modules. See: rules/surrealism.md ### Ecosystem Tools Surrealist -- Official IDE and GUI for SurrealDB (schema designer, query editor, graph visualizer) Surreal-Sync -- Change Data Capture (CDC) for migrations from other databases SurrealFS -- AI agent filesystem built on SurrealDB SurrealML -- Machine learning model management and inference within SurrealDB See: rules/surrealist.md, rules/surreal-sync.md, rules/surrealfs.md ### Doctor / Health Check # Full diagnostic (Rich output on stderr, JSON on stdout) uv run {baseDir}/scripts/doctor.py # Quick check (exit code 0 = healthy, 1 = issues found) uv run {baseDir}/scripts/doctor.py --check # Check a specific endpoint uv run {baseDir}/scripts/doctor.py --endpoint http://my-server:8000 The doctor script verifies: surreal CLI installed and on PATH, server reachable, authentication succeeds, namespace and database exist, version compatibility, and storage engine status. ### Schema Introspection # Full schema dump (all tables, fields, indexes, events, accesses) uv run {baseDir}/scripts/schema.py introspect # List tables with summary uv run {baseDir}/scripts/schema.py tables # Inspect a specific table uv run {baseDir}/scripts/schema.py table # Export schema as SurrealQL (reproducible DEFINE statements) uv run {baseDir}/scripts/schema.py export --format surql # Export schema as JSON uv run {baseDir}/scripts/schema.py export --format json Introspection uses INFO FOR DB, INFO FOR TABLE, and INFO FOR NS to reconstruct the full schema. ### Rules Reference Rule FileCoveragerules/surrealql.mdSurrealQL syntax, statements, functions, operators, idiomsrules/data-modeling.mdSchema design, record IDs, field types, relations, normalizationrules/graph-queries.mdRELATE, graph traversal operators, path expressions, recursive queriesrules/vector-search.mdVector fields, HNSW/brute-force indexes, similarity functions, RAG patternsrules/security.mdPermissions, access control, authentication, JWT, row-level securityrules/deployment.mdInstallation, storage engines, Docker, Kubernetes, production configrules/performance.mdIndexes, EXPLAIN, query optimization, batch ops, resource tuningrules/sdks.mdJavaScript, Python, Go, Rust SDK usage, connection patterns, live queriesrules/surrealism.mdWASM extensions, custom functions, Surrealism module authoringrules/surrealist.mdSurrealist IDE/GUI usage, schema designer, query editorrules/surreal-sync.mdCDC migration tool, source/target connectors, migration workflowsrules/surrealfs.mdAI agent filesystem, file storage, metadata, retrieval patterns ### Workflow Examples All workflow examples use root/root for local development only. For production, use DEFINE USER with scoped, least-privilege credentials. ### New Project Setup # 1. Verify environment uv run {baseDir}/scripts/doctor.py # 2. Start SurrealDB surreal start rocksdb://data/myproject.db --user root --pass root # 3. Design schema (use rules/data-modeling.md for guidance) # 4. Import initial schema surreal import --endpoint http://localhost:8000 --user root --pass root \\ --ns myapp --db production schema.surql # 5. Introspect to verify uv run {baseDir}/scripts/schema.py introspect ### Migration from SurrealDB v2 # 1. Export v2 data surreal export --endpoint http://old-server:8000 --user root --pass root \\ --ns myapp --db production v2-backup.surql # 2. Review breaking changes (see rules/surrealql.md v2->v3 migration section) # Key changes: range syntax 1..4 is now exclusive of end, new WASM extension system # 3. Import into v3 surreal import --endpoint http://localhost:8000 --user root --pass root \\ --ns myapp --db production v2-backup.surql # 4. Verify schema uv run {baseDir}/scripts/schema.py introspect ### Data Modeling for a New Domain # 1. Read rules/data-modeling.md for schema design patterns # 2. Read rules/graph-queries.md if your domain has relationships # 3. Read rules/vector-search.md if you need semantic search # 4. Draft schema.surql with DEFINE TABLE, DEFINE FIELD, DEFINE INDEX # 5. Import and test surreal import --endpoint http://localhost:8000 --user root --pass root \\ --ns dev --db test schema.surql uv run {baseDir}/scripts/schema.py introspect ### Deploying to Production # 1. Read rules/deployment.md for storage engine selection and hardening # 2. Read rules/security.md for access control setup # 3. Read rules/performance.md for index strategy # 4. Run doctor against production endpoint uv run {baseDir}/scripts/doctor.py --endpoint https://prod-surreal:8000 # 5. Verify schema matches expectations uv run {baseDir}/scripts/schema.py introspect --endpoint https://prod-surreal:8000 ### Upstream Source Check # Check if upstream SurrealDB repos have changed since this skill was built uv run {baseDir}/scripts/check_upstream.py # JSON-only output for agents uv run {baseDir}/scripts/check_upstream.py --json # Only show repos that have new commits uv run {baseDir}/scripts/check_upstream.py --stale Compares current HEAD SHAs and release tags of all tracked repos against the baselines in SOURCES.json. Use this to plan incremental skill updates. ### Source Provenance This skill was built on 2026-02-19 from these upstream sources: RepositoryReleaseSnapshot Datesurrealdb/surrealdbv3.0.02026-02-19surrealdb/surrealistv3.7.22026-02-21surrealdb/surrealdb.jsv1.3.22026-02-20surrealdb/surrealdb.js (v2 beta)v2.0.0-beta.12026-02-20surrealdb/surrealdb.pyv1.0.82026-02-03surrealdb/surrealdb.gov1.3.02026-02-12surrealdb/surreal-syncv0.3.42026-02-12surrealdb/surrealfs--2026-01-29 Documentation: surrealdb.com/docs snapshot 2026-02-22. Machine-readable provenance: SOURCES.json. ### Output Convention All Python scripts in this skill follow a dual-output pattern: stderr: Rich-formatted human-readable output (tables, panels, status indicators) stdout: Machine-readable JSON for programmatic consumption by AI agents This means 2>/dev/null hides the human output, and piping stdout gives clean JSON for downstream processing. ## Trust - Source: tencent - Verification: Indexed source record - Publisher: 24601 - Version: 1.2.1 ## Source health - Status: healthy - Source download looks usable. - Yavira can redirect you to the upstream package for this source. - Health scope: source - Reason: direct_download_ok - Checked at: 2026-05-07T17:22:31.273Z - Expires at: 2026-05-14T17:22:31.273Z - Recommended action: Download for OpenClaw ## Links - [Detail page](https://openagent3.xyz/skills/surrealdb) - [Send to Agent page](https://openagent3.xyz/skills/surrealdb/agent) - [JSON manifest](https://openagent3.xyz/skills/surrealdb/agent.json) - [Markdown brief](https://openagent3.xyz/skills/surrealdb/agent.md) - [Download page](https://openagent3.xyz/downloads/surrealdb)