sqlbuddy-nwi 0.3.3__tar.gz → 0.3.4__tar.gz

{sqlbuddy_nwi-0.3.3 → sqlbuddy_nwi-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlbuddy-nwi
-Version: 0.3.3
+Version: 0.3.4
 Summary: MCP server for read-only database access (MySQL, ClickHouse)
 Author: ying.yuxiang
 License: MIT
@@ -67,19 +67,40 @@ SQL Buddy runs **locally** (a small Python program, not a cloud service). It
 
 ## Quickstart
 
+**Install** (current release **0.3.3**, Python ≥ 3.11):
+
 ```bash
-git clone <this-repo-url> sql-buddy && cd sql-buddy
-uv run server.py            # installs deps into an isolated .venv, then serves (Ctrl+C to stop)
-uv run sql-buddy init       # interactive wizard → writes connections/config/db.ini
-uv run sql-buddy doctor --connect   # green-checks the venv, db.ini, tunnels, MCP client config
-uv run sql-buddy mcp add    # registers sql-buddy with Claude Code (writes .mcp.json)
+# From PyPI (recommended):
+pip install sqlbuddy-nwi          # provides the `sql-buddy` command
+# …or run the latest instantly without installing:
+uvx --from sqlbuddy-nwi sql-buddy
 ```
 
+```bash
+# From source (for development):
+git clone https://github.com/yyx462/sql-buddy && cd sql-buddy
+uv run server.py                  # auto-provisions an isolated .venv, then serves
+```
+
+**Configure & connect:**
+
+```bash
+sql-buddy init                    # interactive wizard → writes connections/config/db.ini
+sql-buddy doctor --connect        # green-checks db.ini, tunnels, MCP client config
+sql-buddy mcp add                 # registers sql-buddy with Claude Code (writes .mcp.json)
+```
+
+> From a **git checkout**, prefix these with `uv run` (e.g. `uv run sql-buddy init`).
+> From a **pip / uvx install**, run `sql-buddy` directly — it's on your PATH.
+
 Restart your client, then ask your agent *"list the tables in the `ck`
 connection"* — if it answers, you're live. 🎉
 
 > **Bare `sql-buddy` (no command) runs the MCP server** — that's what your AI
 > client invokes, so configs hold no fragile absolute `.venv/bin/python` path.
+> `sql-buddy mcp add` auto-detects how you installed and writes the right
+> command: `uvx --from sqlbuddy-nwi sql-buddy` for a pip/uvx install,
+> `uv --directory … run server.py` for a checkout.
 > Other commands: `version`, `doctor [--connect]`, `mcp print|add`, `update-check`, `init`.
 > On **Windows**, see [`docs/windows-trae.md`](docs/windows-trae.md) and use
 > `sql-buddy mcp add --client trae`.
@@ -91,8 +112,8 @@ connection"* — if it answers, you're live. 🎉
 Run the wizard (easiest) or copy the template:
 
 ```bash
-uv run sql-buddy init
-# or by hand:
+sql-buddy init
+# or, from a git checkout, copy the template and edit by hand:
 cp connections/config/db.ini.example connections/config/db.ini
 $EDITOR connections/config/db.ini
 ```
@@ -140,13 +161,13 @@ reference, SSH troubleshooting, and External (`ssh -N`) mode, see
 ## Connect your AI agent
 
 ```bash
-uv run sql-buddy mcp add                      # Claude Code project → ./.mcp.json
-uv run sql-buddy mcp add --scope user         # Claude Code user    → ~/.claude.json
-uv run sql-buddy mcp add --client trae        # Trae project        → ./.trae/mcp.json
-uv run sql-buddy mcp add --client trae --scope user   # Trae user-global
+sql-buddy mcp add                      # Claude Code project → ./.mcp.json
+sql-buddy mcp add --scope user         # Claude Code user    → ~/.claude.json
+sql-buddy mcp add --client trae        # Trae project        → ./.trae/mcp.json
+sql-buddy mcp add --client trae --scope user   # Trae user-global
 ```
 
-Restart your client. Preview the exact block first with `uv run sql-buddy mcp print`
+Restart your client. Preview the exact block first with `sql-buddy mcp print`
 (paths filled in):
 
 ```json

{sqlbuddy_nwi-0.3.3 → sqlbuddy_nwi-0.3.4}/README.md

@@ -38,19 +38,40 @@ SQL Buddy runs **locally** (a small Python program, not a cloud service). It
 
 ## Quickstart
 
+**Install** (current release **0.3.3**, Python ≥ 3.11):
+
 ```bash
-git clone <this-repo-url> sql-buddy && cd sql-buddy
-uv run server.py            # installs deps into an isolated .venv, then serves (Ctrl+C to stop)
-uv run sql-buddy init       # interactive wizard → writes connections/config/db.ini
-uv run sql-buddy doctor --connect   # green-checks the venv, db.ini, tunnels, MCP client config
-uv run sql-buddy mcp add    # registers sql-buddy with Claude Code (writes .mcp.json)
+# From PyPI (recommended):
+pip install sqlbuddy-nwi          # provides the `sql-buddy` command
+# …or run the latest instantly without installing:
+uvx --from sqlbuddy-nwi sql-buddy
 ```
 
+```bash
+# From source (for development):
+git clone https://github.com/yyx462/sql-buddy && cd sql-buddy
+uv run server.py                  # auto-provisions an isolated .venv, then serves
+```
+
+**Configure & connect:**
+
+```bash
+sql-buddy init                    # interactive wizard → writes connections/config/db.ini
+sql-buddy doctor --connect        # green-checks db.ini, tunnels, MCP client config
+sql-buddy mcp add                 # registers sql-buddy with Claude Code (writes .mcp.json)
+```
+
+> From a **git checkout**, prefix these with `uv run` (e.g. `uv run sql-buddy init`).
+> From a **pip / uvx install**, run `sql-buddy` directly — it's on your PATH.
+
 Restart your client, then ask your agent *"list the tables in the `ck`
 connection"* — if it answers, you're live. 🎉
 
 > **Bare `sql-buddy` (no command) runs the MCP server** — that's what your AI
 > client invokes, so configs hold no fragile absolute `.venv/bin/python` path.
+> `sql-buddy mcp add` auto-detects how you installed and writes the right
+> command: `uvx --from sqlbuddy-nwi sql-buddy` for a pip/uvx install,
+> `uv --directory … run server.py` for a checkout.
 > Other commands: `version`, `doctor [--connect]`, `mcp print|add`, `update-check`, `init`.
 > On **Windows**, see [`docs/windows-trae.md`](docs/windows-trae.md) and use
 > `sql-buddy mcp add --client trae`.
@@ -62,8 +83,8 @@ connection"* — if it answers, you're live. 🎉
 Run the wizard (easiest) or copy the template:
 
 ```bash
-uv run sql-buddy init
-# or by hand:
+sql-buddy init
+# or, from a git checkout, copy the template and edit by hand:
 cp connections/config/db.ini.example connections/config/db.ini
 $EDITOR connections/config/db.ini
 ```
@@ -111,13 +132,13 @@ reference, SSH troubleshooting, and External (`ssh -N`) mode, see
 ## Connect your AI agent
 
 ```bash
-uv run sql-buddy mcp add                      # Claude Code project → ./.mcp.json
-uv run sql-buddy mcp add --scope user         # Claude Code user    → ~/.claude.json
-uv run sql-buddy mcp add --client trae        # Trae project        → ./.trae/mcp.json
-uv run sql-buddy mcp add --client trae --scope user   # Trae user-global
+sql-buddy mcp add                      # Claude Code project → ./.mcp.json
+sql-buddy mcp add --scope user         # Claude Code user    → ~/.claude.json
+sql-buddy mcp add --client trae        # Trae project        → ./.trae/mcp.json
+sql-buddy mcp add --client trae --scope user   # Trae user-global
 ```
 
-Restart your client. Preview the exact block first with `uv run sql-buddy mcp print`
+Restart your client. Preview the exact block first with `sql-buddy mcp print`
 (paths filled in):
 
 ```json

{sqlbuddy_nwi-0.3.3 → sqlbuddy_nwi-0.3.4}/_version.py

@@ -7,4 +7,4 @@ still report a version. `cli.get_version()` prefers installed metadata when
 available and falls back to this.
 """
 
-__version__ = "0.3.3"
+__version__ = "0.3.4"

{sqlbuddy_nwi-0.3.3 → sqlbuddy_nwi-0.3.4}/connections/manager.py

@@ -135,10 +135,27 @@ class DBManager:
         return conn_config
 
     def _create_clickhouse_client(self, section: str) -> Client:
-        return Client(**self._resolve_conn_config(section, 9000))
+        cfg = self._resolve_conn_config(section, 9000)
+        # Default timeouts: a black-holed endpoint (dead tunnel forward, silent
+        # DB) must raise instead of parking the caller's worker thread in a
+        # socket read forever. Explicit keys in the db.ini section win.
+        cfg.setdefault('connect_timeout', 10)
+        cfg.setdefault('send_receive_timeout', 900)
+        for k in ('connect_timeout', 'send_receive_timeout'):
+            cfg[k] = int(cfg[k])  # ini values arrive as strings; drivers want ints
+        return Client(**cfg)
 
     def _create_mysql_client(self, section: str) -> MySQLConnectionWrapper:
-        return MySQLConnectionWrapper(pymysql.connect(**self._resolve_conn_config(section, 3306)))
+        cfg = self._resolve_conn_config(section, 3306)
+        # Same bounds for MySQL; read/write must exceed the 600s
+        # innodb_lock_wait_timeout the locked wrapper sets, so legit
+        # lock-waits are not cut short.
+        cfg.setdefault('connect_timeout', 10)
+        cfg.setdefault('read_timeout', 900)
+        cfg.setdefault('write_timeout', 900)
+        for k in ('connect_timeout', 'read_timeout', 'write_timeout'):
+            cfg[k] = int(cfg[k])  # ini values arrive as strings; drivers want ints
+        return MySQLConnectionWrapper(pymysql.connect(**cfg))
 
     def all_clients(self) -> Dict[str, Any]:
         return {name: entry['client'] for name, entry in self._cache.items()}

{sqlbuddy_nwi-0.3.3 → sqlbuddy_nwi-0.3.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sqlbuddy-nwi"
-version = "0.3.3"
+version = "0.3.4"
 description = "MCP server for read-only database access (MySQL, ClickHouse)"
 readme = "README.md"
 requires-python = ">=3.11"

{sqlbuddy_nwi-0.3.3 → sqlbuddy_nwi-0.3.4}/sqlbuddy_nwi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sqlbuddy-nwi
-Version: 0.3.3
+Version: 0.3.4
 Summary: MCP server for read-only database access (MySQL, ClickHouse)
 Author: ying.yuxiang
 License: MIT
@@ -67,19 +67,40 @@ SQL Buddy runs **locally** (a small Python program, not a cloud service). It
 
 ## Quickstart
 
+**Install** (current release **0.3.3**, Python ≥ 3.11):
+
 ```bash
-git clone <this-repo-url> sql-buddy && cd sql-buddy
-uv run server.py            # installs deps into an isolated .venv, then serves (Ctrl+C to stop)
-uv run sql-buddy init       # interactive wizard → writes connections/config/db.ini
-uv run sql-buddy doctor --connect   # green-checks the venv, db.ini, tunnels, MCP client config
-uv run sql-buddy mcp add    # registers sql-buddy with Claude Code (writes .mcp.json)
+# From PyPI (recommended):
+pip install sqlbuddy-nwi          # provides the `sql-buddy` command
+# …or run the latest instantly without installing:
+uvx --from sqlbuddy-nwi sql-buddy
 ```
 
+```bash
+# From source (for development):
+git clone https://github.com/yyx462/sql-buddy && cd sql-buddy
+uv run server.py                  # auto-provisions an isolated .venv, then serves
+```
+
+**Configure & connect:**
+
+```bash
+sql-buddy init                    # interactive wizard → writes connections/config/db.ini
+sql-buddy doctor --connect        # green-checks db.ini, tunnels, MCP client config
+sql-buddy mcp add                 # registers sql-buddy with Claude Code (writes .mcp.json)
+```
+
+> From a **git checkout**, prefix these with `uv run` (e.g. `uv run sql-buddy init`).
+> From a **pip / uvx install**, run `sql-buddy` directly — it's on your PATH.
+
 Restart your client, then ask your agent *"list the tables in the `ck`
 connection"* — if it answers, you're live. 🎉
 
 > **Bare `sql-buddy` (no command) runs the MCP server** — that's what your AI
 > client invokes, so configs hold no fragile absolute `.venv/bin/python` path.
+> `sql-buddy mcp add` auto-detects how you installed and writes the right
+> command: `uvx --from sqlbuddy-nwi sql-buddy` for a pip/uvx install,
+> `uv --directory … run server.py` for a checkout.
 > Other commands: `version`, `doctor [--connect]`, `mcp print|add`, `update-check`, `init`.
 > On **Windows**, see [`docs/windows-trae.md`](docs/windows-trae.md) and use
 > `sql-buddy mcp add --client trae`.
@@ -91,8 +112,8 @@ connection"* — if it answers, you're live. 🎉
 Run the wizard (easiest) or copy the template:
 
 ```bash
-uv run sql-buddy init
-# or by hand:
+sql-buddy init
+# or, from a git checkout, copy the template and edit by hand:
 cp connections/config/db.ini.example connections/config/db.ini
 $EDITOR connections/config/db.ini
 ```
@@ -140,13 +161,13 @@ reference, SSH troubleshooting, and External (`ssh -N`) mode, see
 ## Connect your AI agent
 
 ```bash
-uv run sql-buddy mcp add                      # Claude Code project → ./.mcp.json
-uv run sql-buddy mcp add --scope user         # Claude Code user    → ~/.claude.json
-uv run sql-buddy mcp add --client trae        # Trae project        → ./.trae/mcp.json
-uv run sql-buddy mcp add --client trae --scope user   # Trae user-global
+sql-buddy mcp add                      # Claude Code project → ./.mcp.json
+sql-buddy mcp add --scope user         # Claude Code user    → ~/.claude.json
+sql-buddy mcp add --client trae        # Trae project        → ./.trae/mcp.json
+sql-buddy mcp add --client trae --scope user   # Trae user-global
 ```
 
-Restart your client. Preview the exact block first with `uv run sql-buddy mcp print`
+Restart your client. Preview the exact block first with `sql-buddy mcp print`
 (paths filled in):
 
 ```json

{sqlbuddy_nwi-0.3.3 → sqlbuddy_nwi-0.3.4}/sqlbuddy_nwi.egg-info/SOURCES.txt

@@ -21,6 +21,7 @@ sqlbuddy_nwi.egg-info/dependency_links.txt
 sqlbuddy_nwi.egg-info/entry_points.txt
 sqlbuddy_nwi.egg-info/requires.txt
 sqlbuddy_nwi.egg-info/top_level.txt
+tests/test_client_timeouts.py
 tests/test_get_info.py
 tests/test_parse_create_table.py
 tests/test_sanitize_search.py

sqlbuddy_nwi-0.3.4/tests/test_client_timeouts.py

@@ -0,0 +1,103 @@
+"""Writer/reader contract: _create_* injects default timeouts, db.ini wins.
+
+Receipt (2026-11-04): a sql-buddy MCP process pinned the mini at ~950% CPU
+with 83 worker threads parked forever in socket reads — pymysql/clickhouse
+clients were built with no connect/read timeouts, so a black-holed tunnel
+endpoint parked every calling thread permanently. These tests pin the fix:
+defaults are injected, explicit section keys override them.
+"""
+
+import configparser
+import threading
+
+import pytest
+
+from connections.manager import DBManager
+
+
+class _Capture:
+    """Records the kwargs it was constructed with; never touches a network."""
+
+    def __init__(self, **kwargs):
+        self.kwargs = kwargs
+
+
+@pytest.fixture
+def manager(tmp_path, monkeypatch):
+    ini = tmp_path / "db.ini"
+    ini.write_text(
+        "[ck-default]\n"
+        "type = clickhouse\n"
+        "host = db.example\n"
+        "\n"
+        "[ck-explicit]\n"
+        "type = clickhouse\n"
+        "host = db.example\n"
+        "connect_timeout = 3\n"
+        "send_receive_timeout = 60\n"
+        "\n"
+        "[mysql-default]\n"
+        "type = mysql\n"
+        "host = db.example\n"
+        "\n"
+        "[mysql-explicit]\n"
+        "type = mysql\n"
+        "host = db.example\n"
+        "connect_timeout = 2\n"
+        "read_timeout = 30\n"
+    )
+
+    # No tunnels in these sections -> TunnelManager stays idle.
+    import connections.manager as m
+    monkeypatch.setattr(m, "_get_tunnel_manager",
+                        lambda: type("T", (), {"block_for": staticmethod(lambda s: None),
+                                               "local_port_for": staticmethod(lambda s: None),
+                                               "generation": staticmethod(lambda b: 0)})())
+    return DBManager(str(ini))
+
+
+def test_clickhouse_defaults_injected(manager, monkeypatch):
+    seen = {}
+    monkeypatch.setattr("connections.manager.Client",
+                        lambda **kw: seen.update(kw) or _Capture(**kw))
+    manager._create_clickhouse_client("ck-default")
+    assert seen["connect_timeout"] == 10
+    assert seen["send_receive_timeout"] == 900
+
+
+def test_clickhouse_section_overrides(manager, monkeypatch):
+    seen = {}
+    monkeypatch.setattr("connections.manager.Client",
+                        lambda **kw: seen.update(kw) or _Capture(**kw))
+    manager._create_clickhouse_client("ck-explicit")
+    assert seen["connect_timeout"] == 3
+    assert seen["send_receive_timeout"] == 60
+
+
+def test_mysql_defaults_injected(manager, monkeypatch):
+    seen = {}
+
+    class _Conn(_Capture):
+        pass
+
+    monkeypatch.setattr("connections.manager.pymysql",
+                        type("P", (), {"connect": staticmethod(lambda **kw: seen.update(kw) or _Conn(**kw))}))
+    manager._create_mysql_client("mysql-default")
+    assert seen["connect_timeout"] == 10
+    assert seen["read_timeout"] == 900
+    assert seen["write_timeout"] == 900
+
+
+def test_mysql_section_overrides(manager, monkeypatch):
+    seen = {}
+
+    class _Conn(_Capture):
+        pass
+
+    monkeypatch.setattr("connections.manager.pymysql",
+                        type("P", (), {"connect": staticmethod(lambda **kw: seen.update(kw) or _Conn(**kw))}))
+    manager._create_mysql_client("mysql-explicit")
+    assert seen["connect_timeout"] == 2
+    assert seen["read_timeout"] == 30
+    # Not set in the section -> default still injected alongside overrides.
+    assert seen["write_timeout"] == 900