surrealdb

Interact with SurrealDB using SurrealQL for multi-model data operations.

34|2|Updated Feb 20, 2026

Search Tags:#performance #deployment #security #database #multi-model #vector search #surrealdb #surrealql

Ready to run

npx skills add https://github.com/24601/surreal-skills --skill surrealdb-24601

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: surrealdb
Source: https://github.com/24601/surreal-skills/tree/main
Command: npx skills add https://github.com/24601/surreal-skills --skill surrealdb-24601

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires surrealdb, surrealdb.js, surrealdb.py, surrealdb.go, surrealdb.net, surrealdb.php, surrealdb.c, surrealdb.swift, surrealdb.kotlin, surrealdb.rb, surrealdb/setup-surreal@v2, surrealdb/surrealql-language-server, surrealdb/surrealql-tree-sitter, surrealdb/codemirror, langchain-surrealdb, surrealdb/n8n-nodes-surrealdb, surrealdb/agent-skills, surrealdb/surreal-sync, surrealdb/surrealfs, surrealdb/surrealkit, surrealdb/surrealmcp, surrealdb/surrealml, surrealdb/surrealism, surrealdb/surrealql-language-server, surrealdb/surrealql-tree-sitter, surrealdb/codemirror, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This skill provides a comprehensive guide for using SurrealDB, enabling AI coding agents to efficiently interact with the database and perform a wide range of tasks.

Core Features & Use Cases

SurrealQL Mastery: Offers a complete language reference, including statements, functions, operators, and idioms.
Multi-Model Data Modeling: Covers document, graph, vector, relational, time-series, and geospatial patterns in a single schema.
Graph Queries: Supports edge creation and traversal without JOINs.
Vector Search: Includes HNSW and DiskANN indexes, similarity functions, and RAG pipeline patterns.
Security: Offers row-level permissions, JWT auth, and namespace/database/record-level access control.
Deployment: Provides guidance on storage engine selection, Docker, Kubernetes, and production hardening.
Performance: Offers index strategies, EXPLAIN analysis, batch operations, and connection pooling.
SDK Integrations: Includes SDK integrations for JavaScript/TypeScript, Python, Go, Rust, Java, Kotlin, .NET, C, PHP, Swift, and Ruby.
WASM Extensions: Covers Surrealism WASM extension system for custom functions and analyzers.
SurrealML: Provides coverage of the .surml artifact format and supported pip extras.
SurrealMCP: Explains the Model Context Protocol server for AI agents.
Editor Tooling: Points to first-party and community editor extensions.
LangChain Integration: Includes integration with the LangChain Python library.
Ecosystem Integrations: Tracks ecosystem integrations like n8n, CodeMirror, and SurrealDB Agent Skills.
Health Checks and Introspection: Offers tools for verifying environment and checking database health.
Universal Agent Support: Works with 30+ AI coding agents via skills.sh.

Quick Start

Run the doctor.py script to verify your SurrealDB environment and ensure everything is in place for development or production use.

Frequently Asked Questions about surrealdb

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I perform vector search and build RAG pipelines in SurrealDB?▼

SurrealDB vector search supports HNSW and DiskANN indexes alongside similarity functions to execute RAG pipeline patterns. You can build AI agent workflows by integrating these vector search capabilities directly within SurrealQL queries.

Can I use SurrealDB for graph traversal without writing SQL JOINs?▼

SurrealDB graph queries support edge creation and traversal without JOINs. You can model document, graph, vector, relational, time-series, and geospatial patterns in a single schema to query connected data natively.

How do I secure row-level permissions and JWT auth in SurrealDB?▼

SurrealDB security offers row-level permissions, JWT auth, and namespace, database, and record-level access control. You configure these access scopes within SurrealQL to restrict data visibility based on user identity.

Does SurrealDB work with LangChain and n8n for AI agent workflows?▼

SurrealDB works with LangChain and n8n for AI agent workflows. The database integrates with the LangChain Python library and n8n nodes, while SurrealMCP provides a Model Context Protocol server for AI agents.

What's the best way to deploy SurrealDB in production with Docker or Kubernetes?▼

Deploy SurrealDB in production using Docker or Kubernetes with proper storage engine selection and production hardening. You can verify your environment setup beforehand by running the doctor.py health check script.

How do I optimize SurrealQL performance and analyze query execution?▼

Optimize SurrealQL performance using index strategies, EXPLAIN analysis, batch operations, and connection pooling. You run the EXPLAIN statement on your SurrealQL queries to analyze execution plans and identify bottlenecks.