pinot-client 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1859bffb975457a69f7eb417283f2e4671c5f53b1f7e12b9509ea0704f89c74f
+  data.tar.gz: ed8f59fe262df5a4a1133b8dfcac0765066c20528d6f7c9e2fd0326524bf0999
+SHA512:
+  metadata.gz: 9e64c60e9cff0130ae77c31fe7898223d9dfe4c95015fb6a40e8a54b1afb3de601c1b58fbde3940e132c07365ebd19cbf56e35746a50d15e3b76913a187111d5
+  data.tar.gz: 0653ae3c8241944ceaa4fc982c45e277ca057c4a938754c4b5873d1cf75257c720cd8adeeabb0315ca2401e2268270bad3fc394f9ae6eebab868fdfa8f257490

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,214 @@
+# Ruby Pinot Client
+
+[![Build Status](https://github.com/startreedata/ruby-pinot-client/actions/workflows/tests.yml/badge.svg)](https://github.com/startreedata/ruby-pinot-client/actions/workflows/tests.yml)
+[![Gem Version](https://img.shields.io/github/v/release/startreedata/ruby-pinot-client?label=gem)](https://github.com/startreedata/ruby-pinot-client/releases)
+
+A Ruby client library for [Apache Pinot](https://pinot.apache.org/). Mirrors the API of the [Go client](https://github.com/startreedata/pinot-client-go) and supports HTTP JSON transport, multiple broker discovery strategies, and parameterized queries.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem "pinot-client", "~> 1.0"
+```
+
+Or install directly:
+
+```bash
+gem install pinot-client
+```
+
+## Quick Start
+
+Start a local Pinot cluster using Docker:
+
+```bash
+docker run -d \
+  --name pinot-quickstart \
+  -p 8000:8000 \
+  apachepinot/pinot:1.5.0 QuickStart -type BATCH
+```
+
+Then query it from Ruby:
+
+```ruby
+require "pinot"
+
+client = Pinot.from_broker_list(["localhost:8000"])
+resp   = client.execute_sql("baseballStats", "SELECT count(*) AS cnt FROM baseballStats")
+puts resp.result_table.get_long(0, 0)  # => 97889
+```
+
+## Creating a Connection
+
+### From a broker list
+
+```ruby
+client = Pinot.from_broker_list(["localhost:8000"])
+```
+
+For HTTPS brokers, include the scheme:
+
+```ruby
+client = Pinot.from_broker_list(["https://pinot-broker.example.com"])
+```
+
+### From a controller (dynamic broker discovery)
+
+The client periodically polls the controller's `/v2/brokers/tables` API and automatically picks up broker changes.
+
+```ruby
+client = Pinot.from_controller("localhost:9000")
+```
+
+### From a `ClientConfig`
+
+```ruby
+config = Pinot::ClientConfig.new(
+  broker_list:           ["localhost:8000"],
+  http_timeout:          10,          # seconds
+  extra_http_header:     { "Authorization" => "Bearer <token>" },
+  use_multistage_engine: false,
+  controller_config: Pinot::ControllerConfig.new(
+    controller_address:            "localhost:9000",
+    update_freq_ms:                1000,
+    extra_controller_api_headers:  { "Authorization" => "Bearer <token>" }
+  )
+)
+client = Pinot.from_config(config)
+```
+
+## Executing Queries
+
+### Simple SQL
+
+```ruby
+resp = client.execute_sql("baseballStats", "SELECT playerName, homeRuns FROM baseballStats LIMIT 5")
+```
+
+### Parameterized queries
+
+Use `?` placeholders — the client substitutes and quotes values safely:
+
+```ruby
+resp = client.execute_sql_with_params(
+  "baseballStats",
+  "SELECT playerName FROM baseballStats WHERE teamID = ? AND yearID >= ?",
+  ["SFN", 2000]
+)
+```
+
+### Multistage engine
+
+```ruby
+client.use_multistage_engine = true
+resp = client.execute_sql("baseballStats", "SELECT teamID, count(*) FROM baseballStats GROUP BY teamID")
+```
+
+### Trace
+
+```ruby
+client.open_trace
+resp = client.execute_sql("baseballStats", "SELECT count(*) FROM baseballStats")
+client.close_trace
+```
+
+## Reading Results
+
+`execute_sql` returns a `Pinot::BrokerResponse`. Results are in `result_table`:
+
+```ruby
+rt = resp.result_table
+
+rt.row_count          # => number of rows
+rt.column_count       # => number of columns
+rt.column_name(0)     # => "playerName"
+rt.column_data_type(0)# => "STRING"
+
+rt.get(0, 0)          # => raw cell value (Pinot::JsonNumber or String)
+rt.get_string(0, 0)   # => String
+rt.get_int(0, 1)      # => Integer (32-bit)
+rt.get_long(0, 1)     # => Integer (64-bit)
+rt.get_float(0, 2)    # => Float (32-bit range)
+rt.get_double(0, 2)   # => Float (64-bit)
+```
+
+Stat fields on `BrokerResponse`:
+
+```ruby
+resp.time_used_ms
+resp.num_docs_scanned
+resp.total_docs
+resp.exceptions         # => Array<Pinot::PinotException>
+resp.num_groups_limit_reached
+```
+
+## Prepared Statements
+
+Prepared statements are thread-safe and can be reused with different parameters.
+
+```ruby
+stmt = client.prepare(
+  "baseballStats",
+  "SELECT playerName, sum(homeRuns) AS hr FROM baseballStats WHERE teamID = ? AND yearID >= ? GROUP BY playerName ORDER BY hr DESC LIMIT ?"
+)
+
+stmt.set_string(1, "NYA")
+stmt.set_int(2, 2000)
+stmt.set_int(3, 10)
+resp = stmt.execute
+
+# Or pass params inline:
+resp = stmt.execute_with_params("BOS", 2000, 5)
+
+# Reuse with new parameters:
+stmt.clear_parameters
+stmt.set_string(1, "LAA")
+stmt.set_int(2, 2005)
+stmt.set_int(3, 3)
+resp = stmt.execute
+
+stmt.close
+```
+
+### Supported parameter types
+
+| Ruby type    | SQL rendering          |
+|--------------|------------------------|
+| `String`     | `'value'` (single-quote escaped) |
+| `Integer`    | `42`                   |
+| `Float`      | `3.14`                 |
+| `TrueClass` / `FalseClass` | `true` / `false` |
+| `BigDecimal` | `'1234567890'`         |
+| `Time`       | `'2023-01-01 12:00:00.000'` |
+
+## Running Tests
+
+### Unit tests
+
+```bash
+bundle install
+bundle exec rspec spec/pinot/
+```
+
+### Integration tests (requires a running Pinot cluster)
+
+```bash
+docker run -d --name pinot-quickstart -p 8000:8000 \
+  apachepinot/pinot:1.5.0 QuickStart -type BATCH
+
+# wait ~2 minutes for the cluster to load data, then:
+bundle exec rspec spec/integration/ --format documentation
+```
+
+Environment variables:
+
+| Variable      | Default     | Description             |
+|---------------|-------------|-------------------------|
+| `BROKER_HOST` | `127.0.0.1` | Pinot broker hostname   |
+| `BROKER_PORT` | `8000`      | Pinot broker HTTP port  |
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE).

data/lib/pinot/broker_selector.rb

@@ -0,0 +1,7 @@
+module Pinot
+  module BrokerSelector
+    # Implementers must define:
+    #   def init        -> nil or raise on failure
+    #   def select_broker(table) -> String "host:port" or raise
+  end
+end

data/lib/pinot/config.rb

@@ -0,0 +1,30 @@
+module Pinot
+  class ControllerConfig
+    attr_accessor :controller_address, :update_freq_ms, :extra_controller_api_headers
+
+    def initialize(controller_address: nil, update_freq_ms: 1000, extra_controller_api_headers: {})
+      @controller_address = controller_address
+      @update_freq_ms = update_freq_ms
+      @extra_controller_api_headers = extra_controller_api_headers
+    end
+  end
+
+  class ClientConfig
+    attr_accessor :broker_list, :http_timeout, :extra_http_header,
+                  :use_multistage_engine, :controller_config
+
+    def initialize(
+      broker_list: [],
+      http_timeout: nil,
+      extra_http_header: {},
+      use_multistage_engine: false,
+      controller_config: nil
+    )
+      @broker_list = broker_list
+      @http_timeout = http_timeout
+      @extra_http_header = extra_http_header
+      @use_multistage_engine = use_multistage_engine
+      @controller_config = controller_config
+    end
+  end
+end

data/lib/pinot/connection.rb

@@ -0,0 +1,94 @@
+require "bigdecimal"
+
+module Pinot
+  class Connection
+    def initialize(transport:, broker_selector:, use_multistage_engine: false)
+      @transport = transport
+      @broker_selector = broker_selector
+      @use_multistage_engine = use_multistage_engine
+      @trace = false
+    end
+
+    def use_multistage_engine=(val)
+      @use_multistage_engine = val
+    end
+
+    def open_trace
+      @trace = true
+    end
+
+    def close_trace
+      @trace = false
+    end
+
+    def execute_sql(table, query)
+      broker = @broker_selector.select_broker(table)
+      @transport.execute(broker, build_request(query))
+    rescue => e
+      raise "unable to execute SQL on table #{table}: #{e.message}"
+    end
+
+    def execute_sql_with_params(table, query_pattern, params)
+      query = format_query(query_pattern, params)
+      execute_sql(table, query)
+    rescue => e
+      # Re-raise format errors directly (they already have the right message)
+      raise e
+    end
+
+    def prepare(table, query_template)
+      raise ArgumentError, "table name cannot be empty" if table.nil? || table.strip.empty?
+      raise ArgumentError, "query template cannot be empty" if query_template.nil? || query_template.strip.empty?
+      count = query_template.count("?")
+      raise ArgumentError, "query template must contain at least one parameter placeholder (?)" if count == 0
+      PreparedStatementImpl.new(connection: self, table: table, query_template: query_template)
+    end
+
+    def format_query(pattern, params)
+      params ||= []
+      placeholders = pattern.count("?")
+      if placeholders != params.length
+        raise "failed to format query: number of placeholders in queryPattern (#{placeholders}) does not match number of params (#{params.length})"
+      end
+      parts = pattern.split("?", -1)
+      result = ""
+      params.each_with_index do |param, i|
+        formatted = begin
+          format_arg(param)
+        rescue => e
+          raise "failed to format query: failed to format parameter: #{e.message}"
+        end
+        result += parts[i] + formatted
+      end
+      result + parts.last
+    end
+
+    def format_arg(value)
+      case value
+      when String
+        "'#{value.gsub("'", "''")}'"
+      when Integer
+        value.to_s
+      when Float
+        value.to_s
+      when TrueClass, FalseClass
+        value.to_s
+      when BigDecimal
+        s = value.to_s("F")
+        # Strip trailing .0 for whole numbers (mirrors Go's big.Int quoted format)
+        s = s.sub(/\.0\z/, "") if s.end_with?(".0")
+        "'#{s}'"
+      when Time
+        "'#{value.utc.strftime("%Y-%m-%d %H:%M:%S.") + format("%03d", value.utc.subsec * 1000)}'"
+      else
+        raise "unsupported type: #{value.class}"
+      end
+    end
+
+    private
+
+    def build_request(query)
+      Request.new("sql", query, @trace, @use_multistage_engine)
+    end
+  end
+end

data/lib/pinot/connection_factory.rb

@@ -0,0 +1,43 @@
+module Pinot
+  def self.from_broker_list(broker_list, http_client: nil)
+    config = ClientConfig.new(broker_list: broker_list)
+    from_config(config, http_client: http_client)
+  end
+
+  def self.from_controller(controller_address, http_client: nil)
+    config = ClientConfig.new(
+      controller_config: ControllerConfig.new(controller_address: controller_address)
+    )
+    from_config(config, http_client: http_client)
+  end
+
+  def self.from_config(config, http_client: nil)
+    inner = http_client || HttpClient.new(timeout: config.http_timeout)
+
+    transport = JsonHttpTransport.new(
+      http_client: inner,
+      extra_headers: config.extra_http_header || {}
+    )
+
+    selector = build_selector(config, inner)
+    raise ArgumentError, "must specify broker_list or controller_config" unless selector
+
+    conn = Connection.new(
+      transport: transport,
+      broker_selector: selector,
+      use_multistage_engine: config.use_multistage_engine || false
+    )
+
+    selector.init
+    conn
+  end
+
+  def self.build_selector(config, http_client)
+    if config.broker_list && !config.broker_list.empty?
+      SimpleBrokerSelector.new(config.broker_list)
+    elsif config.controller_config
+      ControllerBasedBrokerSelector.new(config.controller_config, http_client)
+    end
+  end
+  private_class_method :build_selector
+end

data/lib/pinot/controller_based_broker_selector.rb

@@ -0,0 +1,74 @@
+require "net/http"
+require "uri"
+require "json"
+
+module Pinot
+  class ControllerBasedBrokerSelector < TableAwareBrokerSelector
+    CONTROLLER_API_PATH = "/v2/brokers/tables?state=ONLINE"
+    DEFAULT_UPDATE_FREQ_MS = 1000
+
+    def initialize(config, http_client = nil)
+      super()
+      @config = config
+      @internal_http = http_client || HttpClient.new
+    end
+
+    def init
+      @config.update_freq_ms ||= DEFAULT_UPDATE_FREQ_MS
+      @controller_url = build_controller_url(@config.controller_address)
+      fetch_and_update
+      start_background_refresh
+      nil
+    end
+
+    def build_controller_url(address)
+      addr = address.to_s
+      if addr.include?("://")
+        scheme = addr.split("://").first
+        unless %w[http https].include?(scheme)
+          raise "unsupported controller URL scheme: #{scheme}"
+        end
+        addr.chomp("/") + CONTROLLER_API_PATH
+      else
+        "http://#{addr.chomp("/")}#{CONTROLLER_API_PATH}"
+      end
+    end
+
+    private
+
+    def fetch_and_update
+      headers = { "Accept" => "application/json" }
+        .merge(@config.extra_controller_api_headers || {})
+
+      resp = @internal_http.get(@controller_url, headers: headers)
+
+      unless resp.code.to_i == 200
+        raise "controller API returned HTTP status code #{resp.code}"
+      end
+
+      body = resp.body
+      begin
+        raw = JSON.parse(body)
+      rescue JSON::ParserError => e
+        raise "error decoding controller API response: #{e.message}"
+      end
+
+      cr = ControllerResponse.new(raw)
+      update_broker_data(cr.extract_broker_list, cr.extract_table_to_broker_map)
+    end
+
+    def start_background_refresh
+      interval = @config.update_freq_ms / 1000.0
+      Thread.new do
+        loop do
+          sleep interval
+          begin
+            fetch_and_update
+          rescue => e
+            warn "Pinot: error refreshing broker data: #{e.message}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pinot/controller_response.rb

@@ -0,0 +1,31 @@
+module Pinot
+  class BrokerDto
+    attr_reader :host, :port, :instance_name
+
+    def initialize(hash)
+      @host = hash["host"]
+      @port = hash["port"].to_i
+      @instance_name = hash["instanceName"]
+    end
+
+    def broker_address
+      "#{@host}:#{@port}"
+    end
+  end
+
+  class ControllerResponse
+    def initialize(raw_hash)
+      @data = raw_hash.transform_values do |brokers|
+        brokers.map { |b| BrokerDto.new(b) }
+      end
+    end
+
+    def extract_broker_list
+      @data.values.flatten.map(&:broker_address).uniq
+    end
+
+    def extract_table_to_broker_map
+      @data.transform_values { |brokers| brokers.map(&:broker_address) }
+    end
+  end
+end

data/lib/pinot/prepared_statement.rb

@@ -0,0 +1,123 @@
+module Pinot
+  module PreparedStatement
+    # Duck-type interface — implementers must define:
+    #   set_string, set_int, set_int64, set_float64, set_bool, set
+    #   execute, execute_with_params
+    #   clear_parameters, close
+    #   get_query, get_parameter_count
+  end
+
+  class PreparedStatementImpl
+    include PreparedStatement
+
+    def initialize(connection:, table:, query_template:)
+      @connection = connection
+      @table = table
+      @query_template = query_template
+      @parts = query_template.split("?", -1)
+      @param_count = @parts.length - 1
+      @parameters = Array.new(@param_count)
+      @mutex = Mutex.new
+      @closed = false
+    end
+
+    def get_query
+      @query_template
+    end
+
+    def get_parameter_count
+      @param_count
+    end
+
+    def set_string(index, value)
+      set(index, value.to_s)
+    end
+
+    def set_int(index, value)
+      set(index, value.to_i)
+    end
+
+    def set_int64(index, value)
+      set(index, value.to_i)
+    end
+
+    def set_float64(index, value)
+      set(index, value.to_f)
+    end
+
+    def set_bool(index, value)
+      set(index, !!value)
+    end
+
+    def set(index, value)
+      @mutex.synchronize do
+        raise "prepared statement is closed" if @closed
+        unless index >= 1 && index <= @param_count
+          raise "parameter index #{index} is out of range [1, #{@param_count}]"
+        end
+        @parameters[index - 1] = value
+      end
+      nil
+    end
+
+    def execute
+      @mutex.synchronize do
+        raise "prepared statement is closed" if @closed
+        @parameters.each_with_index do |p, i|
+          raise "parameter at index #{i + 1} is not set" if p.nil?
+        end
+      end
+      query = begin
+        build_query(@parameters)
+      rescue => e
+        raise "failed to build query: #{e.message}"
+      end
+      @connection.execute_sql(@table, query)
+    end
+
+    def execute_with_params(*params)
+      @mutex.synchronize { raise "prepared statement is closed" if @closed }
+      if params.length != @param_count
+        raise "expected #{@param_count} parameters, got #{params.length}"
+      end
+      query = begin
+        build_query(params)
+      rescue => e
+        raise "failed to build query: #{e.message}"
+      end
+      @connection.execute_sql(@table, query)
+    end
+
+    def clear_parameters
+      @mutex.synchronize do
+        raise "prepared statement is closed" if @closed
+        @parameters.fill(nil)
+      end
+      nil
+    end
+
+    def close
+      @mutex.synchronize do
+        @closed = true
+        @parameters = nil
+      end
+      nil
+    end
+
+    def build_query(params)
+      if params.length != @param_count
+        raise "expected #{@param_count} parameters, got #{params.length}"
+      end
+      result = ""
+      params.each_with_index do |param, i|
+        formatted = begin
+          @connection.format_arg(param)
+        rescue => e
+          raise "failed to format parameter: #{e.message}"
+        end
+        result += @parts[i] + formatted
+      end
+      result + @parts.last
+    end
+  end
+end

data/lib/pinot/request.rb

@@ -0,0 +1,3 @@
+module Pinot
+  Request = Struct.new(:query_format, :query, :trace, :use_multistage_engine)
+end

data/lib/pinot/response.rb

@@ -0,0 +1,220 @@
+require "bigdecimal"
+
+module Pinot
+  INT32_MAX =  2_147_483_647
+  INT32_MIN = -2_147_483_648
+  INT64_MAX =  9_223_372_036_854_775_807
+  INT64_MIN = -9_223_372_036_854_775_808
+  FLOAT32_MAX = 3.4028235e+38
+
+  # Mirrors Go's json.Number — stores the raw string representation of a JSON number.
+  class JsonNumber
+    attr_reader :raw
+
+    def initialize(raw)
+      @raw = raw.to_s
+    end
+
+    def to_s
+      @raw
+    end
+
+    def ==(other)
+      case other
+      when JsonNumber then @raw == other.raw
+      else false
+      end
+    end
+  end
+
+  class RespSchema
+    attr_reader :column_names, :column_data_types
+
+    def initialize(hash)
+      @column_names = hash["columnNames"] || []
+      @column_data_types = hash["columnDataTypes"] || []
+    end
+  end
+
+  class PinotException
+    attr_reader :error_code, :message
+
+    def initialize(hash)
+      @error_code = hash["errorCode"]
+      @message = hash["message"]
+    end
+  end
+
+  class SelectionResults
+    attr_reader :columns, :results
+
+    def initialize(hash)
+      @columns = hash["columns"] || []
+      @results = hash["results"] || []
+    end
+  end
+
+  class AggregationResult
+    attr_reader :function, :value, :group_by_columns, :group_by_result
+
+    def initialize(hash)
+      @function = hash["function"]
+      @value = hash["value"]
+      @group_by_columns = hash["groupByColumns"]
+      @group_by_result = hash["groupByResult"]
+    end
+  end
+
+  class ResultTable
+    attr_reader :data_schema, :rows
+
+    def initialize(hash)
+      @data_schema = RespSchema.new(hash["dataSchema"] || {})
+      raw_rows = hash["rows"] || []
+      @rows = raw_rows.map do |row|
+        row.map { |cell| cell.is_a?(Numeric) ? JsonNumber.new(cell) : cell }
+      end
+    end
+
+    def row_count
+      @rows.length
+    end
+
+    def column_count
+      @data_schema.column_names.length
+    end
+
+    def column_name(i)
+      @data_schema.column_names[i]
+    end
+
+    def column_data_type(i)
+      @data_schema.column_data_types[i]
+    end
+
+    def get(row, col)
+      @rows[row][col]
+    end
+
+    def get_string(row, col)
+      @rows[row][col].to_s
+    end
+
+    def get_int(row, col)
+      cell = @rows[row][col]
+      return 0 unless cell.is_a?(JsonNumber)
+
+      raw = cell.raw
+      begin
+        # Try parsing as integer first
+        if raw.include?(".") || raw.include?("e") || raw.include?("E")
+          # Floating point string — check if it's a whole number
+          bd = BigDecimal(raw)
+          return 0 if bd.infinite? || bd.nan? rescue return 0
+          int_val = bd.to_i
+          return 0 unless bd == BigDecimal(int_val.to_s)
+          return 0 if int_val > INT32_MAX || int_val < INT32_MIN
+          int_val.to_i
+        else
+          int_val = Integer(raw)
+          return 0 if int_val > INT32_MAX || int_val < INT32_MIN
+          int_val
+        end
+      rescue ArgumentError, TypeError
+        0
+      end
+    end
+
+    def get_long(row, col)
+      cell = @rows[row][col]
+      return 0 unless cell.is_a?(JsonNumber)
+
+      raw = cell.raw
+      begin
+        if raw.include?(".") || raw.include?("e") || raw.include?("E")
+          bd = BigDecimal(raw)
+          return 0 if bd.infinite? || bd.nan? rescue return 0
+          int_val = bd.to_i
+          return 0 unless bd == BigDecimal(int_val.to_s)
+          return 0 if int_val > INT64_MAX || int_val < INT64_MIN
+          int_val
+        else
+          int_val = Integer(raw)
+          return 0 if int_val > INT64_MAX || int_val < INT64_MIN
+          int_val
+        end
+      rescue ArgumentError, TypeError
+        0
+      end
+    end
+
+    def get_float(row, col)
+      cell = @rows[row][col]
+      return 0.0 unless cell.is_a?(JsonNumber)
+
+      raw = cell.raw
+      begin
+        f = Float(raw)
+        return 0.0 if f.infinite? || f.nan?
+        f32 = f.to_f
+        return 0.0 if f32.abs > FLOAT32_MAX
+        f32
+      rescue ArgumentError, TypeError
+        0.0
+      end
+    end
+
+    def get_double(row, col)
+      cell = @rows[row][col]
+      return 0.0 unless cell.is_a?(JsonNumber)
+
+      raw = cell.raw
+      begin
+        f = Float(raw)
+        return 0.0 if f.infinite? || f.nan?
+        f
+      rescue ArgumentError, TypeError
+        0.0
+      end
+    end
+  end
+
+  class BrokerResponse
+    attr_reader :selection_results, :result_table, :aggregation_results,
+                :exceptions, :trace_info,
+                :num_segments_processed, :num_servers_responded,
+                :num_segments_queried, :num_servers_queried,
+                :num_segments_matched, :num_consuming_segments_queried,
+                :num_docs_scanned, :num_entries_scanned_in_filter,
+                :num_entries_scanned_post_filter, :total_docs,
+                :time_used_ms, :min_consuming_freshness_time_ms,
+                :num_groups_limit_reached
+
+    def self.from_json(json_str)
+      hash = JSON.parse(json_str)
+      new(hash)
+    end
+
+    def initialize(hash)
+      @selection_results = hash["selectionResults"] ? SelectionResults.new(hash["selectionResults"]) : nil
+      @result_table = hash["resultTable"] ? ResultTable.new(hash["resultTable"]) : nil
+      @aggregation_results = (hash["aggregationResults"] || []).map { |r| AggregationResult.new(r) }
+      @exceptions = (hash["exceptions"] || []).map { |e| PinotException.new(e) }
+      @trace_info = hash["traceInfo"] || {}
+
+      @num_servers_queried = hash["numServersQueried"] || 0
+      @num_servers_responded = hash["numServersResponded"] || 0
+      @num_segments_queried = hash["numSegmentsQueried"] || 0
+      @num_segments_processed = hash["numSegmentsProcessed"] || 0
+      @num_segments_matched = hash["numSegmentsMatched"] || 0
+      @num_consuming_segments_queried = hash["numConsumingSegmentsQueried"] || 0
+      @num_docs_scanned = hash["numDocsScanned"] || 0
+      @num_entries_scanned_in_filter = hash["numEntriesScannedInFilter"] || 0
+      @num_entries_scanned_post_filter = hash["numEntriesScannedPostFilter"] || 0
+      @num_groups_limit_reached = hash["numGroupsLimitReached"] || false
+      @total_docs = hash["totalDocs"] || 0
+      @time_used_ms = hash["timeUsedMs"] || 0
+      @min_consuming_freshness_time_ms = hash["minConsumingFreshnessTimeMs"] || 0
+    end
+  end
+end

data/lib/pinot/simple_broker_selector.rb

@@ -0,0 +1,18 @@
+module Pinot
+  class SimpleBrokerSelector
+    include BrokerSelector
+
+    def initialize(broker_list)
+      @broker_list = broker_list.dup.freeze
+    end
+
+    def init
+      raise "no pre-configured broker lists" if @broker_list.empty?
+    end
+
+    def select_broker(_table)
+      raise "no pre-configured broker lists" if @broker_list.empty?
+      @broker_list.sample
+    end
+  end
+end

data/lib/pinot/table_aware_broker_selector.rb

@@ -0,0 +1,45 @@
+module Pinot
+  class TableAwareBrokerSelector
+    include BrokerSelector
+
+    OFFLINE_SUFFIX  = "_OFFLINE"
+    REALTIME_SUFFIX = "_REALTIME"
+
+    def initialize
+      @mutex = Mutex.new
+      @all_broker_list = []
+      @table_broker_map = {}
+    end
+
+    def init
+      raise NotImplementedError, "subclasses must implement init"
+    end
+
+    def select_broker(table)
+      table_name = extract_table_name(table.to_s)
+      @mutex.synchronize do
+        if table_name.empty?
+          raise "no available broker" if @all_broker_list.empty?
+          return @all_broker_list.sample
+        end
+        brokers = @table_broker_map[table_name]
+        raise "unable to find table: #{table}" unless brokers
+        raise "no available broker for table: #{table}" if brokers.empty?
+        brokers.sample
+      end
+    end
+
+    def update_broker_data(all_brokers, table_map)
+      @mutex.synchronize do
+        @all_broker_list = all_brokers
+        @table_broker_map = table_map
+      end
+    end
+
+    private
+
+    def extract_table_name(table)
+      table.sub(/#{OFFLINE_SUFFIX}\z/, "").sub(/#{REALTIME_SUFFIX}\z/, "")
+    end
+  end
+end

data/lib/pinot/transport.rb

@@ -0,0 +1,103 @@
+require "net/http"
+require "uri"
+require "json"
+require "securerandom"
+
+module Pinot
+  class HttpClient
+    def initialize(timeout: nil)
+      @timeout = timeout
+    end
+
+    def post(url, body:, headers: {})
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      if @timeout
+        http.open_timeout = @timeout
+        http.read_timeout = @timeout
+      end
+      req = Net::HTTP::Post.new(uri.request_uri)
+      headers.each { |k, v| req[k] = v }
+      req.body = body
+      http.request(req)
+    end
+
+    def get(url, headers: {})
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      if @timeout
+        http.open_timeout = @timeout
+        http.read_timeout = @timeout
+      end
+      req = Net::HTTP::Get.new(uri.request_uri)
+      headers.each { |k, v| req[k] = v }
+      http.request(req)
+    end
+  end
+
+  class JsonHttpTransport
+    DEFAULT_HEADERS = {
+      "Content-Type" => "application/json; charset=utf-8"
+    }.freeze
+
+    def initialize(http_client:, extra_headers: {}, timeout_ms: nil)
+      @http_client = http_client
+      @extra_headers = extra_headers
+      @timeout_ms = timeout_ms
+    end
+
+    def execute(broker_address, request)
+      url = build_url(broker_address, request.query_format)
+      body = build_body(request)
+      headers = DEFAULT_HEADERS
+        .merge(@extra_headers)
+        .merge("X-Correlation-Id" => SecureRandom.uuid)
+
+      resp = @http_client.post(url, body: body, headers: headers)
+
+      unless resp.code.to_i == 200
+        raise "http exception with HTTP status code #{resp.code}"
+      end
+
+      begin
+        BrokerResponse.from_json(resp.body)
+      rescue JSON::ParserError => e
+        raise e.message
+      end
+    end
+
+    private
+
+    def build_url(broker_address, query_format)
+      base = if broker_address.start_with?("http://", "https://")
+               broker_address
+             else
+               "http://#{broker_address}"
+             end
+      path = query_format == "sql" ? "/query/sql" : "/query"
+      "#{base}#{path}"
+    end
+
+    def build_body(request)
+      payload = { request.query_format => request.query }
+      opts = build_query_options(request)
+      payload["queryOptions"] = opts unless opts.empty?
+      payload["trace"] = "true" if request.trace
+      JSON.generate(payload)
+    end
+
+    def build_query_options(request)
+      parts = []
+      if request.query_format == "sql"
+        parts << "groupByMode=sql;responseFormat=sql"
+        parts << "useMultistageEngine=true" if request.use_multistage_engine
+        if @timeout_ms && @timeout_ms > 0
+          parts << "timeoutMs=#{@timeout_ms}"
+        end
+      end
+      parts.join(";")
+    end
+  end
+end

data/lib/pinot/version.rb

@@ -0,0 +1,3 @@
+module Pinot
+  VERSION = "1.0.2"
+end

data/lib/pinot.rb

@@ -0,0 +1,19 @@
+require "net/http"
+require "uri"
+require "json"
+require "bigdecimal"
+require "securerandom"
+
+require_relative "pinot/version"
+require_relative "pinot/config"
+require_relative "pinot/request"
+require_relative "pinot/response"
+require_relative "pinot/broker_selector"
+require_relative "pinot/simple_broker_selector"
+require_relative "pinot/table_aware_broker_selector"
+require_relative "pinot/controller_response"
+require_relative "pinot/controller_based_broker_selector"
+require_relative "pinot/transport"
+require_relative "pinot/connection"
+require_relative "pinot/prepared_statement"
+require_relative "pinot/connection_factory"

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: pinot-client
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Xiang Fu
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: A Ruby client for Apache Pinot, mirroring the Go client API
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/pinot.rb
+- lib/pinot/broker_selector.rb
+- lib/pinot/config.rb
+- lib/pinot/connection.rb
+- lib/pinot/connection_factory.rb
+- lib/pinot/controller_based_broker_selector.rb
+- lib/pinot/controller_response.rb
+- lib/pinot/prepared_statement.rb
+- lib/pinot/request.rb
+- lib/pinot/response.rb
+- lib/pinot/simple_broker_selector.rb
+- lib/pinot/table_aware_broker_selector.rb
+- lib/pinot/transport.rb
+- lib/pinot/version.rb
+homepage: https://github.com/startreedata/ruby-pinot-client
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/startreedata/ruby-pinot-client
+  source_code_uri: https://github.com/startreedata/ruby-pinot-client
+  bug_tracker_uri: https://github.com/startreedata/ruby-pinot-client/issues
+  github_repo: ssh://git@github.com/startreedata/ruby-pinot-client
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Apache Pinot Ruby client
+test_files: []