quicknode_sdk 0.4.0-x86_64-linux → 0.5.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0cc62b41ce1ccfe58aae591f19031672ec62d55cb42e414c9f3567da9e5fac4
-  data.tar.gz: 67b845d63c6663806efe2f1ada01db25e932aa1f61e48be1a0a95910d9505eed
+  metadata.gz: cdd0567be01e72a476fed68f5fb0a298c7777c6048971c32218d78485ada5c61
+  data.tar.gz: 490893c43810b35f1240fcb792371f46960912fac3300cc5040ac68bc107b696
 SHA512:
-  metadata.gz: 80accd7f523a3a36220c7fa85afab17dffceee9a61c828858fa4b92c91d335cc2ad6643bf9bda792005d42b92ea0b4a65f496b6ce25251869f76d8a9ed98685c
-  data.tar.gz: aa30812e7fca37b93cb6944208eb7a96de650a5e7708ca4e1d05533ea3ab3cf14397ed6cc0e5b281f44b11b21d33fb6ca7466f718246e89a8b8699221164326a
+  metadata.gz: 92b6525f4e7cbf807118f8e904a9dd07671611d78ee5dbd38669580f9320a1cb433829454dc2da22855cbfeab3b131296b62b6d3a3664eea1d40905d92cae653
+  data.tar.gz: 668bd756854567423ad1f5a35d0efc48e0c61420b501734802a29e0a31ddbdcb32f012506ceafb499a2024d1838e87324dfe6d8b5bd85ef26d0119bb88abb43b

data/README.md

@@ -46,6 +46,7 @@ This is one of four language bindings published from the same Rust core. See the
   - [KV Store Client](#kv-store-client)
     - [Sets](#sets)
     - [Lists](#lists)
+  - [SQL Client](#sql-client)
 - [Error Handling](#error-handling)
 - [License](#license)
 
@@ -55,7 +56,7 @@ This is one of four language bindings published from the same Rust core. See the
 
 ## Quick Start
 
-Construct the SDK once, then reach into the four sub-clients (`admin`, `streams`, `webhooks`, `kvstore`). Subsequent API Reference snippets assume you have a `qn` handle from one of these blocks.
+Construct the SDK once, then reach into the five sub-clients (`admin`, `streams`, `webhooks`, `kvstore`, `sql`). Subsequent API Reference snippets assume you have a `qn` handle from one of these blocks.
 
 ```ruby
 # Ruby
@@ -94,6 +95,7 @@ Environment variables (prefix `QN_SDK__`, separator `__`):
 | `QN_SDK__STREAMS__BASE_URL` | no | `https://api.quicknode.com/streams/rest/v1/` | Override streams base URL |
 | `QN_SDK__WEBHOOKS__BASE_URL` | no | `https://api.quicknode.com/webhooks/rest/v1/` | Override webhooks base URL |
 | `QN_SDK__KVSTORE__BASE_URL` | no | `https://api.quicknode.com/kv/rest/v1/` | Override KV store base URL |
+| `QN_SDK__SQL__BASE_URL` | no | `https://api.quicknode.com/sql/rest/v1/` | Override SQL Explorer base URL |
 | `QN_SDK__HTTP__HEADERS__<NAME>` | no | — | Custom HTTP header sent on every request. Overrides SDK-managed headers (see below). |
 
 ### Custom headers and `User-Agent`
@@ -1613,6 +1615,44 @@ Deletes a list and all of its items.
 qn.kvstore.delete_list(key: "my-list")
 ```
 
+---
+
+### SQL Client
+
+Accessed as `qn.sql`. Runs SQL queries against indexed blockchain data and fetches the database schema. Backed by `https://api.quicknode.com/sql/rest/v1/`.
+
+##### `query`
+
+Executes a SQL query against a cluster and returns the result set. Paginate by writing `LIMIT`/`OFFSET` into the SQL.
+
+**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`.
+
+```ruby
+# Ruby
+resp = qn.sql.query(
+  query: "SELECT action_type, user FROM hyperliquid_system_actions ORDER BY block_time DESC LIMIT 100",
+  cluster_id: "hyperliquid-core-mainnet"
+)
+puts resp[:rows]
+puts resp[:data].first
+```
+
+##### `get_schema`
+
+Fetches the database schema for a cluster: table names, columns, types, sort keys, and partition strategies.
+
+**Parameters** (Hash): `cluster_id:` (String, required).
+
+**Returns** a Hash with `chain`, `cluster_id`, and `tables` (each with `name`, `engine`, `total_rows`, `partition_key`, `sorting_key`, and `columns` of `{ name, type }`).
+
+```ruby
+# Ruby
+schema = qn.sql.get_schema(cluster_id: "hyperliquid-core-mainnet")
+puts schema[:tables].length
+```
+
 ## Error Handling
 
 Every binding exposes a typed exception hierarchy derived from the core `SdkError`

data/lib/quicknode_sdk/clients/sql.rb

@@ -0,0 +1,4 @@
+module QuicknodeSdk
+  class Sql < NativeDelegator
+  end
+end

data/lib/quicknode_sdk/sdk.rb

@@ -34,5 +34,9 @@ module QuicknodeSdk
     def kvstore
       KvStore.new(@native.kvstore)
     end
+
+    def sql
+      Sql.new(@native.sql)
+    end
   end
 end

data/lib/quicknode_sdk.rb

@@ -13,4 +13,5 @@ require_relative "quicknode_sdk/clients/admin"
 require_relative "quicknode_sdk/clients/streams"
 require_relative "quicknode_sdk/clients/webhooks"
 require_relative "quicknode_sdk/clients/kvstore"
+require_relative "quicknode_sdk/clients/sql"
 require_relative "quicknode_sdk/sdk"

data/sig/quicknode_sdk.rbs

@@ -33,6 +33,7 @@ module QuicknodeSdk
     def streams: () -> Streams
     def webhooks: () -> Webhooks
     def kvstore: () -> KvStore
+    def sql: () -> Sql
   end
 
   class DestinationAttributes
@@ -158,4 +159,11 @@ module QuicknodeSdk
     def delete_list_item: (key: String, item: String) -> void
     def delete_list: (key: String) -> void
   end
+
+  class Sql
+    def initialize: (untyped native) -> void
+
+    def query: (query: String, cluster_id: String) -> untyped
+    def get_schema: (cluster_id: String) -> untyped
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quicknode_sdk
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: x86_64-linux
 authors:
 - Quicknode
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-24 00:00:00.000000000 Z
+date: 2026-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -34,6 +34,7 @@ files:
 - lib/quicknode_sdk.rb
 - lib/quicknode_sdk/clients/admin.rb
 - lib/quicknode_sdk/clients/kvstore.rb
+- lib/quicknode_sdk/clients/sql.rb
 - lib/quicknode_sdk/clients/streams.rb
 - lib/quicknode_sdk/clients/webhooks.rb
 - lib/quicknode_sdk/native_delegator.rb