pinot 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6443fe94263c767cc5039c400a7684fae467ab856e2d04253959ef6e0042e1d1
-  data.tar.gz: 4cb05bc8fe5c6f9b83cffa623e359f3c90fdc768575033e13968a78c5f7d43ff
+  metadata.gz: aef65c895b1ae235ffe6f25f80a9a18cc78d2fabf65f01bc75b10a1478bd02d3
+  data.tar.gz: bbd2cdc1d049f5a847ef14c93601fcdba235cf9d0eccdcefdbc6d9f5575d3f47
 SHA512:
-  metadata.gz: f217a53c1c2712e8d098aa94e5f3a4a93995e0839cad0f1a640f78c6e5269f7847afe9ef6d8344c2eb1d1df85ea087a5fb0db853ce3eb8c2d65d029ddbc6d554
-  data.tar.gz: 70694ca05dd5de01ef4e1d8af6e8bc61b899840e73ccb2b9680150d5d9dd48553fba2002607e6b22a9e3e1939d08d625e8c1d672adc6f4001345ad0ea5da9c5a
+  metadata.gz: 38f78b8f0bb9bb60e3f88d5fdcce033bdb16d8f0544bdd9d02867c55d58f5ee60e9fe666579020bfd0b597c05ec5720720ac13ee0f987ce0eb4b57afc7759ea3
+  data.tar.gz: 92391075e082157fdf2c6b662640578ca5633374e38525b031b56011ee481aaf5c56e1f3abf7180d2b315756d5c0020773f22c520ca517de8cb380d928255cfc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-07-12
+
+- feature: Add support for Apache Pinot [Query Options](https://docs.pinot.apache.org/users/user-guide-query/query-options)
+
 ## [0.1.3] - 2024-07-02
 
 - feature: add tables command

data/README.md

@@ -51,6 +51,16 @@ resp.columns
 
 It's not on the public API, but the instance variable `@payload` contains all information returned from the Pinot cluster in case can help with troubleshooting
 
+### Query Options
+
+In case there's the need to pass any Pinot [query options](https://docs.pinot.apache.org/users/user-guide-query/query-options), it's can be done when initializing the client.
+
+```ruby
+client = Pinot::Client.new(query_options: {use_multistage_engine: true}, **options)
+```
+
+Any of the query options on the documentation is supported, remember to use its name with underscore formatting.
+
 ### Authentication
 
 In case your pinot cluster is using authentication bearer token, you can specify it on the client constructor

data/lib/pinot/client/query_options.rb

@@ -0,0 +1,51 @@
+module Pinot
+  class Client
+    class QueryOptions
+      class InvalidOption < StandardError; end
+
+      OPTIONS = [:timeout_ms, :enable_null_handling, :explain_plan_verbose, :use_multistage_engine, :max_execution_threads, :num_replica_groups_to_query, :min_segment_group_trim_size, :min_server_group_trim_size, :skip_indexes, :skip_upsert, :use_star_tree, :and_scan_reordering, :max_rows_in_join, :in_predicate_pre_sorted, :in_predicate_lookup_algorithm, :max_server_response_size_bytes, :max_query_response_size_bytes]
+
+      OPTIONS.each do |opt|
+        attr_reader opt
+      end
+
+      def initialize(options = {})
+        process_options_hash(options)
+      end
+
+      def available_options
+        OPTIONS
+      end
+
+      def to_query_options
+        query_options = []
+        available_options.each do |opt|
+          if (value = send(opt))
+            query_options << "#{camelize_option(opt)}=#{value}"
+          end
+        end
+
+        return nil if query_options.empty?
+
+        query_options.join(";")
+      end
+
+      private
+
+      # avoid monkeypatch String#camelize
+      def camelize_option(option)
+        string = option.to_s
+        string = string.sub(/^(?:(?=\b|[A-Z_])|\w)/) { |match| match.downcase }
+        string.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.gsub("/", "::")
+      end
+
+      def process_options_hash(options)
+        options.each_pair do |k, v|
+          raise InvalidOption.new("`#{k}' is not a valid option for Pinot Client") unless available_options.include?(k.to_sym)
+
+          instance_variable_set(:"@#{k}", v)
+        end
+      end
+    end
+  end
+end

data/lib/pinot/client.rb

@@ -1,8 +1,10 @@
+require_relative "client/query_options"
+
 module Pinot
   class Client
-    attr_reader :host, :port, :controller_host, :controller_port, :protocol, :socks5_uri, :bearer_token
+    attr_reader :host, :port, :controller_host, :controller_port, :protocol, :socks5_uri, :bearer_token, :query_options
 
-    def initialize(host:, port:, controller_port:, controller_host: nil, protocol: :http, socks5_uri: nil, bearer_token: nil)
+    def initialize(host:, port:, controller_port:, controller_host: nil, protocol: :http, socks5_uri: nil, bearer_token: nil, query_options: {})
       @host = host
       @port = port
       @controller_port = controller_port
@@ -10,10 +12,16 @@ module Pinot
       @protocol = protocol
       @socks5_uri = socks5_uri
       @bearer_token = bearer_token
+      @query_options = QueryOptions.new(query_options)
     end
 
     def execute(sql)
-      response = http.post(query_sql_uri, json: {sql: sql})
+      query_params = {sql: sql}
+      if (value = query_options.to_query_options)
+        query_params["queryOptions"] = value
+      end
+
+      response = http.post(query_sql_uri, json: query_params)
       return response if response.is_a?(HTTPX::ErrorResponse)
       Response.new(JSON.parse(response))
     end

data/lib/pinot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pinot
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pinot
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Celso Fernandes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpx
@@ -81,6 +81,7 @@ files:
 - Rakefile
 - lib/pinot.rb
 - lib/pinot/client.rb
+- lib/pinot/client/query_options.rb
 - lib/pinot/response.rb
 - lib/pinot/version.rb
 - sig/pinot.rbs