pinot-client 1.2.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8307d3d291be0af45b13a63512bd9f7d2f10d1c4db6383edd72b9ab5bb7c1e03
-  data.tar.gz: c74a5865da644b9edf2db66cfcc79eb6021e8ac06a872ab7e2d2528448ea1ea2
+  metadata.gz: 828dd3e3c441143fb0754adbcb1b50de4a070e777ad3a158c51dfabf91a3f877
+  data.tar.gz: 6c4a3f0ae7e703ae0d3ff18fd473030710e5a1954b9624207e0b2c6e944d2365
 SHA512:
-  metadata.gz: ae76f79806e4a0eef9f18f7ea7253a2ad4aba9f098bdf389e91b5cb1e2463d1e5637f158984523ceb9e99de0da293f541e37c36ac322d877d78c0be024ff6883
-  data.tar.gz: 034d035acefa3616c6f4892f22bd6cfc9569e43ffa5189930b96efc6a232a0e0fe11795a96e4546be6d7577425da3e590afab42223730ae682d86abb868d16e5
+  metadata.gz: ca183a5d10a9b87a18cb61725e6810f1446cd70b627e6a6a8320a3db9b2ec27981bf7d282e684f2c2cca94c2a87be2fb1595c2c178d378465bb77628cf501bb7
+  data.tar.gz: 715e0acb71c456409c999da0207c4c2c1aac310d27024dae6d9154996811d51b1f4c665686b609d598128b031f766ae06ee18c111c6ef0f6801b69cd523b5c82

data/lib/pinot/config.rb

@@ -1,4 +1,14 @@
 module Pinot
+  class ZookeeperConfig
+    attr_accessor :zk_path,           # "host:port" or "host1:port,host2:port/chroot"
+                  :session_timeout_ms # default 30000
+
+    def initialize(zk_path:, session_timeout_ms: 30_000)
+      @zk_path            = zk_path
+      @session_timeout_ms = session_timeout_ms
+    end
+  end
+
   class ControllerConfig
     attr_accessor :controller_address, :update_freq_ms, :extra_controller_api_headers
 
@@ -11,7 +21,8 @@ module Pinot
 
   class ClientConfig
     attr_accessor :broker_list, :http_timeout, :extra_http_header,
-                  :use_multistage_engine, :controller_config, :logger, :tls_config
+                  :use_multistage_engine, :controller_config, :logger, :tls_config,
+                  :grpc_config, :zookeeper_config
 
     def initialize(
       broker_list: [],
@@ -20,7 +31,9 @@ module Pinot
       use_multistage_engine: false,
       controller_config: nil,
       logger: nil,
-      tls_config: nil
+      tls_config: nil,
+      grpc_config: nil,
+      zookeeper_config: nil
     )
       @broker_list = broker_list
       @http_timeout = http_timeout
@@ -29,6 +42,8 @@ module Pinot
       @controller_config = controller_config
       @logger = logger
       @tls_config = tls_config
+      @grpc_config = grpc_config
+      @zookeeper_config = zookeeper_config
     end
   end
 end

data/lib/pinot/connection_factory.rb

@@ -12,6 +12,40 @@ module Pinot
   end
 
   def self.from_config(config, http_client: nil)
+    if config.grpc_config
+      transport = GrpcTransport.new(config.grpc_config)
+      selector  = SimpleBrokerSelector.new(config.grpc_config.broker_list)
+
+      conn = Connection.new(
+        transport: transport,
+        broker_selector: selector,
+        use_multistage_engine: config.use_multistage_engine || false,
+        logger: config.logger
+      )
+
+      selector.init
+      return conn
+    end
+
+    if config.zookeeper_config
+      selector = ZookeeperBrokerSelector.new(zk_path: config.zookeeper_config.zk_path)
+      selector.init
+
+      inner = http_client || HttpClient.new(timeout: config.http_timeout, tls_config: config.tls_config)
+      transport = JsonHttpTransport.new(
+        http_client: inner,
+        extra_headers: config.extra_http_header || {},
+        logger: config.logger
+      )
+
+      return Connection.new(
+        transport: transport,
+        broker_selector: selector,
+        use_multistage_engine: config.use_multistage_engine || false,
+        logger: config.logger
+      )
+    end
+
     inner = http_client || HttpClient.new(timeout: config.http_timeout, tls_config: config.tls_config)
 
     transport = JsonHttpTransport.new(

data/lib/pinot/grpc_config.rb

@@ -0,0 +1,15 @@
+module Pinot
+  class GrpcConfig
+    attr_accessor :broker_list,       # Array<String> of "host:port" (no scheme)
+                  :tls_config,        # Pinot::TlsConfig or nil
+                  :extra_metadata,    # Hash — extra gRPC metadata headers
+                  :timeout            # seconds (Integer/Float), nil = no timeout
+
+    def initialize(broker_list: [], tls_config: nil, extra_metadata: {}, timeout: nil)
+      @broker_list    = broker_list
+      @tls_config     = tls_config
+      @extra_metadata = extra_metadata
+      @timeout        = timeout
+    end
+  end
+end

data/lib/pinot/grpc_transport.rb

@@ -0,0 +1,76 @@
+begin
+  require "grpc"
+  require_relative "proto/broker_service_pb"
+  require_relative "proto/broker_service_services_pb"
+rescue LoadError
+  raise LoadError, "The 'grpc' gem is required to use Pinot::GrpcTransport. Add it to your Gemfile: gem \"grpc\""
+end
+require_relative "grpc_config"
+require_relative "response"
+
+module Pinot
+  class GrpcTransport
+    def initialize(grpc_config)
+      @config = grpc_config
+    end
+
+    # Returns Pinot::BrokerResponse
+    def execute(broker_address, request)
+      stub = build_stub(broker_address)
+      grpc_request = build_request(request)
+      call_opts = build_call_opts
+
+      grpc_response = stub.submit(grpc_request, **call_opts)
+      BrokerResponse.from_json(grpc_response.payload)
+    rescue GRPC::BadStatus => e
+      raise TransportError, "gRPC error #{e.code}: #{e.details}"
+    end
+
+    private
+
+    def build_stub(broker_address)
+      creds = if @config.tls_config
+                build_ssl_credentials
+              else
+                :this_channel_is_insecure
+              end
+      Pinot::Broker::Grpc::PinotClientGrpcBrokerService::Stub.new(
+        broker_address, creds
+      )
+    end
+
+    def build_request(request)
+      meta = {}
+      query_opts = build_query_options(request)
+      meta["queryOptions"] = query_opts unless query_opts.empty?
+      meta["traceEnabled"] = "true" if request.trace
+      meta.merge!(@config.extra_metadata)
+
+      Pinot::Broker::Grpc::BrokerRequest.new(
+        sql:      request.query,
+        metadata: meta
+      )
+    end
+
+    def build_query_options(request)
+      parts = ["groupByMode=sql", "responseFormat=sql"]
+      parts << "useMultistageEngine=true" if request.use_multistage_engine
+      parts.join(";")
+    end
+
+    def build_call_opts
+      opts = {}
+      opts[:deadline] = Time.now + @config.timeout if @config.timeout
+      opts[:metadata] = @config.extra_metadata unless @config.extra_metadata.empty?
+      opts
+    end
+
+    def build_ssl_credentials
+      tls = @config.tls_config
+      root_certs = tls.ca_cert_file ? File.read(tls.ca_cert_file) : nil
+      private_key = tls.client_key_file ? File.read(tls.client_key_file) : nil
+      cert_chain  = tls.client_cert_file ? File.read(tls.client_cert_file) : nil
+      GRPC::Core::ChannelCredentials.new(root_certs, private_key, cert_chain)
+    end
+  end
+end

data/lib/pinot/proto/broker_service.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+package pinot.broker.grpc;
+
+message BrokerRequest {
+  string sql = 1;
+  map<string, string> metadata = 2;
+}
+
+message BrokerResponse {
+  int32 result_row_size = 1;
+  bytes payload = 2;
+}
+
+service PinotClientGrpcBrokerService {
+  rpc Submit(BrokerRequest) returns (BrokerResponse);
+}

data/lib/pinot/proto/broker_service_pb.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: broker_service.proto
+
+require 'google/protobuf'
+
+
+descriptor_data = "\n\x14\x62roker_service.proto\x12\x11pinot.broker.grpc\"\x8f\x01\n\rBrokerRequest\x12\x0b\n\x03sql\x18\x01 \x01(\t\x12@\n\x08metadata\x18\x02 \x03(\x0b\x32..pinot.broker.grpc.BrokerRequest.MetadataEntry\x1a/\n\rMetadataEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\":\n\x0e\x42rokerResponse\x12\x17\n\x0fresult_row_size\x18\x01 \x01(\x05\x12\x0f\n\x07payload\x18\x02 \x01(\x0c\x32m\n\x1cPinotClientGrpcBrokerService\x12M\n\x06Submit\x12 .pinot.broker.grpc.BrokerRequest\x1a!.pinot.broker.grpc.BrokerResponseb\x06proto3"
+
+pool = ::Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Pinot
+  module Broker
+    module Grpc
+      BrokerRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pinot.broker.grpc.BrokerRequest").msgclass
+      BrokerResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("pinot.broker.grpc.BrokerResponse").msgclass
+    end
+  end
+end

data/lib/pinot/proto/broker_service_services_pb.rb

@@ -0,0 +1,26 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: broker_service.proto for package 'pinot.broker.grpc'
+
+require 'grpc'
+require_relative 'broker_service_pb'
+
+module Pinot
+  module Broker
+    module Grpc
+      module PinotClientGrpcBrokerService
+        class Service
+
+          include ::GRPC::GenericService
+
+          self.marshal_class_method = :encode
+          self.unmarshal_class_method = :decode
+          self.service_name = 'pinot.broker.grpc.PinotClientGrpcBrokerService'
+
+          rpc :Submit, ::Pinot::Broker::Grpc::BrokerRequest, ::Pinot::Broker::Grpc::BrokerResponse
+        end
+
+        Stub = Service.rpc_stub_class
+      end
+    end
+  end
+end

data/lib/pinot/version.rb

@@ -1,3 +1,3 @@
 module Pinot
-  VERSION = "1.2.0"
+  VERSION = "1.4.0"
 end

data/lib/pinot/zookeeper_broker_selector.rb

@@ -0,0 +1,80 @@
+require "json"
+require "set"
+require_relative "table_aware_broker_selector"
+require_relative "errors"
+
+module Pinot
+  class ZookeeperBrokerSelector < TableAwareBrokerSelector
+    # ZK path where Pinot stores broker external view
+    BROKER_EXTERNAL_VIEW_PATH = "/EXTERNALVIEW/brokerResource"
+
+    def initialize(zk_path:, zk_client: nil)
+      super()
+      @zk_path   = zk_path      # e.g. "localhost:2181"
+      @zk_client = zk_client    # injectable for testing
+    end
+
+    def init
+      @zk = @zk_client || build_zk_client
+      fetch_and_update
+      setup_watcher
+    end
+
+    private
+
+    def build_zk_client
+      begin
+        require "zk"
+      rescue LoadError
+        raise ConfigurationError, "The 'zk' gem is required to use ZookeeperBrokerSelector. Add it to your Gemfile: gem \"zk\""
+      end
+      ZK.new(@zk_path)
+    end
+
+    def fetch_and_update
+      data, _stat = @zk.get(BROKER_EXTERNAL_VIEW_PATH)
+      parsed = JSON.parse(data)
+      all_brokers, table_map = parse_external_view(parsed)
+      update_broker_data(all_brokers, table_map)
+    end
+
+    def setup_watcher
+      @zk.register(BROKER_EXTERNAL_VIEW_PATH) do |event|
+        fetch_and_update rescue nil
+        setup_watcher  # re-register watch after each trigger
+      end
+      # Set initial watch
+      @zk.exists?(BROKER_EXTERNAL_VIEW_PATH, watch: true)
+    end
+
+    def parse_external_view(data)
+      # Pinot external view format:
+      # { "mapFields": { "tableName_OFFLINE": { "Broker_host_port": "ONLINE" } } }
+      map_fields = data["mapFields"] || {}
+
+      all_brokers = Set.new
+      table_map   = {}
+
+      map_fields.each do |raw_table, broker_map|
+        # Strip _OFFLINE / _REALTIME suffix from the table key, matching Go's extractTableName
+        table_name = raw_table.sub(/_OFFLINE\z/, "").sub(/_REALTIME\z/, "")
+        brokers = []
+        broker_map.each do |broker_key, state|
+          next unless state == "ONLINE"
+          # Broker key format: Broker_<hostname>_<port>
+          # Use the last segment as port and the second-to-last as host
+          parts = broker_key.split("_")
+          next if parts.length < 2
+          port = parts.last
+          next unless port =~ /\A\d+\z/
+          host = parts[-2]
+          brokers << "#{host}:#{port}"
+        end
+        table_map[table_name] = brokers
+        all_brokers.merge(brokers)
+      end
+
+      [all_brokers.to_a, table_map]
+    end
+  end
+end

data/lib/pinot.rb

@@ -20,3 +20,15 @@ require_relative "pinot/transport"
 require_relative "pinot/connection"
 require_relative "pinot/prepared_statement"
 require_relative "pinot/connection_factory"
+
+begin
+  require_relative "pinot/grpc_transport"
+  require_relative "pinot/grpc_config"
+rescue LoadError
+  # grpc gem not available; GrpcTransport disabled
+end
+
+begin
+  require_relative "pinot/zookeeper_broker_selector"
+rescue LoadError
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinot-client
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Xiang Fu
@@ -82,8 +82,13 @@ files:
 - lib/pinot/controller_based_broker_selector.rb
 - lib/pinot/controller_response.rb
 - lib/pinot/errors.rb
+- lib/pinot/grpc_config.rb
+- lib/pinot/grpc_transport.rb
 - lib/pinot/logger.rb
 - lib/pinot/prepared_statement.rb
+- lib/pinot/proto/broker_service.proto
+- lib/pinot/proto/broker_service_pb.rb
+- lib/pinot/proto/broker_service_services_pb.rb
 - lib/pinot/request.rb
 - lib/pinot/response.rb
 - lib/pinot/simple_broker_selector.rb
@@ -91,6 +96,7 @@ files:
 - lib/pinot/tls_config.rb
 - lib/pinot/transport.rb
 - lib/pinot/version.rb
+- lib/pinot/zookeeper_broker_selector.rb
 homepage: https://github.com/startreedata/ruby-pinot-client
 licenses:
 - Apache-2.0