cancel_query
Stop a running query in CockroachDB by specifying its query ID to manage database performance and resource usage.
Instructions
Cancel a running query.
Args:
query_id: The query ID to cancel.
Returns:
Cancellation result.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"query_id": "<query_id>"
},
"name": "cancel_query"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- Core implementation of cancel_query: executes 'CANCEL QUERY {query_id}' SQL command using the database connection.
async def cancel_query(query_id: str) -> dict[str, Any]: """Cancel a running query. Args: query_id: The query ID to cancel. Returns: Cancellation result. """ conn = await connection_manager.ensure_connected() try: async with conn.cursor() as cur: await cur.execute(f"CANCEL QUERY '{query_id}'") return { "status": "success", "query_id": query_id, "message": "Query cancelled", } except Exception as e: return {"status": "error", "error": str(e)} - src/cockroachdb_mcp/server.py:518-531 (registration)MCP tool registration via @mcp.tool() decorator and wrapper that calls the cluster module's cancel_query function.
@mcp.tool() async def cancel_query(query_id: str) -> dict[str, Any]: """Cancel a running query. Args: query_id: The query ID to cancel. Returns: Cancellation result. """ try: return await cluster.cancel_query(query_id) except Exception as e: return {"status": "error", "error": str(e)}