pinot-client 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f2e2377c6f9af1cb73b472bd5b7c9ad2bfa512ec0594c67d3298c884bee5f0a
-  data.tar.gz: 608b9a1f070dd22d71a793ad1e4817dcdbe4100b14e3aa4033e71643fc2de9a8
+  metadata.gz: 8307d3d291be0af45b13a63512bd9f7d2f10d1c4db6383edd72b9ab5bb7c1e03
+  data.tar.gz: c74a5865da644b9edf2db66cfcc79eb6021e8ac06a872ab7e2d2528448ea1ea2
 SHA512:
-  metadata.gz: bd247b8088c5be2b20d78e95e0cc16effd8b8c24e136810101f5a136d630dcbca002127ace5ea56f98a9c9308a0d7ae42c20d16a32d9ebba8ad3f11656ceff08
-  data.tar.gz: 02ecaf1df43b2117a2ad86cf481ec241412668c3e96a49fc046e2a730fd92e6d44edad99f34f9ab68eac44d457cd88d5acda636226241ab7bbe82206ae99ea0c
+  metadata.gz: ae76f79806e4a0eef9f18f7ea7253a2ad4aba9f098bdf389e91b5cb1e2463d1e5637f158984523ceb9e99de0da293f541e37c36ac322d877d78c0be024ff6883
+  data.tar.gz: 034d035acefa3616c6f4892f22bd6cfc9569e43ffa5189930b96efc6a232a0e0fe11795a96e4546be6d7577425da3e590afab42223730ae682d86abb868d16e5

data/README.md

@@ -67,7 +67,7 @@ client = Pinot.from_controller("localhost:9000")
 ```ruby
 config = Pinot::ClientConfig.new(
   broker_list:           ["localhost:8000"],
-  http_timeout:          10,          # seconds
+  http_timeout:          10,          # seconds — sets open_timeout, read_timeout, and write_timeout on the underlying Net::HTTP connection
   extra_http_header:     { "Authorization" => "Bearer <token>" },
   use_multistage_engine: false,
   controller_config: Pinot::ControllerConfig.new(
@@ -79,6 +79,38 @@ config = Pinot::ClientConfig.new(
 client = Pinot.from_config(config)
 ```
 
+### With TLS
+
+```ruby
+tls = Pinot::TlsConfig.new(
+  ca_cert_file:        "/path/to/ca.pem",
+  client_cert_file:    "/path/to/client.crt",
+  client_key_file:     "/path/to/client.key",
+  insecure_skip_verify: false   # set true to skip cert verification
+)
+config = Pinot::ClientConfig.new(
+  broker_list: ["https://pinot-broker.example.com:8000"],
+  tls_config:  tls
+)
+client = Pinot.from_config(config)
+```
+
+## Logging
+
+By default the client logs warnings to stdout. Configure a custom logger globally or per-client:
+
+```ruby
+# Global logger
+Pinot::Logging.logger = Logger.new("pinot.log", level: Logger::DEBUG)
+
+# Per-client logger via ClientConfig
+config = Pinot::ClientConfig.new(
+  broker_list: ["localhost:8000"],
+  logger: Logger.new($stdout, level: Logger::INFO)
+)
+client = Pinot.from_config(config)
+```
+
 ## Executing Queries
 
 ### Simple SQL
@@ -124,6 +156,32 @@ resp = client.execute_sql("baseballStats", "SELECT count(*) FROM baseballStats")
 client.close_trace
 ```
 
+## Error Handling
+
+All errors raised by the client inherit from `Pinot::Error < StandardError`:
+
+| Class | Raised when |
+|-------|-------------|
+| `Pinot::BrokerNotFoundError` | No broker available (empty list or all offline) |
+| `Pinot::TableNotFoundError` | Named table not found in broker map |
+| `Pinot::TransportError` | Non-200 HTTP response from broker |
+| `Pinot::PreparedStatementClosedError` | Operation on a closed prepared statement |
+| `Pinot::ConfigurationError` | Invalid config (bad URL scheme, missing broker source) |
+
+Example:
+
+```ruby
+begin
+  resp = client.execute_sql("myTable", "SELECT * FROM myTable")
+rescue Pinot::TableNotFoundError => e
+  puts "Table missing: #{e.message}"
+rescue Pinot::TransportError => e
+  puts "Broker error: #{e.message}"
+rescue Pinot::Error => e
+  puts "Pinot error: #{e.message}"
+end
+```
+
 ## Reading Results
 
 `execute_sql` returns a `Pinot::BrokerResponse`. Results are in `result_table`:

data/lib/pinot/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinot-client
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Xiang Fu