surrealdb

What This Skill Does

The surrealdb skill provides a robust architecture and development framework for managing SurrealDB 3 instances. It is designed to act as an expert-level co-pilot for your database operations, covering the entire lifecycle of a SurrealDB deployment. By integrating SurrealQL mastery, this skill allows users to perform multi-model data modeling—bridging document, graph, vector, time-series, and geospatial data—without leaving the agent environment. It includes built-in diagnostic tools to verify connectivity, introspect complex schemas, and manage database lifecycle tasks like importing, exporting, and health monitoring. Whether you are designing a high-performance production schema, performing complex graph traversals, or tuning performance, this skill provides the structured environment necessary for professional SurrealDB development.

Installation

Installation is streamlined via the OpenClaw hub. Run: clawhub install openclaw/skills/skills/24601/surrealdb. Ensure you have the surreal CLI installed on your system (via Homebrew or official binaries) and the uv tool for Python dependency management. The skill requires Python 3.10+ and integrates directly with your system's surreal instance to perform tasks securely. Always review your environment configuration to ensure credentials are stored using secure environment variables, avoiding hardcoded root passwords.

Use Cases

• Complex Data Modeling: Efficiently transition from traditional relational schemas to multi-model architectures, utilizing SurrealDB's advanced graph and vector capabilities for modern AI applications.
• Database Administration: Use the provided diagnostic scripts (doctor.py) for automated health checks and use schema.py to instantly introspect and document existing, undocumented production schemas.
• Rapid Prototyping: Quickly spin up in-memory or persistent storage environments to test SurrealQL queries and logic before deploying to staging.
• CI/CD Integration: Automate schema migrations and data exports using the CLI-integrated scripts to maintain database consistency across environments.

Example Prompts

1. "Analyze my current database schema and suggest optimized indexes for the graph relationships in the 'User' and 'Post' tables."
2. "Generate a SurrealQL migration script to transform my existing geospatial data points into a standard point collection with proper indexing."
3. "Run the system health check and provide a summary of the current database latency and storage usage."

Tips & Limitations

• Security First: The tool defaults to local testing credentials. Always transition to scoped, least-privilege users defined in your SurrealDB configuration files before connecting to network-exposed instances.
• Performance Tuning: While SurrealDB is powerful, ensure your vector indexes are sized appropriately for your dataset size to prevent memory bottlenecks.
• Tooling: Always prioritize the use of uv to manage the skill's local environment, as it ensures parity between your development environment and the agent's execution context. Avoid running production-destructive commands like export or import without first verifying your database context via the doctor.py utility.