Merge remote-tracking branch 'origin/main' into pr-162

# Conflicts:
#	pyproject.toml

Author: Maxteabag

README.md

@@ -25,7 +25,7 @@
 ---
 
 ### Connect
-Supports all major databases: SQL Server, PostgreSQL, MySQL, SQLite, MariaDB, FirebirdSQL, Oracle, DuckDB, CockroachDB, ClickHouse, Snowflake, Supabase, CloudFlare D1, Turso, Athena, BigQuery, RedShift, IBM Db2, SAP HANA, Teradata, Trino, Presto and Apache Flight SQL.
+Supports all major databases: SQL Server, PostgreSQL, MySQL, SQLite, MariaDB, FirebirdSQL, Oracle, DuckDB, CockroachDB, ClickHouse, Snowflake, Supabase, CloudFlare D1, Turso, Athena, BigQuery, Spanner, RedShift, IBM Db2, SAP HANA, Teradata, Trino, Presto and Apache Flight SQL.
 
 ![Database Providers](docs/demos/demo-providers.gif)
 
@@ -233,13 +233,15 @@ Autocomplete triggers automatically in INSERT mode. Use `Tab` to accept.
 
 ## Configuration
 
-Connections and settings are stored in `~/.sqlit/`.
+Connections and settings are stored in `$XDG_CONFIG_HOME/sqlit/` (default: `~/.config/sqlit/`). Override the location by setting `SQLIT_CONFIG_DIR`.
+
+If an older install left files in `~/.sqlit/`, they are moved to the new location automatically on first run.
 
 ## FAQ
 
 ### How are sensitive credentials stored?
 
-Connection details are stored in `~/.sqlit/connections.json`, but passwords are stored in your OS keyring when available (macOS Keychain, Windows Credential Locker, Linux Secret Service).
+Connection details are stored in `connections.json` inside the config directory, but passwords are stored in your OS keyring when available (macOS Keychain, Windows Credential Locker, Linux Secret Service).
 
 ### How does sqlit compare to Harlequin, Lazysql, etc.?
 
@@ -281,6 +283,8 @@ Most of the time you can just run `sqlit` and connect. If a Python driver is mis
 | Snowflake                           | `snowflake-connector-python` | `pipx inject sqlit-tui snowflake-connector-python` | `python -m pip install snowflake-connector-python` |
 | Firebird                            | `firebirdsql`                | `pipx inject sqlit-tui firebirdsql`                | `python -m pip install firebirdsql`                |
 | Athena                              | `pyathena`                   | `pipx inject sqlit-tui pyathena`                   | `python -m pip install pyathena`                   |
+| BigQuery                            | `google-cloud-bigquery`      | `pipx inject sqlit-tui google-cloud-bigquery`      | `python -m pip install google-cloud-bigquery`      |
+| Spanner                             | `google-cloud-spanner`       | `pipx inject sqlit-tui google-cloud-spanner`       | `python -m pip install google-cloud-spanner`       |
 | Apache Arrow Flight SQL             | `adbc-driver-flightsql`      | `pipx inject sqlit-tui adbc-driver-flightsql`      | `python -m pip install adbc-driver-flightsql`      |
 
 ### SSH Tunnel Support

flake.nix

@@ -28,53 +28,85 @@
         shortRev = if self ? shortRev then self.shortRev else "dirty";
         version = if tag != "" then tag else "0.0.0+${shortRev}";
 
-        sqlit = pyPkgs.buildPythonApplication {
-          pname = "sqlit";
-          inherit version;
-          pyproject = true;
+        # Extras mirror project.optional-dependencies in pyproject.toml,
+        # limited to drivers packaged in nixpkgs. Others (mssql-python,
+        # oracledb, mariadb, ibm_db, hdbcli, teradatasql, trino,
+        # presto-python-client, redshift-connector, clickhouse-connect,
+        # libsql, firebirdsql, pyathena, adbc-driver-flightsql) aren't
+        # here; install with `pipx inject` or a custom derivation.
+        nixpkgsExtras = {
+          ssh = [ pyPkgs.sshtunnel pyPkgs.paramiko ];
+          postgres = [ pyPkgs.psycopg2 ];
+          cockroachdb = [ pyPkgs.psycopg2 ];
+          mysql = [ pyPkgs.pymysql ];
+          duckdb = [ pyPkgs.duckdb ];
+          bigquery = [ pyPkgs.google-cloud-bigquery ];
+          snowflake = [ pyPkgs.snowflake-connector-python ];
+          d1 = [ pyPkgs.requests ];
+        };
 
-          src = self;
+        resolveExtras = names:
+          lib.concatLists (map (n:
+            nixpkgsExtras.${n} or (throw
+              "Unknown sqlit extra '${n}'. Available: ${
+                lib.concatStringsSep ", " (builtins.attrNames nixpkgsExtras)
+              }")
+          ) names);
 
-          build-system = [
-            pyPkgs.hatchling
-            pyPkgs."hatch-vcs"
-            pyPkgs."setuptools-scm"
-          ];
+        # Build sqlit, optionally with a set of driver extras from nixpkgs.
+        # Example:  makeSqlit { extras = [ "postgres" "ssh" ]; }
+        makeSqlit = { extras ? [] }:
+          pyPkgs.buildPythonApplication {
+            pname = "sqlit";
+            inherit version;
+            pyproject = true;
 
-          nativeBuildInputs = [
-            pyPkgs.pythonRelaxDepsHook
-          ];
+            src = self;
 
-          pythonRelaxDeps = [
-            "textual-fastdatatable"
-          ];
+            build-system = [
+              pyPkgs.hatchling
+              pyPkgs."hatch-vcs"
+              pyPkgs."setuptools-scm"
+            ];
 
-          SETUPTOOLS_SCM_PRETEND_VERSION = version;
+            nativeBuildInputs = [
+              pyPkgs.pythonRelaxDepsHook
+            ];
 
-          dependencies = [
-            pyPkgs.docker
-            pyPkgs.keyring
-            pyPkgs.pyperclip
-            pyPkgs.sqlparse
-            pyPkgs.textual
-            pyPkgs."textual-fastdatatable"
-          ];
+            pythonRelaxDeps = [
+              "textual-fastdatatable"
+            ];
 
-          pythonImportsCheck = [ "sqlit" ];
+            SETUPTOOLS_SCM_PRETEND_VERSION = version;
 
-          meta = with lib; {
-            description = "A terminal UI for SQL databases";
-            homepage = "https://github.com/Maxteabag/sqlit";
-            license = licenses.mit;
-            mainProgram = "sqlit";
+            dependencies = [
+              pyPkgs.docker
+              pyPkgs.keyring
+              pyPkgs.pyperclip
+              pyPkgs.sqlparse
+              pyPkgs.textual
+              pyPkgs."textual-fastdatatable"
+            ] ++ (resolveExtras extras);
+
+            pythonImportsCheck = [ "sqlit" ];
+
+            meta = with lib; {
+              description = "A terminal UI for SQL databases";
+              homepage = "https://github.com/Maxteabag/sqlit";
+              license = licenses.mit;
+              mainProgram = "sqlit";
+            };
           };
-        };
+
+        sqlit = makeSqlit { extras = builtins.attrNames nixpkgsExtras; };
       in {
         packages = {
           inherit sqlit;
           default = sqlit;
         };
 
+        lib = { inherit makeSqlit; };
+
         apps.default = {
           type = "app";
           program = "${sqlit}/bin/sqlit";

pyproject.toml

@@ -48,6 +48,7 @@ all = [
     "trino>=0.329.0",
     "presto-python-client>=0.8.4",
     "google-cloud-bigquery",
+    "google-cloud-spanner>=3.0.0",
     "duckdb>=1.1.0",  # min avoids known CVEs
     "clickhouse-connect>=0.7.0",
     "requests>=2.32.4",  # min avoids known CVEs
@@ -75,6 +76,7 @@ teradata = ["teradatasql>=20.0.0"]
 trino = ["trino>=0.329.0"]
 presto = ["presto-python-client>=0.8.4"]
 bigquery = ["google-cloud-bigquery"]
+spanner = ["google-cloud-spanner>=3.0.0"]
 redshift = ["redshift-connector"]
 duckdb = ["duckdb>=1.1.0"]  # min avoids known CVEs
 clickhouse = ["clickhouse-connect>=0.7.0"]
@@ -193,6 +195,7 @@ markers = [
     "firebird: Firebird database tests",
     "clickhouse: ClickHouse database tests",
     "flight: Apache Arrow Flight SQL database tests",
+    "spanner: Google Cloud Spanner database tests",
     "asyncio: async tests",
     "integration: integration tests (may require external services)",
 ]
@@ -251,7 +254,18 @@ module = [
     "impala",
     "impala.dbapi",
     "osquery",
-    "surrealdb"
+    "surrealdb",
+    "google.cloud",
+    "google.cloud.bigquery",
+    "google.cloud.bigquery.dbapi",
+    "google.cloud.spanner",
+    "google.cloud.spanner_dbapi",
+    "google.api_core",
+    "google.api_core.client_options",
+    "google.auth",
+    "google.auth.credentials",
+    "google.oauth2",
+    "google.oauth2.service_account",
 ]
 ignore_missing_imports = true
 

sqlit/cli.py

@@ -372,7 +372,7 @@ def main() -> int:
     parser.add_argument(
         "--settings",
         metavar="PATH",
-        help="Path to settings JSON file (overrides ~/.sqlit/settings.json)",
+        help="Path to settings JSON file (overrides the one in the sqlit config directory)",
     )
     parser.add_argument(
         "--theme",

sqlit/core/binding_contexts.py

@@ -21,6 +21,10 @@ def get_binding_contexts(ctx: InputContext) -> set[str]:
         contexts.add("query")
         if ctx.vim_mode == VimMode.INSERT:
             contexts.add("query_insert")
+        elif ctx.vim_mode == VimMode.VISUAL:
+            contexts.add("query_visual")
+        elif ctx.vim_mode == VimMode.VISUAL_LINE:
+            contexts.add("query_visual_line")
         else:
             contexts.add("query_normal")
     if ctx.autocomplete_visible:

sqlit/core/keymap.py

@@ -11,6 +11,7 @@
     "question_mark": "?",
     "slash": "/",
     "asterisk": "*",
+    "circumflex_accent": "^",
     "dollar_sign": "$",
     "percent_sign": "%",
     "space": "<space>",
@@ -357,15 +358,65 @@ def _build_action_keys(self) -> list[ActionKeyDef]:
             ActionKeyDef("b", "cursor_word_back", "query_normal"),
             ActionKeyDef("B", "cursor_WORD_back", "query_normal"),
             ActionKeyDef("0", "cursor_line_start", "query_normal"),
+            ActionKeyDef("circumflex_accent", "cursor_first_non_blank", "query_normal"),
             ActionKeyDef("dollar_sign", "cursor_line_end", "query_normal"),
             ActionKeyDef("G", "cursor_last_line", "query_normal"),
             ActionKeyDef("percent_sign", "cursor_matching_bracket", "query_normal"),
             ActionKeyDef("f", "cursor_find_char", "query_normal"),
             ActionKeyDef("F", "cursor_find_char_back", "query_normal"),
             ActionKeyDef("t", "cursor_till_char", "query_normal"),
             ActionKeyDef("T", "cursor_till_char_back", "query_normal"),
+            ActionKeyDef("v", "enter_visual_mode", "query_normal"),
+            ActionKeyDef("V", "enter_visual_line_mode", "query_normal"),
+            ActionKeyDef("x", "delete_char", "query_normal"),
             ActionKeyDef("a", "append_insert_mode", "query_normal"),
             ActionKeyDef("A", "append_line_end", "query_normal"),
+            # Query (visual mode - charwise)
+            ActionKeyDef("escape", "exit_visual_mode", "query_visual"),
+            ActionKeyDef("v", "exit_visual_mode", "query_visual", primary=False),
+            ActionKeyDef("V", "switch_to_visual_line_mode", "query_visual"),
+            ActionKeyDef("y", "visual_yank", "query_visual"),
+            ActionKeyDef("d", "visual_delete", "query_visual"),
+            ActionKeyDef("x", "visual_delete", "query_visual", primary=False),
+            ActionKeyDef("c", "visual_change", "query_visual"),
+            ActionKeyDef("enter", "visual_execute", "query_visual"),
+            ActionKeyDef("h", "cursor_left", "query_visual"),
+            ActionKeyDef("j", "cursor_down", "query_visual"),
+            ActionKeyDef("k", "cursor_up", "query_visual"),
+            ActionKeyDef("l", "cursor_right", "query_visual"),
+            ActionKeyDef("w", "cursor_word_forward", "query_visual"),
+            ActionKeyDef("W", "cursor_WORD_forward", "query_visual"),
+            ActionKeyDef("b", "cursor_word_back", "query_visual"),
+            ActionKeyDef("B", "cursor_WORD_back", "query_visual"),
+            ActionKeyDef("0", "cursor_line_start", "query_visual"),
+            ActionKeyDef("circumflex_accent", "cursor_first_non_blank", "query_visual"),
+            ActionKeyDef("dollar_sign", "cursor_line_end", "query_visual"),
+            ActionKeyDef("G", "cursor_last_line", "query_visual"),
+            ActionKeyDef("g", "g_leader_key", "query_visual"),
+            ActionKeyDef("percent_sign", "cursor_matching_bracket", "query_visual"),
+            ActionKeyDef("f", "cursor_find_char", "query_visual"),
+            ActionKeyDef("F", "cursor_find_char_back", "query_visual"),
+            ActionKeyDef("t", "cursor_till_char", "query_visual"),
+            ActionKeyDef("T", "cursor_till_char_back", "query_visual"),
+            ActionKeyDef("down", "cursor_down", "query_visual", primary=False),
+            ActionKeyDef("up", "cursor_up", "query_visual", primary=False),
+            ActionKeyDef("left", "cursor_left", "query_visual", primary=False),
+            ActionKeyDef("right", "cursor_right", "query_visual", primary=False),
+            # Query (visual line mode)
+            ActionKeyDef("escape", "exit_visual_line_mode", "query_visual_line"),
+            ActionKeyDef("V", "exit_visual_line_mode", "query_visual_line", primary=False),
+            ActionKeyDef("v", "switch_to_visual_mode", "query_visual_line"),
+            ActionKeyDef("y", "visual_line_yank", "query_visual_line"),
+            ActionKeyDef("d", "visual_line_delete", "query_visual_line"),
+            ActionKeyDef("x", "visual_line_delete", "query_visual_line", primary=False),
+            ActionKeyDef("c", "visual_line_change", "query_visual_line"),
+            ActionKeyDef("j", "cursor_down", "query_visual_line"),
+            ActionKeyDef("k", "cursor_up", "query_visual_line"),
+            ActionKeyDef("G", "cursor_last_line", "query_visual_line"),
+            ActionKeyDef("g", "g_leader_key", "query_visual_line"),
+            ActionKeyDef("down", "cursor_down", "query_visual_line", primary=False),
+            ActionKeyDef("up", "cursor_up", "query_visual_line", primary=False),
+            ActionKeyDef("enter", "visual_line_execute", "query_visual_line"),
             # Query (insert mode)
             ActionKeyDef("escape", "exit_insert_mode", "query_insert"),
             ActionKeyDef("ctrl+enter", "execute_query_insert", "query_insert"),

sqlit/core/vim.py

@@ -10,3 +10,5 @@ class VimMode(Enum):
 
     NORMAL = "NORMAL"
     INSERT = "INSERT"
+    VISUAL = "VISUAL"
+    VISUAL_LINE = "VISUAL LINE"

sqlit/domains/connections/cli/commands.py

@@ -63,7 +63,7 @@ def _maybe_prompt_plaintext_credentials(services: AppServices) -> bool:
     if not sys.stdin.isatty():
         return False
 
-    answer = input("Keyring isn't available. Save passwords as plaintext in ~/.sqlit/? [y/N]: ").strip().lower()
+    answer = input("Keyring isn't available. Save passwords as plaintext in the sqlit config directory? [y/N]: ").strip().lower()
     allow = answer in {"y", "yes"}
     settings[ALLOW_PLAINTEXT_CREDENTIALS_SETTING] = allow
     services.settings_store.save_all(settings)

sqlit/domains/connections/discovery/cloud/aws/cache.py

@@ -3,18 +3,18 @@
 from __future__ import annotations
 
 import json
-import os
 import time
 from dataclasses import dataclass, field
-from pathlib import Path
 from typing import TYPE_CHECKING
 
+from sqlit.shared.core.store import CONFIG_DIR
+
 if TYPE_CHECKING:
     from .provider import RegionResources
 
 # Cache configuration
 AWS_CACHE_TTL_SECONDS = 300  # 5 minutes
-AWS_CACHE_FILE = Path(os.path.expanduser("~/.config/sqlit/aws_cache.json"))
+AWS_CACHE_FILE = CONFIG_DIR / "aws_cache.json"
 
 
 @dataclass

sqlit/domains/connections/discovery/cloud/azure/cache.py

@@ -3,16 +3,16 @@
 from __future__ import annotations
 
 import json
-import os
 import time
 from dataclasses import dataclass
-from pathlib import Path
+
+from sqlit.shared.core.store import CONFIG_DIR
 
 from .models import AzureSqlServer, AzureSubscription
 
 # Cache configuration
 AZURE_CACHE_TTL_SECONDS = 300  # 5 minutes
-AZURE_CACHE_FILE = Path(os.path.expanduser("~/.config/sqlit/azure_cache.json"))
+AZURE_CACHE_FILE = CONFIG_DIR / "azure_cache.json"
 
 
 @dataclass