query
Execute SurrealQL queries to interact with SurrealDB databases for complex operations like SELECT with JOINs, schema definitions, transactions, and graph traversals.
Instructions
Execute one or more SurrealQL queries against the connected SurrealDB database.
This tool allows you to run any valid SurrealQL queries directly. Use this for complex queries that don't fit the other tool patterns, such as:
Complex SELECT queries with JOINs, GROUP BY, or aggregations
Custom DEFINE statements for schemas
Transaction blocks with BEGIN/COMMIT
Graph traversal queries
Queries are executed sequentially. If a query fails, execution continues with the remaining queries, and the error is captured in that query's result.
Args: queries: A list of SurrealQL queries to execute. Examples: - ["SELECT * FROM user WHERE age > 18"] - ["SELECT * FROM user", "SELECT * FROM product"] - ["CREATE user:alice SET name = 'Alice'", "CREATE user:bob SET name = 'Bob'"] namespace: Optional SurrealDB namespace override. If not provided, uses SURREAL_NAMESPACE env var. database: Optional SurrealDB database override. If not provided, uses SURREAL_DATABASE env var.
Returns: A dictionary containing: - success: Boolean indicating if at least one query executed successfully - results: Array of per-query results, each containing: - success: Boolean indicating if this specific query succeeded - data: The query results (only present on success) - error: Error message (only present on failure) - total: Total number of queries executed - succeeded: Number of queries that succeeded - failed: Number of queries that failed
Example: >>> await query(["SELECT * FROM user", "SELECT * FROM product"]) { "success": true, "results": [ {"success": true, "data": [{"id": "user:1", "name": "Alice"}]}, {"success": true, "data": [{"id": "product:1", "name": "Laptop"}]} ], "total": 2, "succeeded": 2, "failed": 0 }
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| queries | Yes | ||
| namespace | No | ||
| database | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||