hexspace 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46cb7c0c6c1d1839a2672e99b5daedfd952e0f31ef9fdeabe055f980c8f52aca
-  data.tar.gz: c16be8b8145beed444821a83b018f1d77a63db01947c1bdf6e34923bb64bc919
+  metadata.gz: b01d38959d851e6e96d16a2230b62e6f659089f855307959a4c27585c32a6550
+  data.tar.gz: 5515be12059303b0e6ee12222caf04896ec8c79b23ffe519b8e9f213f957e257
 SHA512:
-  metadata.gz: 2badf30752d561592c909ec3eb15b3967b0b551479563a1972742a310e5c5da297e8beb58626e14177ab894efc16645b74337bc6f64c3fd1afb80ed861fffcac
-  data.tar.gz: 92405d6ba47f7b3b5841250cc09638f4b44d487206a37f5dac1d8deb70ede1fb504a2635456a9e0c88a40b9e930840d6b0a8c76b4863bf658ea031ddd084dbca
+  metadata.gz: 7cbfb5be0c692cae31a82b7fc9a817ea443b13549ad92d73ac3d40db371b3ecdba0cc2f7f73dec9407043d5938f00519e6cdc40f990cb9b1cd1c82e544c44e54
+  data.tar.gz: 43fd8714dd9126d3a51246ed7f500a4da7640f2d72c039ea511dfccbd0799bb4103492eccf87ed03ea4dae09eb64c79b20a797e25d84c248596b47319a85f3d8

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.2.1 (2023-11-12)
+
+- Added `result_object` option
+
+## 0.2.0 (2023-05-07)
+
+- Fixed error with Spark 3.4.0
+- Dropped support for Ruby < 3
+
 ## 0.1.1 (2021-01-25)
 
 - Improved typecasting

data/README.md

@@ -9,7 +9,7 @@ Ruby client for Apache Spark SQL and Apache Hive
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'hexspace'
+gem "hexspace"
 ```
 
 ## Getting Started
@@ -46,6 +46,24 @@ Supported modes are `:sasl`, `:nosasl`, `:http`, and `:https`. Please create an
 
 The timeout is in seconds and only applies to `:sasl` and `:nosasl`.
 
+## Query Options
+
+Set a timeout
+
+```ruby
+client.execute(statement, timeout: 10)
+```
+
+Get a `Hexspace::Result` object instead of an array of hashes
+
+```ruby
+result = client.execute(statement, result_object: true)
+result.rows
+result.columns
+result.column_types
+result.to_a
+```
+
 ## Spark SQL Setup
 
 Download [Apache Spark](https://spark.apache.org/downloads.html) and start the [Thift server](https://spark.apache.org/docs/latest/sql-distributed-sql-engine.html).

data/lib/hexspace/client.rb

@@ -48,12 +48,12 @@ module Hexspace
       ObjectSpace.define_finalizer(self, self.class.finalize(@transport, @client, @session))
     end
 
-    # TODO add new method that returns Result object
-    # so its possible to get duplicate columns
-    # as well as columns when there are no rows
-    def execute(statement, timeout: nil)
+    def execute(statement, timeout: nil, result_object: false)
       result = execute_statement(statement, timeout: timeout)
-      process_result(result) if result.operationHandle.hasResultSet
+      if result.operationHandle.hasResultSet
+        result = process_result(result)
+        result_object ? result : result.to_a
+      end
     end
 
     # private
@@ -105,14 +105,15 @@ module Hexspace
         new_rows = 0
         start_offset = result.results.startRowOffset
 
-        result.results.columns.each_with_index do |col, j|
+        # columns can be nil with Spark 3.4+
+        result.results.columns&.each_with_index do |col, j|
           name = columns[j]
           value = col.get_value
 
           if j == 0
             new_rows = value.values.size
             new_rows.times do
-              rows << {}
+              rows << []
             end
           end
 
@@ -129,17 +130,17 @@ module Hexspace
           #   end
           when "date"
             values.each do |v|
-              rows[offset][name] = nulls[offset] == "1" ? nil : Date.parse(v)
+              rows[offset][j] = nulls[offset] == "1" ? nil : Date.parse(v)
               offset += 1
             end
           when "decimal"
             values.each do |v|
-              rows[offset][name] = nulls[offset] == "1" ? nil : BigDecimal(v)
+              rows[offset][j] = nulls[offset] == "1" ? nil : BigDecimal(v)
               offset += 1
             end
           else
             values.each do |v|
-              rows[offset][name] = nulls[offset] == "1" ? nil : v
+              rows[offset][j] = nulls[offset] == "1" ? nil : v
               offset += 1
             end
           end
@@ -152,7 +153,7 @@ module Hexspace
       req.operationHandle = stmt.operationHandle
       check_status client.CloseOperation(req)
 
-      rows
+      Result.new(rows, columns, types)
     end
   end
 end

data/lib/hexspace/result.rb

@@ -0,0 +1,17 @@
+module Hexspace
+  class Result
+    attr_reader :rows, :columns, :column_types
+
+    def initialize(rows, columns, column_types)
+      @rows = rows
+      @columns = columns
+      @column_types = column_types
+    end
+
+    def to_a
+      @rows.map do |row|
+        @columns.zip(row).to_h
+      end
+    end
+  end
+end

data/lib/hexspace/tcli_service.rb

@@ -1,5 +1,5 @@
 #
-# Autogenerated by Thrift Compiler (0.13.0)
+# Autogenerated by Thrift Compiler (0.18.1)
 #
 # DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
 #
@@ -20,6 +20,11 @@ module Hexspace
       end
 
       def recv_OpenSession()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(OpenSession_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'OpenSession failed: unknown result')
@@ -35,6 +40,11 @@ module Hexspace
       end
 
       def recv_CloseSession()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(CloseSession_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'CloseSession failed: unknown result')
@@ -50,6 +60,11 @@ module Hexspace
       end
 
       def recv_GetInfo()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetInfo_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetInfo failed: unknown result')
@@ -65,6 +80,11 @@ module Hexspace
       end
 
       def recv_ExecuteStatement()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(ExecuteStatement_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'ExecuteStatement failed: unknown result')
@@ -80,6 +100,11 @@ module Hexspace
       end
 
       def recv_GetTypeInfo()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetTypeInfo_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetTypeInfo failed: unknown result')
@@ -95,6 +120,11 @@ module Hexspace
       end
 
       def recv_GetCatalogs()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetCatalogs_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetCatalogs failed: unknown result')
@@ -110,6 +140,11 @@ module Hexspace
       end
 
       def recv_GetSchemas()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetSchemas_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetSchemas failed: unknown result')
@@ -125,6 +160,11 @@ module Hexspace
       end
 
       def recv_GetTables()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetTables_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetTables failed: unknown result')
@@ -140,6 +180,11 @@ module Hexspace
       end
 
       def recv_GetTableTypes()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetTableTypes_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetTableTypes failed: unknown result')
@@ -155,6 +200,11 @@ module Hexspace
       end
 
       def recv_GetColumns()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetColumns_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetColumns failed: unknown result')
@@ -170,6 +220,11 @@ module Hexspace
       end
 
       def recv_GetFunctions()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetFunctions_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetFunctions failed: unknown result')
@@ -185,6 +240,11 @@ module Hexspace
       end
 
       def recv_GetPrimaryKeys()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetPrimaryKeys_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetPrimaryKeys failed: unknown result')
@@ -200,6 +260,11 @@ module Hexspace
       end
 
       def recv_GetCrossReference()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetCrossReference_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetCrossReference failed: unknown result')
@@ -215,6 +280,11 @@ module Hexspace
       end
 
       def recv_GetOperationStatus()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetOperationStatus_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetOperationStatus failed: unknown result')
@@ -230,6 +300,11 @@ module Hexspace
       end
 
       def recv_CancelOperation()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(CancelOperation_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'CancelOperation failed: unknown result')
@@ -245,6 +320,11 @@ module Hexspace
       end
 
       def recv_CloseOperation()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(CloseOperation_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'CloseOperation failed: unknown result')
@@ -260,6 +340,11 @@ module Hexspace
       end
 
       def recv_GetResultSetMetadata()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetResultSetMetadata_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetResultSetMetadata failed: unknown result')
@@ -275,6 +360,11 @@ module Hexspace
       end
 
       def recv_FetchResults()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(FetchResults_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'FetchResults failed: unknown result')
@@ -290,6 +380,11 @@ module Hexspace
       end
 
       def recv_GetDelegationToken()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(GetDelegationToken_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'GetDelegationToken failed: unknown result')
@@ -305,6 +400,11 @@ module Hexspace
       end
 
       def recv_CancelDelegationToken()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(CancelDelegationToken_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'CancelDelegationToken failed: unknown result')
@@ -320,6 +420,11 @@ module Hexspace
       end
 
       def recv_RenewDelegationToken()
+        fname, mtype, rseqid = receive_message_begin()
+        handle_exception(mtype)
+        if reply_seqid(rseqid)==false
+          raise "seqid reply faild"
+        end
         result = receive_message(RenewDelegationToken_result)
         return result.success unless result.success.nil?
         raise ::Thrift::ApplicationException.new(::Thrift::ApplicationException::MISSING_RESULT, 'RenewDelegationToken failed: unknown result')

data/lib/hexspace/tcli_service_constants.rb

@@ -1,5 +1,5 @@
 #
-# Autogenerated by Thrift Compiler (0.13.0)
+# Autogenerated by Thrift Compiler (0.18.1)
 #
 # DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
 #

data/lib/hexspace/tcli_service_types.rb

@@ -1,5 +1,5 @@
 #
-# Autogenerated by Thrift Compiler (0.13.0)
+# Autogenerated by Thrift Compiler (0.18.1)
 #
 # DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
 #

data/lib/hexspace/version.rb

@@ -1,3 +1,3 @@
 module Hexspace
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

data/lib/hexspace.rb

@@ -6,14 +6,15 @@ require "bigdecimal"
 require "time"
 
 # thrift
-require "hexspace/tcli_service_constants"
-require "hexspace/tcli_service_types"
-require "hexspace/tcli_service"
+require_relative "hexspace/tcli_service_constants"
+require_relative "hexspace/tcli_service_types"
+require_relative "hexspace/tcli_service"
 
 # modules
-require "hexspace/client"
-require "hexspace/sasl_transport"
-require "hexspace/version"
+require_relative "hexspace/client"
+require_relative "hexspace/result"
+require_relative "hexspace/sasl_transport"
+require_relative "hexspace/version"
 
 module Hexspace
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexspace
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2023-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thrift
@@ -16,16 +16,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
 description:
-email: andrew@chartkick.com
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -35,6 +35,7 @@ files:
 - README.md
 - lib/hexspace.rb
 - lib/hexspace/client.rb
+- lib/hexspace/result.rb
 - lib/hexspace/sasl_transport.rb
 - lib/hexspace/tcli_service.rb
 - lib/hexspace/tcli_service_constants.rb
@@ -52,14 +53,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Ruby client for Apache Spark SQL and Apache Hive