queryapigate 0.7.1__tar.gz → 0.9.0__tar.gz

{queryapigate-0.7.1/queryapigate.egg-info → queryapigate-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: queryapigate
-Version: 0.7.1
+Version: 0.9.0
 Summary: Turn SQL into a REST API: run queries against MySQL, PostgreSQL, ClickHouse, SQLite or H2 over HTTP and get JSON, CSV, XML, YAML or XLSX back.
 Author-email: Anantha Raju C <arcswdev@gmail.com>
 License-Expression: FSL-1.1-MIT
@@ -41,10 +41,12 @@ Requires-Dist: JayDeBeApi>=1.2; extra == "h2"
 Requires-Dist: JPype1>=1.4; extra == "h2"
 Provides-Extra: duckdb
 Requires-Dist: duckdb>=1.0; extra == "duckdb"
+Provides-Extra: mongo
+Requires-Dist: pymongo>=4.0; extra == "mongo"
 Provides-Extra: encryption
 Requires-Dist: cryptography>=41; extra == "encryption"
 Provides-Extra: all
-Requires-Dist: queryapigate[clickhouse,duckdb,encryption,h2,mysql,postgres]; extra == "all"
+Requires-Dist: queryapigate[clickhouse,duckdb,encryption,h2,mongo,mysql,postgres]; extra == "all"
 Provides-Extra: server
 Requires-Dist: gunicorn>=21; extra == "server"
 Provides-Extra: docs
@@ -74,8 +76,8 @@ Dynamic: license-file
 [**Full documentation**](https://AnanthaRajuC.github.io/QueryAPIGate/)
 
 <p align="center">
-  <a href="https://www.youtube.com/watch?v=aiVbAkA2LS8">
-    <img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/demo-thumbnail.png" alt="Watch the 60-second demo: saved SQL queries as REST endpoints, scoped API keys, and the Move preview showing which keys gain or lose access" width="640">
+  <a href="https://www.youtube.com/watch?v=WWImFj4m95o">
+    <img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/demo-thumbnail.png" alt="Watch the demo: saved SQL queries as REST endpoints, scoped API keys, and the Move preview showing which keys gain or lose access" width="640">
   </a>
 </p>
 
@@ -109,7 +111,7 @@ Crimson Garden,Comedy,PG-13,631,2
 <tr>
 <td width="25%">
 <a href="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/connections.png">
-<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/connections.png" alt="Connections tab listing ClickHouse, MySQL, PostgreSQL and SQLite connections with active/inactive status and each connection's live usage: queries run, failures and average latency">
+<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/connections.png" alt="Connections screen with a sidebar and All/Active/Inactive tabs, listing ClickHouse, MySQL, PostgreSQL and SQLite connections with active/inactive status and each connection's live usage: queries run, failures and average latency">
 </a>
 <br><sub>Manage connections across every supported database, with live usage per connection</sub>
 </td>
@@ -121,13 +123,13 @@ Crimson Garden,Comedy,PG-13,631,2
 </td>
 <td width="25%">
 <a href="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/api-keys.png">
-<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/api-keys.png" alt="API keys tab showing keys created from roles and scoped to a collection (shown as a dashed name/ tag), an expiring partner key, per-key rate limits, and each key's last-used time and live usage">
+<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/api-keys.png" alt="API keys screen showing keys created from roles and scoped to a collection (shown as a dashed name/ tag), an expiring partner key, per-key rate limits, and each key's last-used time and live usage">
 </a>
 <br><sub>Per-key permissions: connections, specific saved queries, expiry, rate limits - and what each key has actually done</sub>
 </td>
 <td width="25%">
 <a href="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/roles.png">
-<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/roles.png" alt="Roles tab listing reusable permission templates - connections, read/write access, rate limit and IP allowlisting - with a New key from this shortcut">
+<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/roles.png" alt="Roles screen listing reusable permission templates - connections, read/write access, rate limit and IP allowlisting - with a New key from this shortcut">
 </a>
 <br><sub>Named roles: a reusable grant template, copied onto a key once at creation</sub>
 </td>
@@ -138,19 +140,19 @@ Crimson Garden,Comedy,PG-13,631,2
 <tr>
 <td width="33%">
 <a href="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/saved-query-history.png">
-<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/saved-query-history.png" alt="A saved query's History tab: every run with its time, connection, calling API key, rows, duration and request ID, with a status filter and search box">
+<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/saved-query-history.png" alt="A saved query's History tab: every run with its time, calling API key, rows, duration and request ID, with a status filter and search box">
 </a>
 <br><sub>Run history per saved query: who called it, how long it took, and the request ID to find it in the logs</sub>
 </td>
 <td width="33%">
 <a href="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/audit-log.png">
-<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/audit-log.png" alt="Audit Log tab listing every administrative change - saved queries, roles and API keys created or updated - with an action filter and search box">
+<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/audit-log.png" alt="Audit log screen listing every administrative change - saved queries, roles and API keys created or updated - with an action filter and search box">
 </a>
 <br><sub>A durable audit log of every configuration change, filterable by action, actor and target</sub>
 </td>
 <td width="33%">
 <a href="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/metrics.png">
-<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/metrics.png" alt="Metrics tab with stat tiles for requests, error rate, active queries, pool and rate limiting, bar charts of requests by status and queries by connection, and a per-connection latency table">
+<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/metrics.png" alt="Metrics screen with stat tiles for requests, error rate, active queries, pool and rate limiting, bars for requests by status and queries by connection, and a per-connection latency table">
 </a>
 <br><sub>Live metrics with no Prometheus required - or import the bundled Grafana dashboard for history</sub>
 </td>
@@ -341,6 +343,11 @@ version management, API key management, an audit log of administrative changes,
 response inspection with a collapsible JSON tree for non-tabular results, a quick bar chart of any numeric
 result, and one-click "copy as curl" / "copy as TSV" for any result.
 
+The UI has a collapsible sidebar (Data, Access, Observability; `Ctrl`+`B` toggles it) and a read-only **Settings**
+screen that shows every environment variable, its effective value and whether it was set or is the default (secrets are
+reported as configured or not, never shown), with a "Copy as .env" button. Theme, table density and the default
+result format are per-browser preferences.
+
 ```text
 Connect Database
        |
@@ -666,6 +673,7 @@ Clean up with `docker compose down -v`.
 | `/api_keys` | GET, POST | List / create scoped API keys (admin only). |
 | `/api_keys/<name>` | PATCH, DELETE | Update / revoke a scoped API key (admin only). |
 | `/audit_log` | GET | Durable record of administrative changes - keys, connections, saved queries (admin only). |
+| `/settings` | GET | The server's own configuration - each setting's effective value and whether it comes from the environment or the default; read-only, secrets never returned (admin only). |
 | `/health`, `/docs`, `/openapi.json` | GET | Liveness, Swagger UI, OpenAPI spec. |
 | `/metrics` | GET | Prometheus text-format metrics: request/query counts and latencies, pool occupancy, rate-limit rejections. |
 | `/ui` | GET | A small admin UI: manage connections and saved queries, run ad-hoc SQL. |

{queryapigate-0.7.1 → queryapigate-0.9.0}/README.md

@@ -14,8 +14,8 @@
 [**Full documentation**](https://AnanthaRajuC.github.io/QueryAPIGate/)
 
 <p align="center">
-  <a href="https://www.youtube.com/watch?v=aiVbAkA2LS8">
-    <img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/demo-thumbnail.png" alt="Watch the 60-second demo: saved SQL queries as REST endpoints, scoped API keys, and the Move preview showing which keys gain or lose access" width="640">
+  <a href="https://www.youtube.com/watch?v=WWImFj4m95o">
+    <img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/demo-thumbnail.png" alt="Watch the demo: saved SQL queries as REST endpoints, scoped API keys, and the Move preview showing which keys gain or lose access" width="640">
   </a>
 </p>
 
@@ -49,7 +49,7 @@ Crimson Garden,Comedy,PG-13,631,2
 <tr>
 <td width="25%">
 <a href="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/connections.png">
-<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/connections.png" alt="Connections tab listing ClickHouse, MySQL, PostgreSQL and SQLite connections with active/inactive status and each connection's live usage: queries run, failures and average latency">
+<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/connections.png" alt="Connections screen with a sidebar and All/Active/Inactive tabs, listing ClickHouse, MySQL, PostgreSQL and SQLite connections with active/inactive status and each connection's live usage: queries run, failures and average latency">
 </a>
 <br><sub>Manage connections across every supported database, with live usage per connection</sub>
 </td>
@@ -61,13 +61,13 @@ Crimson Garden,Comedy,PG-13,631,2
 </td>
 <td width="25%">
 <a href="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/api-keys.png">
-<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/api-keys.png" alt="API keys tab showing keys created from roles and scoped to a collection (shown as a dashed name/ tag), an expiring partner key, per-key rate limits, and each key's last-used time and live usage">
+<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/api-keys.png" alt="API keys screen showing keys created from roles and scoped to a collection (shown as a dashed name/ tag), an expiring partner key, per-key rate limits, and each key's last-used time and live usage">
 </a>
 <br><sub>Per-key permissions: connections, specific saved queries, expiry, rate limits - and what each key has actually done</sub>
 </td>
 <td width="25%">
 <a href="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/roles.png">
-<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/roles.png" alt="Roles tab listing reusable permission templates - connections, read/write access, rate limit and IP allowlisting - with a New key from this shortcut">
+<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/roles.png" alt="Roles screen listing reusable permission templates - connections, read/write access, rate limit and IP allowlisting - with a New key from this shortcut">
 </a>
 <br><sub>Named roles: a reusable grant template, copied onto a key once at creation</sub>
 </td>
@@ -78,19 +78,19 @@ Crimson Garden,Comedy,PG-13,631,2
 <tr>
 <td width="33%">
 <a href="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/saved-query-history.png">
-<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/saved-query-history.png" alt="A saved query's History tab: every run with its time, connection, calling API key, rows, duration and request ID, with a status filter and search box">
+<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/saved-query-history.png" alt="A saved query's History tab: every run with its time, calling API key, rows, duration and request ID, with a status filter and search box">
 </a>
 <br><sub>Run history per saved query: who called it, how long it took, and the request ID to find it in the logs</sub>
 </td>
 <td width="33%">
 <a href="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/audit-log.png">
-<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/audit-log.png" alt="Audit Log tab listing every administrative change - saved queries, roles and API keys created or updated - with an action filter and search box">
+<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/audit-log.png" alt="Audit log screen listing every administrative change - saved queries, roles and API keys created or updated - with an action filter and search box">
 </a>
 <br><sub>A durable audit log of every configuration change, filterable by action, actor and target</sub>
 </td>
 <td width="33%">
 <a href="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/metrics.png">
-<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/metrics.png" alt="Metrics tab with stat tiles for requests, error rate, active queries, pool and rate limiting, bar charts of requests by status and queries by connection, and a per-connection latency table">
+<img src="https://raw.githubusercontent.com/AnanthaRajuC/QueryAPIGate/main/documentation/screenshots/metrics.png" alt="Metrics screen with stat tiles for requests, error rate, active queries, pool and rate limiting, bars for requests by status and queries by connection, and a per-connection latency table">
 </a>
 <br><sub>Live metrics with no Prometheus required - or import the bundled Grafana dashboard for history</sub>
 </td>
@@ -281,6 +281,11 @@ version management, API key management, an audit log of administrative changes,
 response inspection with a collapsible JSON tree for non-tabular results, a quick bar chart of any numeric
 result, and one-click "copy as curl" / "copy as TSV" for any result.
 
+The UI has a collapsible sidebar (Data, Access, Observability; `Ctrl`+`B` toggles it) and a read-only **Settings**
+screen that shows every environment variable, its effective value and whether it was set or is the default (secrets are
+reported as configured or not, never shown), with a "Copy as .env" button. Theme, table density and the default
+result format are per-browser preferences.
+
 ```text
 Connect Database
        |
@@ -606,6 +611,7 @@ Clean up with `docker compose down -v`.
 | `/api_keys` | GET, POST | List / create scoped API keys (admin only). |
 | `/api_keys/<name>` | PATCH, DELETE | Update / revoke a scoped API key (admin only). |
 | `/audit_log` | GET | Durable record of administrative changes - keys, connections, saved queries (admin only). |
+| `/settings` | GET | The server's own configuration - each setting's effective value and whether it comes from the environment or the default; read-only, secrets never returned (admin only). |
 | `/health`, `/docs`, `/openapi.json` | GET | Liveness, Swagger UI, OpenAPI spec. |
 | `/metrics` | GET | Prometheus text-format metrics: request/query counts and latencies, pool occupancy, rate-limit rejections. |
 | `/ui` | GET | A small admin UI: manage connections and saved queries, run ad-hoc SQL. |

{queryapigate-0.7.1 → queryapigate-0.9.0}/pyproject.toml

@@ -35,8 +35,9 @@ postgres = ["psycopg2-binary>=2.9"]
 clickhouse = ["clickhouse-driver>=0.2"]
 h2 = ["JayDeBeApi>=1.2", "JPype1>=1.4"]  # also needs a Java runtime
 duckdb = ["duckdb>=1.0"]  # Connection.interrupt()/InterruptException, relied on for query timeouts, verified from here
+mongo = ["pymongo>=4.0"]
 encryption = ["cryptography>=41"]  # only needed when QUERYAPIGATE_SECRET_KEY is set - see store.py's _get_fernet()
-all = ["queryapigate[mysql,postgres,clickhouse,h2,duckdb,encryption]"]
+all = ["queryapigate[mysql,postgres,clickhouse,h2,duckdb,mongo,encryption]"]
 server = ["gunicorn>=21"]
 docs = ["mkdocs-material>=9,<10"]
 dev = ["queryapigate[all]", "ruff>=0.5", "openapi-spec-validator>=0.7", "hypothesis>=6.100", "mypy>=1.10",

{queryapigate-0.7.1 → queryapigate-0.9.0}/queryapigate/__init__.py

@@ -1,5 +1,5 @@
 """QueryAPIGate - expose SQL databases as a REST API."""
-__version__ = '0.7.1'
+__version__ = '0.9.0'
 
 from .app import create_app  # noqa: E402  (app imports __version__)
 

{queryapigate-0.7.1 → queryapigate-0.9.0}/queryapigate/app.py

@@ -21,6 +21,7 @@ from . import (
     examples,
     logging_setup,
     metrics,
+    mongotools,
     openapi,
     pool,
     postman,
@@ -411,6 +412,12 @@ def execute_sql_endpoint():
     if not data.get('connection_name'):
         raise ApiError('Connection name is missing')
     require_connection(data['connection_name'])
+    database = data.get('database')
+    if database and not g.permission.admin:
+        # Every other scoped-key boundary is per connection, never per database within one - a key granted a
+        # connection may run any SQL that connection's own configured database allows, but not redirect that
+        # same connection at a sibling database on the same server the admin never listed it for.
+        raise ApiError('Only the admin key may run a query against a different database on this connection', 403)
     params = get_object(data.get('params'), 'params')
     output_format = get_output_format(data)
     timeout = get_timeout(data)
@@ -420,7 +427,29 @@ def execute_sql_endpoint():
     limit, offset, page = get_pagination()
     result = engine.execute_sql(data['sql'], data['connection_name'], limit, offset, params, timeout,
                                 allow_writes=g.permission.allow_writes, key_name=caller_key_name(),
-                                allowed_write_ops=g.permission.allowed_write_ops)
+                                allowed_write_ops=g.permission.allowed_write_ops, database=database)
+    return render(result, output_format, page, limit)
+
+
+@bp.route('/execute_mongo', methods=['POST'])
+def execute_mongo_endpoint():
+    """The Mongo sibling of /execute_sql - a find() query, ad-hoc, against a saved connection. Read-only,
+    full stop (BACKLOG #36: MongoDB support is find-only in this version) - unlike /execute_sql there is no
+    write permission to check."""
+    data = get_json_body()
+    if not data.get('collection'):
+        raise ApiError('Collection is missing')
+    if not data.get('connection_name'):
+        raise ApiError('Connection name is missing')
+    require_connection(data['connection_name'])
+    filter_doc = mongotools.validate_filter(get_object(data.get('filter'), 'filter'))
+    params = get_object(data.get('params'), 'params')
+    output_format = get_output_format(data)
+    timeout = get_timeout(data)
+    limit, offset, page = get_pagination()
+    result = engine.execute_mongo(data['collection'], filter_doc, data['connection_name'], limit, offset,
+                                  params, timeout, projection=data.get('projection'), sort=data.get('sort'),
+                                  key_name=caller_key_name())
     return render(result, output_format, page, limit)
 
 
@@ -477,19 +506,24 @@ def run_saved(ref, body, url_params):
                        or apikeys.can_use_collection(g.permission, store.read_collection(content)))
     if not (granted_by_name and connection_name == saved.get('connection_name')):
         require_connection(connection_name)
+
+    raw = {**url_params, **get_object(body.get('params'), 'params'),
+           **get_object(body.get('placeholders'), 'placeholders')}
+    output_format = get_output_format(body)
+    timeout = get_timeout(body)
+
+    if saved.get('query_type') == 'mongo':
+        return run_saved_mongo(saved, path, number, ref, connection_name, raw, output_format, timeout)
+
     if not isinstance(saved.get('sql_query'), str):
         raise ApiError('Saved query has no SQL', 500)
     # Per-query write curation (apikeys.can_write_query()) only ever adds write reach for this one named
     # query on top of whatever the key's blanket allow_writes already grants - never the other way round.
     effective_allow_writes = g.permission.allow_writes or apikeys.can_write_query(g.permission, query_name)
 
-    raw = {**url_params, **get_object(body.get('params'), 'params'),
-           **get_object(body.get('placeholders'), 'placeholders')}
     used = set(sqltools.placeholder_names(saved['sql_query']))
     values = param_rules.resolve(saved.get('query_parameters'), raw, used=used)
     sql = sqltools.fill_placeholders(saved['sql_query'], values)
-    output_format = get_output_format(body)
-    timeout = get_timeout(body)
 
     if get_stream_flag():
         # No caching for a streamed export - caching would require materialising the whole body anyway,
@@ -529,6 +563,32 @@ def run_saved(ref, body, url_params):
     return response
 
 
+def run_saved_mongo(saved, path, number, ref, connection_name, raw, output_format, timeout):
+    """The mongo query_type branch of run_saved(): a find() query instead of SQL. No caching (cache_ttl is
+    not yet supported for a mongo saved query) and no streaming (?stream=true) in this version - see
+    BACKLOG #36. Always read-only, same as the ad-hoc /execute_mongo."""
+    if get_stream_flag():
+        raise ApiError('Streaming is not supported for Mongo queries yet', 400)
+    used = set(mongotools.placeholder_names(saved.get('mongo_filter') or {}))
+    values = param_rules.resolve(saved.get('query_parameters'), raw, used=used)
+    filter_doc = mongotools.fill_placeholders(saved.get('mongo_filter') or {}, values)
+    limit, offset, page = get_pagination()
+    entry = {'executed_at': store.now(), 'connection_name': connection_name,
+             'request_id': g.get('request_id'), 'key_name': caller_key_name()}
+    try:
+        result, elapsed_ms = engine.timed(engine.execute_mongo, saved['mongo_collection'], filter_doc,
+                                          connection_name, limit, offset, timeout=timeout,
+                                          projection=saved.get('mongo_projection'), sort=saved.get('mongo_sort'),
+                                          key_name=caller_key_name())
+    except ApiError as error:
+        store.record_execution(path, number, {**entry, 'status': 'error', 'error': error.message})
+        raise
+    response = render(result, output_format, page, limit)  # sets g.serialization_ms - see render()
+    store.record_execution(path, number, {**entry, 'status': 'success', 'rows': len(result.rows),
+                                          'duration_ms': elapsed_ms, 'serialization_ms': g.serialization_ms})
+    return response
+
+
 @bp.route('/execute_sql_from_file', methods=['POST'])
 @bp.route('/execute_sql_with_parameters_from_file', methods=['POST'])
 def execute_sql_from_file():
@@ -722,13 +782,63 @@ def update_connections():
     return jsonify({'message': 'Connections updated successfully'}), 200
 
 
+@bp.route('/connections/databases', methods=['POST'])
+def list_databases_route():
+    """Every database on the server a connection points at - saved, or not yet saved. Give 'name' alone for
+    an already-saved connection (Run SQL's database picker); give the connection's own fields (as
+    /connections/test does) to probe one that isn't saved yet - the New/Edit connection form's 'Default
+    database' dropdown - or to try changed fields before saving them. Admin only, like every other endpoint
+    that reveals the server's own configuration or reaches into a connection's server ahead of a real query."""
+    require_admin()
+    body = get_json_body()
+    if not isinstance(body, dict):
+        raise ApiError('Connection fields are missing')
+    if body.get('name') and not body.get('db'):
+        databases = schema.list_databases(body['name'])
+    else:
+        if body.get('db') not in config.SUPPORTED_DB_TYPES:
+            raise ApiError(f"'db' must be one of: {', '.join(config.SUPPORTED_DB_TYPES)}")
+        if body.get('password') == config.PASSWORD_MASK:
+            existing = store.read_connections().get(body.get('name') or '', {})
+            body = {**body, 'password': existing.get('password', '')}
+        databases = engine.list_databases(store.resolve_ad_hoc(body))
+    return jsonify({'databases': databases}), 200
+
+
+@bp.route('/connections/test', methods=['POST'])
+def test_connection_route():
+    """Try to connect with the given fields - not a saved connection's name, the fields themselves, exactly
+    as the New/Edit connection form has them right now. Nothing is written anywhere; a masked password
+    (unchanged from an existing connection's form) is resolved to the real stored value first, the same way
+    update_connections() already treats one."""
+    require_admin()
+    details = get_json_body()
+    if not isinstance(details, dict) or details.get('db') not in config.SUPPORTED_DB_TYPES:
+        raise ApiError(f"'db' must be one of: {', '.join(config.SUPPORTED_DB_TYPES)}")
+    if details.get('password') == config.PASSWORD_MASK:
+        existing = store.read_connections().get(details.get('name') or '', {})
+        details = {**details, 'password': existing.get('password', '')}
+    result = engine.test_connection(store.resolve_ad_hoc(details))
+    return jsonify({'message': 'Connected', **result}), 200
+
+
 @bp.route('/connections/<name>', methods=['DELETE'])
 def delete_connection(name):
+    """Deleting a connection is destructive and hard to reason about after the fact - every saved query that
+    used it stops working - so the caller must say why. The reason is stored nowhere but the audit log (there
+    is no separate "deleted connections" table); the admin UI's own Deleted tab reads it straight from there,
+    the same as everything else on this route already does."""
     require_admin()
     before = store.read_connections().get(name)
+    if before is None:
+        raise ApiError(f"Connection '{name}' not found", 404)
+    data = get_json_body(required=False)
+    reason = (data.get('reason') or '').strip()
+    if not reason:
+        raise ApiError('A reason is required to delete a connection')
     store.delete_connection(name)
-    if before is not None:
-        store.record_audit(caller_key_name(), 'delete_connection', name, store.mask_passwords({name: before})[name])
+    changes = {**store.mask_passwords({name: before})[name], 'deleted_reason': reason}
+    store.record_audit(caller_key_name(), 'delete_connection', name, changes)
     pool.close_pooled_connections()  # a removed connection must not keep serving from idle sockets
     return jsonify({'message': f"Connection '{name}' deleted"}), 200
 
@@ -736,7 +846,10 @@ def delete_connection(name):
 @bp.route('/connections/<name>/schema', methods=['GET'])
 def connection_schema(name):
     require_connection(name)
-    return jsonify(schema.fetch_schema(name)), 200
+    database = request.args.get('database') or None
+    if database and not g.permission.admin:
+        raise ApiError('Only the admin key may browse a different database on this connection', 403)
+    return jsonify(schema.fetch_schema(name, database=database)), 200
 
 
 # --------------------------------------------------------------------------------------
@@ -846,6 +959,16 @@ def audit_log_endpoint():
     return jsonify({'entries': list(reversed(store.read_audit_log()))}), 200
 
 
+@bp.route('/settings', methods=['GET'])
+def settings_endpoint():
+    """The server's own configuration as the admin UI's Settings screen shows it: every environment variable
+    that matters, its effective value and whether it was set or is the default. Read-only, and admin only
+    like the rest of what reveals the server's configuration. Secrets are reported as configured or not,
+    never returned."""
+    require_admin()
+    return jsonify({'sections': config.describe_settings()}), 200
+
+
 # --------------------------------------------------------------------------------------
 # Service endpoints
 # --------------------------------------------------------------------------------------
@@ -871,6 +994,14 @@ def metrics_endpoint():
     return Response(metrics.render(), mimetype='text/plain; version=0.0.4; charset=utf-8')
 
 
+def _is_runnable(data):
+    """Whether a saved-query version has something to actually execute - a SQL string, or (query_type
+    'mongo') a Mongo collection - so a definition left mid-edit or otherwise malformed never gets listed
+    somewhere a caller might then try to run it."""
+    return isinstance(data.get('sql_query'), str) or (data.get('query_type') == 'mongo'
+                                                       and isinstance(data.get('mongo_collection'), str))
+
+
 def describe_saved_queries(permission):
     """What the OpenAPI document needs to know about each saved query (never its SQL text) that
     ``permission`` may actually call - the same test run_saved() applies, so a key scoped to specific
@@ -878,8 +1009,7 @@ def describe_saved_queries(permission):
     unrestricted (admin, or connection-wide) key sees everything, unchanged from before this filter."""
     described = []
     for name, number, data, collection in store.latest_versions():
-        sql = data.get('sql_query')
-        if not isinstance(sql, str):
+        if not _is_runnable(data):
             continue
         connection_name = data.get('connection_name')
         if not apikeys.can_run_saved(permission, name, collection, connection_name):
@@ -910,8 +1040,7 @@ def describe_catalog(permission):
     caller* can write through it (apikeys.can_write_query() - independent of their blanket allow_writes)."""
     catalog = []
     for name, number, data, collection in store.latest_versions():
-        sql = data.get('sql_query')
-        if not isinstance(sql, str):
+        if not _is_runnable(data):
             continue
         connection_name = data.get('connection_name')
         if not apikeys.can_run_saved(permission, name, collection, connection_name):

{queryapigate-0.7.1 → queryapigate-0.9.0}/queryapigate/bundle.py

@@ -18,7 +18,8 @@ FORMAT_VERSION = 1
 POLICIES = ('fail', 'skip', 'new-version')
 # Everything an entry may carry. Anything else is an error rather than silently dropped: a field the importer
 # ignores is a field whose loss nobody notices.
-ENTRY_FIELDS = {'name', 'sql_query', 'author', 'description', 'tags', 'query_parameters', 'connection_name',
+ENTRY_FIELDS = {'name', 'sql_query', 'query_type', 'mongo_collection', 'mongo_filter', 'mongo_projection',
+                'mongo_sort', 'author', 'description', 'tags', 'query_parameters', 'connection_name',
                 'cache_ttl'}
 
 

{queryapigate-0.7.1 → queryapigate-0.9.0}/queryapigate/config.py

@@ -3,7 +3,7 @@ import os
 import re
 from pathlib import Path
 
-SUPPORTED_DB_TYPES = ('mysql', 'postgres', 'clickhouse', 'sqlite', 'h2', 'jdbc', 'duckdb')
+SUPPORTED_DB_TYPES = ('mysql', 'postgres', 'clickhouse', 'sqlite', 'h2', 'jdbc', 'duckdb', 'mongo')
 PASSWORD_MASK = '********'
 CONNECT_TIMEOUT = 10  # seconds
 HISTORY_LIMIT = 50  # executions remembered per saved-query version
@@ -278,3 +278,80 @@ def slow_query_threshold():
     if value == 0:
         return None
     return value if value > 0 else DEFAULT_SLOW_QUERY_THRESHOLD
+
+
+def _seconds(value):
+    return None if value is None else f'{value:g} s'
+
+
+def describe_settings():
+    """Every server setting the admin UI's Settings screen shows, grouped: [{id, title, description, rows}].
+
+    Each row is {label, description, env, value, source, env_value}. ``value`` is what to display (secrets are
+    reduced to "configured" / "enabled" - never the secret itself), ``source`` is "env" when the variable is set
+    and "default" when the built-in default applies, and ``env_value`` is the raw value for a "copy as .env"
+    export, or None for a secret so that export can never leak one. Read-only: settings are environment
+    variables, changed by restarting the server, not through the API."""
+    def row(label, description, env, value, secret=False):
+        raw = os.environ.get(env, '').strip()
+        return {'label': label, 'description': description, 'env': env, 'value': value,
+                'source': 'env' if raw else 'default', 'env_value': None if secret or not raw else raw}
+
+    def on_off(flag):
+        return 'on' if flag else 'off'
+
+    stream = stream_max_rows()
+    timeout, slow = query_timeout(), slow_query_threshold()
+    limit, export = rate_limit(), audit_log_export_file()
+    cors = cors_origins()
+    return [
+        {'id': 'general', 'title': 'General',
+         'description': 'Where this server keeps its files and what it loads at startup.', 'rows': [
+            row('Home directory', 'Folder holding db_connections.json, api_keys.json, roles.json and saved_sql/.',
+                'QUERYAPIGATE_HOME', str(home())),
+            row('Load examples', 'Load the example APIs at startup. Idempotent.',
+                'QUERYAPIGATE_LOAD_EXAMPLES', on_off(load_examples())),
+            row('H2 driver', 'JAR used for h2 connections.', 'QUERYAPIGATE_H2_JAR',
+                Path(h2_jar()).name + ('' if os.environ.get('QUERYAPIGATE_H2_JAR') else ' (bundled)'))]},
+        {'id': 'security', 'title': 'Security',
+         'description': 'Admin access, write protection and secrets at rest.', 'rows': [
+            row('Admin API key', 'Key with full access to this UI and the admin API. Unset means open access.',
+                'QUERYAPIGATE_API_KEY', 'configured' if api_key() else 'not set - open access', secret=True),
+            row('Allow writes', 'When off, statements that modify data are rejected.',
+                'QUERYAPIGATE_ALLOW_WRITES', on_off(allow_writes())),
+            row('Encryption at rest', 'Fernet key used to encrypt connection passwords on disk.',
+                'QUERYAPIGATE_SECRET_KEY', 'enabled' if secret_key() else 'off', secret=True),
+            row('Trusted proxy hops', 'Reverse proxies whose X-Forwarded-* headers are trusted.',
+                'QUERYAPIGATE_TRUST_PROXY', str(proxy_hops()))]},
+        {'id': 'execution', 'title': 'Query execution',
+         'description': 'Limits applied to every statement this server runs.', 'rows': [
+            row('Query timeout', 'Server-wide statement limit. A request may ask for less, never more. '
+                '0 disables it.', 'QUERYAPIGATE_QUERY_TIMEOUT', _seconds(timeout) or 'off'),
+            row('Max page size', 'Largest page_size a caller may request.', 'QUERYAPIGATE_MAX_PAGE_SIZE',
+                f'{max_page_size()} rows'),
+            row('Stream row cap', 'Row cap for ?stream=true exports.', 'QUERYAPIGATE_STREAM_MAX_ROWS',
+                'unbounded' if stream is None else f'{stream} rows'),
+            row('Slow query threshold', 'Queries slower than this are logged as warnings. 0 disables it.',
+                'QUERYAPIGATE_SLOW_QUERY_THRESHOLD', _seconds(slow) or 'off')]},
+        {'id': 'pool', 'title': 'Connection pool',
+         'description': 'Idle connections kept open per distinct connection.', 'rows': [
+            row('Pool size', 'Idle connections kept per connection. 0 disables pooling.',
+                'QUERYAPIGATE_POOL_SIZE', str(pool_size())),
+            row('Idle timeout', 'How long an idle pooled connection is kept before it is closed.',
+                'QUERYAPIGATE_POOL_IDLE_TIMEOUT', _seconds(pool_idle_timeout()))]},
+        {'id': 'traffic', 'title': 'Rate limits & CORS',
+         'description': 'Per-client throttling and browser origins allowed to call the API.', 'rows': [
+            row('Rate limit', 'Requests allowed per client. API keys and roles can set their own.',
+                'QUERYAPIGATE_RATE_LIMIT', format_rate_limit(limit) or 'off'),
+            row('CORS origins', 'Comma-separated origins, or * for any. Unset turns CORS off.',
+                'QUERYAPIGATE_CORS_ORIGINS',
+                'off' if cors is None else '*' if cors == '*' else ', '.join(sorted(cors)))]},
+        {'id': 'audit', 'title': 'Audit & logging',
+         'description': 'Retention of administrative actions and log format.', 'rows': [
+            row('Audit log limit', 'Entries kept in audit_log.json.', 'QUERYAPIGATE_AUDIT_LOG_LIMIT',
+                str(audit_log_limit())),
+            row('Audit export file', 'Append-only JSON-lines copy of every audit entry, never rolled off.',
+                'QUERYAPIGATE_AUDIT_LOG_EXPORT_FILE', 'not set' if export is None else str(export)),
+            row('JSON logs', 'One JSON object per line instead of plain text.', 'QUERYAPIGATE_JSON_LOGS',
+                on_off(json_logs()))]},
+    ]