pinot-client 1.12.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff1b333b02ecef88a907d5ad1194d7e5a6a320bbd03337a6214d38af0b0995b3
-  data.tar.gz: f547e9d59b9c0ce692ad17d0b15f398b81df605acdb79078510a1987bd15ad8b
+  metadata.gz: cfa501b22e0b1a69addd7cb33728772fb9717f60fd3986c3fd98c31ba0f3d2a9
+  data.tar.gz: 4e20a3f3c908b5da5afd357dcff60139334929ee086fc58ac044732c5c73205b
 SHA512:
-  metadata.gz: ec32bb234ba6ed82303b6d3d3ebd6d33b441f6bc489cef38e7a7adbe21d7f5d025003c3f55d5bab371c14c8a8267f0835be9757e04817249f4274bfc2d7249f0
-  data.tar.gz: 9e133f3c42967560bf7570da11cec1503451542b8bb58acfea33985b94b393bc77ae352a03f8c644870a0e923ed40f20d75685ff1b1e51e539f81a1d188f7484
+  metadata.gz: bb715615d2af17557a6ea45b97c14b8a00079841c28259708b66431f837290cfaa31ae3b863d13bfaf416d78c568f2f8bfe1d2758eded1e6e6081e84203abdd8
+  data.tar.gz: 738c06c6e6c5629a675fe793ccec5ea919dadae5b39c4da39cc6eefcdac88ec9962a8929f6fd016e16367003aa309f8c595450c736e721e55a27dbf3f792d91e

data/README.md

@@ -40,6 +40,22 @@ resp   = client.execute_sql("baseballStats", "SELECT count(*) AS cnt FROM baseba
 puts resp.result_table.get_long(0, 0)  # => 97889
 ```
 
+## Examples
+
+The [`examples/`](examples/) directory contains runnable scripts demonstrating common usage patterns:
+
+- [`basic_query.rb`](examples/basic_query.rb) — simple SQL query and result iteration
+- [`prepared_statement.rb`](examples/prepared_statement.rb) — parameterized queries with PreparedStatement
+- [`controller_discovery.rb`](examples/controller_discovery.rb) — automatic broker discovery via Controller
+- [`instrumentation.rb`](examples/instrumentation.rb) — attaching metrics/logging hooks
+- [`multistage_query.rb`](examples/multistage_query.rb) — multi-stage query engine usage
+
+Run any example against a local Pinot quickstart cluster:
+
+```bash
+ruby examples/basic_query.rb
+```
+
 ## Creating a Connection
 
 ### From a broker list

data/lib/pinot/connection.rb

@@ -25,27 +25,24 @@ module Pinot
       @trace = false
     end
 
-    def execute_sql(table, query)
+    def execute_sql(table, query, query_timeout_ms: nil)
       Pinot::Instrumentation.instrument(table: table, query: query) do
         logger.debug "Executing SQL on table=#{table}: #{query}"
         broker = @broker_selector.select_broker(table)
-        @transport.execute(broker, build_request(query))
+        effective_timeout = query_timeout_ms || @query_timeout_ms
+        @transport.execute(broker, build_request(query, timeout_ms: effective_timeout))
       end
     rescue => e
       raise "unable to execute SQL on table #{table}: #{e.message}"
     end
 
     def execute_sql_with_timeout(table, query, timeout_ms)
-      logger.debug "Executing SQL with timeout=#{timeout_ms}ms on table=#{table}: #{query}"
-      broker = @broker_selector.select_broker(table)
-      @transport.execute(broker, build_request(query, timeout_ms: timeout_ms))
-    rescue => e
-      raise "unable to execute SQL on table #{table}: #{e.message}"
+      execute_sql(table, query, query_timeout_ms: timeout_ms)
     end
 
-    def execute_sql_with_params(table, query_pattern, params)
+    def execute_sql_with_params(table, query_pattern, params, query_timeout_ms: nil)
       query = format_query(query_pattern, params)
-      execute_sql(table, query)
+      execute_sql(table, query, query_timeout_ms: query_timeout_ms)
     rescue => e
       # Re-raise format errors directly (they already have the right message)
       raise e

data/lib/pinot/connection_factory.rb

@@ -22,7 +22,8 @@ module Pinot
         transport: transport,
         broker_selector: selector,
         use_multistage_engine: config.use_multistage_engine || false,
-        logger: config.logger
+        logger: config.logger,
+        query_timeout_ms: config.query_timeout_ms
       )
 
       selector.init
@@ -38,6 +39,7 @@ module Pinot
         http_client: inner,
         extra_headers: config.extra_http_header || {},
         logger: config.logger,
+        timeout_ms: config.query_timeout_ms,
         max_retries: config.max_retries || 0,
         retry_interval_ms: config.retry_interval_ms || 200
       )
@@ -46,7 +48,8 @@ module Pinot
         transport: transport,
         broker_selector: selector,
         use_multistage_engine: config.use_multistage_engine || false,
-        logger: config.logger
+        logger: config.logger,
+        query_timeout_ms: config.query_timeout_ms
       )
     end
 

data/lib/pinot/version.rb

@@ -1,3 +1,3 @@
 module Pinot
-  VERSION = "1.12.0"
+  VERSION = "1.16.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinot-client
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Xiang Fu
@@ -104,6 +104,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/startreedata/ruby-pinot-client
   source_code_uri: https://github.com/startreedata/ruby-pinot-client
+  changelog_uri: https://github.com/startreedata/ruby-pinot-client/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/startreedata/ruby-pinot-client/issues
   github_repo: ssh://git@github.com/startreedata/ruby-pinot-client
 post_install_message: