24601/surreal-skills

Experte für SurrealDB 3. Nutze diesen Skill bei der Arbeit mit SurrealDB, SurrealQL-Abfragen, Multi-Modell-Datenmodellierung (Dokument, Graph, Vektor, Zeitreihen, Geodaten), Schema-Design, Graph-Traversierung, Vektorsuche, Sicherheit und Berechtigungen, Deployment und Betrieb, Leistungsoptimierung, SDK-Integration, Surrealism WASM-Erweiterungen, SurrealMCP, Surrealist IDE, Surreal-Sync-Migrationen, SurrealFS, SurrealKit oder Ökosystem-Integrationen wie n8n und CodeMirror.

Was ist surreal-skills?

Dieser Skill bietet umfassende, tiefgehende Unterstützung für SurrealDB 3 – eine hochmoderne Multi-Modell-Datenbank. Er ist darauf ausgelegt, Entwicklern bei der Erstellung von SurrealQL-Abfragen, dem Entwurf von Datenbankschemata (Dokument, Graph, Vektor, Zeitreihen, Geodaten), der Implementierung von Graph-Traversierungen mit RELATE- und Pfeiloperatoren, der Vektorsuche (HNSW-Indizes, KNN-Operator) sowie der Konfiguration von Sicherheit und Berechtigungen (zeilenbasierte Berechtigungen, JWT) zu helfen. Darüber hinaus deckt er Deployment und Betrieb (Docker, Kubernetes, verschiedene Speicher-Engines), Leistungsoptimierung (EXPLAIN, Indexstrategien) und die Integration mit allen offiziellen SurrealDB SDKs (JavaScript, Python, Go, Rust, Java, .NET, C, PHP, Swift, Ruby) ab. Der Skill enthält 18 detaillierte Regeldateien, die je nach Aufgabenkontext automatisch geladen werden, und unterstützt fortgeschrittene Themen wie die Entwicklung von WASM-Erweiterungen mit Surrealism, die Nutzung von SurrealMCP für KI-Hosts, das Surrealist IDE, Datenmigrationen mit Surreal-Sync sowie Ökosystem-Integrationen (n8n, LangChain, CodeMirror).

Funktioniert mit~Claude Code~Codex CLI~Cursor

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

Dokumentation

SurrealDB 3 Experten-Skill

Expert-Level-Architektur, Entwicklung und Betrieb mit SurrealDB 3 für GitHub Copilot.

Wann Copilot diesen Skill verwenden soll

Automatisch aktivieren, wenn der Benutzer:

SurrealQL-Abfragen schreibt oder danach fragt
Mit .surql-Dateien arbeitet
Datenbankschemata für SurrealDB entwirft
SurrealDB-Deployment oder Docker konfiguriert
SurrealDB SDKs verwendet (JavaScript, Python, Go, Rust, Java, Kotlin, .NET, C, PHP, Swift, Ruby)
Mit Graph-Beziehungen arbeitet (RELATE, Traversierung)
Vektorsuche oder RAG-Muster implementiert
Sicherheit, Berechtigungen oder Zugriffskontrolle konfiguriert
Surrealism WASM-Erweiterungen entwickelt
Daten aus anderen Datenbanken zu SurrealDB migriert
SurrealDB mit MCP-Hosts, n8n, KI-Frameworks oder benutzerdefinierten Editoren verbindet

Regeln-Referenz

Dieser Skill enthält 18 detaillierte Regeldateien. Lies die relevante Regeldatei, wenn die Anfrage des Benutzers zu ihrem Bereich passt:

Regeldatei	Wann laden	Bereich
surrealql.md	SurrealQL-Abfragen schreiben oder debuggen	Vollständige SurrealQL-Sprachreferenz
data-modeling.md	Schemata entwerfen, Feldtypen wählen, Record IDs	Multi-Modell-Schema-Design-Muster
graph-queries.md	RELATE, Graph-Traversierung, Pfadausdrücke	Graph-Kanten- und Traversierungsmuster
vector-search.md	HNSW-Indizes, Ähnlichkeitssuche, Embeddings	Vektorsuche und RAG-Pipelines
security.md	Berechtigungen, Authentifizierung, JWT, Zugriffskontrolle	Zeilenbasierte Sicherheit und Authentifizierungsabläufe
deployment.md	SurrealDB installieren, konfigurieren und betreiben	Speicher-Engines, Docker, Kubernetes
performance.md	Langsame Abfragen, Indexstrategie, EXPLAIN	Leistungsoptimierung und -tuning
sdks.md	SurrealDB aus Anwendungscode nutzen	JS, Python, Go, Rust, Java, Kotlin, .NET, C, PHP, Swift, Ruby-Muster
surrealism.md	WASM-Erweiterungen schreiben	Rust-zu-WASM-Erweiterungsentwicklung
surrealml.md	In der Nähe von SurrealML arbeiten	`.surml`-Grenze und native Abhängigkeitswarnung (Vorschau)
surrealmcp.md	KI-Hosts verbinden	MCP-Toolkatalog und -Deployment
editor-tooling.md	Editor-/IDE-Unterstützung	LSP, tree-sitter, CodeMirror, Editor-Erweiterungen
langchain.md	LangChain RAG	Python-Vector-Store-API
ecosystem-integrations.md	n8n / Framework-Hinweise	n8n, KI-Framework-Dokumentation, Spectron-Grenze, Agenten-Skills
surrealist.md	Surrealist IDE/GUI nutzen	IDE-Funktionen und Schema-Designer
surreal-sync.md	Aus anderen Datenbanken migrieren	CDC-Synchronisation von Postgres, Mongo usw.
surrealfs.md	KI-Agent-Dateisystemoperationen	Virtuelles Dateisystem basierend auf SurrealDB
surrealkit.md	Schema-Synchronisation, Rollouts, Seeds und deklarative Tests	Zielzustands-Schemaverwaltung für SurrealDB-Apps

Kurzreferenz

SurrealQL-Grundlagen

-- Datensätze erstellen
CREATE person:alice SET name = 'Alice', age = 30;

-- Graph-Kanten
RELATE person:alice->follows->person:bob SET since = time::now();

-- Graphen traversieren
SELECT ->follows->person.name AS following FROM person:alice;

-- Vektorsuche (HNSW)
DEFINE INDEX idx_embed ON document FIELDS embedding HNSW DIMENSION 1536 DIST COSINE;
SELECT * FROM document WHERE embedding <|10,40|> $query_vector;

-- Zeilenbasierte Berechtigungen
DEFINE TABLE post SCHEMALESS PERMISSIONS
  FOR select WHERE published = true OR user = $auth.id
  FOR create, update WHERE user = $auth.id;

-- Live-Abfragen
LIVE SELECT * FROM person WHERE age > 25;

Wichtige Konzepte

Record IDs: table:id (z. B. person:alice) – erstklassige Bürger, keine JOINs erforderlich
Multi-Modell: Dokument + Graph + Vektor + Zeitreihen + Geodaten in einer Datenbank
Graph-Operatoren: -> (ausgehend), <- (eingehend), <-> (bidirektional)
KNN-Operator: <|K,EF|> wobei K = Nachbarn, EF = Suchparameter (KEIN Distanzmaß)
Speicher-Engines: memory, RocksDB, SurrealKV (Zeitreisen), TiKV (verteilt)
WASM-Erweiterungen: Neu in v3 – Rust schreiben, zu WASM kompilieren, mit DEFINE MODULE registrieren

Skripte

# Gesundheitscheck
uv run scripts/doctor.py

# Schema-Introspection
uv run scripts/schema.py introspect

# Auf Upstream-Updates prüfen
uv run scripts/check_upstream.py

Sicherheitshinweise

Beispiele verwenden root/root nur für die lokale Entwicklung. In der Produktion berechtigte Anmeldedaten verwenden.
Skripte verbinden sich nur mit benutzerdefinierten Endpunkten. Keine Drittanbieter-Netzwerkaufrufe.
Tabellennamen werden vor der Abfrage-Interpolation gegen [a-zA-Z_][a-zA-Z0-9_]* validiert.
Bevorzuge Paketmanager- oder Container-Installationen gegenüber Remote-Shell-Installern.