From 912293db18f09ded2b061b2e1ef73b9886fa9e35 Mon Sep 17 00:00:00 2001 From: AlejandroFabianCampos Date: Fri, 13 Nov 2026 14:57:06 -0300 Subject: [PATCH] fix(sql): handle query responses without credits --- crates/core/README.md | 2 +- crates/core/examples/sql.rs | 5 ++++- crates/core/src/sql/mod.rs | 24 ++++++++++++++++++++++-- crates/node/src/sql.rs | 2 +- crates/python/src/sql.rs | 2 +- npm/README.md | 2 +- npm/index.d.ts | 2 +- python/README.md | 2 +- python/quicknode_sdk/_core/__init__.pyi | 2 +- ruby/README.md | 2 +- 10 files changed, 34 insertions(+), 11 deletions(-) diff --git a/crates/core/README.md b/crates/core/README.md index 91c9ed4..2bbac79 100644 --- a/crates/core/README.md +++ b/crates/core/README.md @@ -2020,7 +2020,7 @@ Executes a SQL query against a cluster and returns the result set. Paginate by w **Parameters**: `QueryParams` with `query` (String, required) and `cluster_id` (String, required). -**Returns**: `QueryResponse` — `meta` (`Vec`, each with `name` and `column_type`), `data` (`Vec`, rows as JSON objects keyed by column name), `rows`, `rows_before_limit_at_least`, `statistics` (`QueryStatistics` with `elapsed`, `rows_read`, `bytes_read`), and `credits`. +**Returns**: `QueryResponse` — `meta` (`Vec`, each with `name` and `column_type`), `data` (`Vec`, rows as JSON objects keyed by column name), `rows`, `rows_before_limit_at_least`, `statistics` (`QueryStatistics` with `elapsed`, `rows_read`, `bytes_read`), and `credits` (`Option`, absent when not reported). ```rust // Rust diff --git a/crates/core/examples/sql.rs b/crates/core/examples/sql.rs index 07323d3..9f699dd 100644 --- a/crates/core/examples/sql.rs +++ b/crates/core/examples/sql.rs @@ -40,7 +40,10 @@ async fn main() { Ok(resp) => { println!( "query: {} rows ({} before limit), {} credits, {:.4}s", - resp.rows, resp.rows_before_limit_at_least, resp.credits, resp.statistics.elapsed + resp.rows, + resp.rows_before_limit_at_least, + resp.credits.unwrap_or_default(), + resp.statistics.elapsed ); println!( "columns: {:?}", diff --git a/crates/core/src/sql/mod.rs b/crates/core/src/sql/mod.rs index 812f34a..8773536 100644 --- a/crates/core/src/sql/mod.rs +++ b/crates/core/src/sql/mod.rs @@ -154,7 +154,7 @@ pub struct QueryResponse { /// Query execution statistics. pub statistics: QueryStatistics, /// Credits consumed by the query. - pub credits: i64, + pub credits: Option, } // ── Schema response types ────────────────────────────────────────────────── @@ -441,7 +441,7 @@ mod tests { let resp = sdk.sql.query(&query_params()).await.unwrap(); assert_eq!(resp.rows, 2); assert_eq!(resp.rows_before_limit_at_least, 18251); - assert_eq!(resp.credits, 135); + assert_eq!(resp.credits, Some(135)); assert_eq!(resp.meta.len(), 2); assert_eq!(resp.meta[0].name, "time"); assert_eq!(resp.statistics.rows_read, 31341); @@ -475,6 +475,26 @@ mod tests { sdk.sql.query(&query_params()).await.unwrap(); } + #[tokio::test] + async fn query_without_credits() { + let server = MockServer::start().await; + Mock::given(method("POST")) + .and(path("/query")) + .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({ + "meta": [{"name": "1", "type": "UInt8"}], + "data": [{"1": 1}], + "rows": 1, + "rows_before_limit_at_least": 1, + "statistics": {"elapsed": 0.001, "rows_read": 1, "bytes_read": 1} + }))) + .mount(&server) + .await; + let sdk = make_sdk(format!("{}/", server.uri())); + let resp = sdk.sql.query(&query_params()).await.unwrap(); + assert_eq!(resp.rows, 1); + assert_eq!(resp.credits, None); + } + #[tokio::test] async fn query_api_error() { let server = MockServer::start().await; diff --git a/crates/node/src/sql.rs b/crates/node/src/sql.rs index f9e8b04..3338d91 100644 --- a/crates/node/src/sql.rs +++ b/crates/node/src/sql.rs @@ -62,7 +62,7 @@ pub struct QueryResponseNode { /// Query execution statistics. pub statistics: QueryStatisticsNode, /// Credits consumed by the query. - pub credits: i64, + pub credits: Option, } impl From for QueryResponseNode { diff --git a/crates/python/src/sql.rs b/crates/python/src/sql.rs index 1385a7f..3fbbca4 100644 --- a/crates/python/src/sql.rs +++ b/crates/python/src/sql.rs @@ -21,7 +21,7 @@ pub struct PyQueryResponse { #[pyo3(get)] pub statistics: QueryStatistics, #[pyo3(get)] - pub credits: i64, + pub credits: Option, } impl PyQueryResponse { diff --git a/npm/README.md b/npm/README.md index eec33f2..fb7575a 100644 --- a/npm/README.md +++ b/npm/README.md @@ -1861,7 +1861,7 @@ Executes a SQL query against a cluster and returns the result set. Paginate by w **Parameters**: `query` (string, required), `cluster_id` / `clusterId` (string, required). -**Returns**: a query result — `meta` (column metadata, each with `name` and `type`), `data` (rows as objects keyed by column name), `rows`, `rows_before_limit_at_least` / `rowsBeforeLimitAtLeast`, `statistics` (`elapsed`, `rows_read`/`rowsRead`, `bytes_read`/`bytesRead`), and `credits`. +**Returns**: a query result — `meta` (column metadata, each with `name` and `type`), `data` (rows as objects keyed by column name), `rows`, `rows_before_limit_at_least` / `rowsBeforeLimitAtLeast`, `statistics` (`elapsed`, `rows_read`/`rowsRead`, `bytes_read`/`bytesRead`), and `credits` (optional). ```typescript // Node.js diff --git a/npm/index.d.ts b/npm/index.d.ts index 1eb2915..ea4796f 100644 --- a/npm/index.d.ts +++ b/npm/index.d.ts @@ -3945,7 +3945,7 @@ export interface QueryResponseNode { /** Query execution statistics. */ statistics: QueryStatisticsNode /** Credits consumed by the query. */ - credits: number + credits?: number } export interface QueryStatisticsNode { diff --git a/python/README.md b/python/README.md index 76cb16e..219a013 100644 --- a/python/README.md +++ b/python/README.md @@ -1856,7 +1856,7 @@ Executes a SQL query against a cluster and returns the result set. Paginate by w **Parameters**: `query` (str, required), `cluster_id` (str, required). -**Returns**: `QueryResponse` — `meta` (list of `ColumnMeta`, each with `name` and `column_type`), `data` (`list[dict]`, rows keyed by column name), `rows`, `rows_before_limit_at_least`, `statistics` (`QueryStatistics` with `elapsed`, `rows_read`, `bytes_read`), and `credits`. +**Returns**: `QueryResponse` — `meta` (list of `ColumnMeta`, each with `name` and `column_type`), `data` (`list[dict]`, rows keyed by column name), `rows`, `rows_before_limit_at_least`, `statistics` (`QueryStatistics` with `elapsed`, `rows_read`, `bytes_read`), and `credits` (optional). ```python # Python diff --git a/python/quicknode_sdk/_core/__init__.pyi b/python/quicknode_sdk/_core/__init__.pyi index 39fd756..46b0dac 100644 --- a/python/quicknode_sdk/_core/__init__.pyi +++ b/python/quicknode_sdk/_core/__init__.pyi @@ -7364,7 +7364,7 @@ class QueryResponse: @property def statistics(self) -> QueryStatistics: ... @property - def credits(self) -> builtins.int: ... + def credits(self) -> typing.Optional[builtins.int]: ... @property def data(self) -> list[dict[str, typing.Any]]: ... diff --git a/ruby/README.md b/ruby/README.md index 54545fb..85b3238 100644 --- a/ruby/README.md +++ b/ruby/README.md @@ -1869,7 +1869,7 @@ Executes a SQL query against a cluster and returns the result set. Paginate by w **Parameters** (Hash): `query:` (String, required), `cluster_id:` (String, required). -**Returns** a Hash with `meta` (column metadata, each with `name` and `type`), `data` (rows as Hashes keyed by column name), `rows`, `rows_before_limit_at_least`, `statistics` (`elapsed`, `rows_read`, `bytes_read`), and `credits`. Access with `[]` or `dig`. +**Returns** a Hash with `meta` (column metadata, each with `name` and `type`), `data` (rows as Hashes keyed by column name), `rows`, `rows_before_limit_at_least`, `statistics` (`elapsed`, `rows_read`, `bytes_read`), and `credits` (may be `nil`). Access with `[]` or `dig`. ```ruby # Ruby