presto-client 0.1.0 → 0.2.0

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+tmp/*
+pkg/*

data/ChangeLog

@@ -0,0 +1,13 @@
+
+2014-01-22 version 0.2.0:
+
+* Added Query#cancel
+* Added Query#close
+* Added Client#run
+* Changed required_ruby_version from 1.9.3 to 1.9.1
+
+
+2014-01-07 version 0.1.0:
+
+* First release
+

data/README.md

@@ -10,25 +10,32 @@ This is a client library for Ruby to run queries on Presto.
 ```ruby
 require 'presto-client'
 
-# create a client object
-client = PrestoClient::Client.new(
+# create a client object:
+client = Presto::Client.new(
   server: "localhost:8880",
   user: "frsyuki",
   catalog: "native",
   schema: "default",
 )
 
-# start running a query on presto
-q = client.query("select * from sys.query")
-
-# wait for completion and get columns
-q.columns.each {|column|
-  puts "column: #{column.name}.#{column.type}"
-}
-
-# get query results
-q.each_row {|row|
+# run a query and get results:
+columns, rows = client.run("select * from sys.node")
+rows.each {|row|
   p row
 }
+
+# another way to run a query and fetch results streamingly:
+# start running a query on presto
+client.query("select * from sys.node") do |q|
+  # wait for completion and get columns
+  q.columns.each {|column|
+    puts "column: #{column.name}.#{column.type}"
+  }
+
+  # get query results
+  q.each_row {|row|
+    p row
+  }
+end
 ```
 

data/lib/presto/client/client.rb

@@ -23,8 +23,30 @@ module Presto::Client
       @session = ClientSession.new(options)
     end
 
-    def query(query)
-      Query.start(@session, query)
+    def query(query, &block)
+      if block
+        q = Query.start(@session, query)
+        begin
+          yield q
+        ensure
+          q.close
+        end
+      else
+        return Query.start(@session, query)
+      end
+    end
+
+    def run(query)
+      q = Query.start(@session, query)
+      begin
+        columns = q.columns
+        if columns.empty?
+          return [], []
+        end
+        return columns, q.rows
+      ensure
+        q.close
+      end
     end
   end
 

data/lib/presto/client/errors.rb

@@ -0,0 +1,42 @@
+#
+# Presto client for Ruby
+#
+#    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.
+#
+module Presto::Client
+  class PrestoError < StandardError
+  end
+
+  class PrestoHttpError < PrestoError
+    def initialize(status, message)
+      super(message)
+      @status = status
+    end
+
+    attr_reader :status
+  end
+
+  class PrestoClientError < PrestoError
+  end
+
+  class PrestoQueryError < PrestoError
+    def initialize(message, query_id, error_code, failure_info)
+      super(message)
+      @query_id = query_id
+      @error_code = error_code
+      @failure_info = failure_info
+    end
+
+    attr_reader :error_code, :failure_info
+  end
+end

data/lib/presto/client/models.rb

@@ -53,58 +53,58 @@ module Presto::Client
     end
   end
 
-  #class StageStats
-  #  attr_reader :stage_id
-  #  attr_reader :state
-  #  attr_reader :done
-  #  attr_reader :nodes
-  #  attr_reader :total_splits
-  #  attr_reader :queued_splits
-  #  attr_reader :running_splits
-  #  attr_reader :completed_splits
-  #  attr_reader :user_time_millis
-  #  attr_reader :cpu_time_millis
-  #  attr_reader :wall_time_millis
-  #  attr_reader :processed_rows
-  #  attr_reader :processed_bytes
-  #  attr_reader :sub_stages
-  #
-  #  def initialize(options={})
-  #    @stage_id = options[:stage_id]
-  #    @state = options[:state]
-  #    @done = options[:done]
-  #    @nodes = options[:nodes]
-  #    @total_splits = options[:total_splits]
-  #    @queued_splits = options[:queued_splits]
-  #    @running_splits = options[:running_splits]
-  #    @completed_splits = options[:completed_splits]
-  #    @user_time_millis = options[:user_time_millis]
-  #    @cpu_time_millis = options[:cpu_time_millis]
-  #    @wall_time_millis = options[:wall_time_millis]
-  #    @processed_rows = options[:processed_rows]
-  #    @processed_bytes = options[:processed_bytes]
-  #    @sub_stages = options[:sub_stages]
-  #  end
-  #
-  #  def self.decode_hash(hash)
-  #    new(
-  #      stage_id: hash["stageId"],
-  #      state: hash["state"],
-  #      done: hash["done"],
-  #      nodes: hash["nodes"],
-  #      total_splits: hash["totalSplits"],
-  #      queued_splits: hash["queuedSplits"],
-  #      running_splits: hash["runningSplits"],
-  #      completed_splits: hash["completedSplits"],
-  #      user_time_millis: hash["userTimeMillis"],
-  #      cpu_time_millis: hash["cpuTimeMillis"],
-  #      wall_time_millis: hash["wallTimeMillis"],
-  #      processed_rows: hash["processedRows"],
-  #      processed_bytes: hash["processedBytes"],
-  #      sub_stages: hash["subStages"].map {|h| StageStats.decode_hash(h) },
-  #    )
-  #  end
-  #end
+  class StageStats
+    attr_reader :stage_id
+    attr_reader :state
+    attr_reader :done
+    attr_reader :nodes
+    attr_reader :total_splits
+    attr_reader :queued_splits
+    attr_reader :running_splits
+    attr_reader :completed_splits
+    attr_reader :user_time_millis
+    attr_reader :cpu_time_millis
+    attr_reader :wall_time_millis
+    attr_reader :processed_rows
+    attr_reader :processed_bytes
+    attr_reader :sub_stages
+
+    def initialize(options={})
+      @stage_id = options[:stage_id]
+      @state = options[:state]
+      @done = options[:done]
+      @nodes = options[:nodes]
+      @total_splits = options[:total_splits]
+      @queued_splits = options[:queued_splits]
+      @running_splits = options[:running_splits]
+      @completed_splits = options[:completed_splits]
+      @user_time_millis = options[:user_time_millis]
+      @cpu_time_millis = options[:cpu_time_millis]
+      @wall_time_millis = options[:wall_time_millis]
+      @processed_rows = options[:processed_rows]
+      @processed_bytes = options[:processed_bytes]
+      @sub_stages = options[:sub_stages]
+    end
+
+    def self.decode_hash(hash)
+      new(
+        stage_id: hash["stageId"],
+        state: hash["state"],
+        done: hash["done"],
+        nodes: hash["nodes"],
+        total_splits: hash["totalSplits"],
+        queued_splits: hash["queuedSplits"],
+        running_splits: hash["runningSplits"],
+        completed_splits: hash["completedSplits"],
+        user_time_millis: hash["userTimeMillis"],
+        cpu_time_millis: hash["cpuTimeMillis"],
+        wall_time_millis: hash["wallTimeMillis"],
+        processed_rows: hash["processedRows"],
+        processed_bytes: hash["processedBytes"],
+        sub_stages: hash["subStages"] && hash["subStages"].map {|h| StageStats.decode_hash(h) },
+      )
+    end
+  end
 
   class StatementStats
     attr_reader :state
@@ -119,22 +119,22 @@ module Presto::Client
     attr_reader :wall_time_millis
     attr_reader :processed_rows
     attr_reader :processed_bytes
-    #attr_reader :root_stage
+    attr_reader :root_stage
 
     def initialize(options={})
-      @state = state
-      @scheduled = scheduled
-      @nodes = nodes
-      @total_splits = total_splits
-      @queued_splits = queued_splits
-      @running_splits = running_splits
-      @completed_splits = completed_splits
-      @user_time_millis = user_time_millis
-      @cpu_time_millis = cpu_time_millis
-      @wall_time_millis = wall_time_millis
-      @processed_rows = processed_rows
-      @processed_bytes = processed_bytes
-      #@root_stage = root_stage
+      @state = options[:state]
+      @scheduled = options[:scheduled]
+      @nodes = options[:nodes]
+      @total_splits = options[:total_splits]
+      @queued_splits = options[:queued_splits]
+      @running_splits = options[:running_splits]
+      @completed_splits = options[:completed_splits]
+      @user_time_millis = options[:user_time_millis]
+      @cpu_time_millis = options[:cpu_time_millis]
+      @wall_time_millis = options[:wall_time_millis]
+      @processed_rows = options[:processed_rows]
+      @processed_bytes = options[:processed_bytes]
+      @root_stage = options[:root_stage]
     end
 
     def self.decode_hash(hash)
@@ -151,7 +151,79 @@ module Presto::Client
         wall_time_millis: hash["wallTimeMillis"],
         processed_rows: hash["processedRows"],
         processed_bytes: hash["processedBytes"],
-        #root_stage: StageStats.decode_hash(hash["rootStage"]),
+        root_stage: hash["rootStage"] && StageStats.decode_hash(hash["rootStage"]),
+      )
+    end
+  end
+
+  class ErrorLocation
+    attr_reader :line_number
+    attr_reader :column_number
+
+    def initialize(options={})
+      @line_number = options[:line_number]
+      @column_number = options[:column_number]
+    end
+
+    def self.decode_hash(hash)
+      new(
+        line_number: hash["lineNumber"],
+        column_number: hash["columnNumber"],
+      )
+    end
+  end
+
+  class FailureInfo
+    attr_reader :type
+    attr_reader :message
+    attr_reader :cause
+    attr_reader :suppressed
+    attr_reader :stack
+    attr_reader :error_location
+
+    def initialize(options={})
+      @type = options[:type]
+      @message = options[:message]
+      @cause = options[:cause]
+      @suppressed = options[:suppressed]
+      @stack = options[:stack]
+      @error_location = options[:error_location]
+    end
+
+    def self.decode_hash(hash)
+      new(
+        type: hash["type"],
+        message: hash["message"],
+        cause: hash["cause"],
+        suppressed: hash["suppressed"] && hash["suppressed"].map {|h| FailureInfo.decode_hash(h) },
+        stack: hash["stack"],
+        error_location: hash["errorLocation"] && ErrorLocation.decode_hash(hash["errorLocation"]),
+      )
+    end
+  end
+
+  class QueryError
+    attr_reader :message
+    attr_reader :sql_state
+    attr_reader :error_code
+    attr_reader :error_location
+    attr_reader :failure_info
+
+    def initialize(options={})
+      @message = options[:message]
+      @sql_state = options[:sql_state]
+      @error_code = options[:error_code]
+      @error_location = options[:error_location]
+      @failure_info = options[:failure_info]
+    end
+
+    def self.decode_hash(hash)
+      new(
+        message: hash["message"],
+        sql_state: hash["sqlState"],
+        error_code: hash["errorCode"],
+        error_location: hash["errorLocation"] && ErrorLocation.decode_hash(hash["errorLocation"]),
+        failure_info: hash["failureInfo"] && FailureInfo.decode_hash(hash["failureInfo"]),
       )
     end
   end
@@ -183,10 +255,10 @@ module Presto::Client
         info_uri: hash["infoUri"],
         partial_cache_uri: hash["partialCancelUri"],
         next_uri: hash["nextUri"],
-        columns: hash["columns"] ? hash["columns"].map {|h| Column.decode_hash(h) } : nil,
+        columns: hash["columns"] && hash["columns"].map {|h| Column.decode_hash(h) },
         data: hash["data"],
-        stats: StatementStats.decode_hash(hash["stats"]),
-        error: hash["error"],  # TODO
+        stats: hash["stats"] && StatementStats.decode_hash(hash["stats"]),
+        error: hash["error"] && QueryError.decode_hash(hash["error"]),
       )
     end
   end

data/lib/presto/client/query.rb

@@ -17,6 +17,7 @@ module Presto::Client
 
   require 'faraday'
   require 'presto/client/models'
+  require 'presto/client/errors'
   require 'presto/client/statement_client'
 
   class Query
@@ -34,6 +35,8 @@ module Presto::Client
       @client = client
     end
 
+    attr_reader :client
+
     def wait_for_data
       while @client.has_next? && @client.current_results.data == nil
         @client.advance
@@ -50,32 +53,59 @@ module Presto::Client
       return @client.current_results.columns
     end
 
+    def rows
+      rows = []
+      each_row_chunk {|chunk|
+        rows.concat(chunk)
+      }
+      return rows
+    end
+
     def each_row(&block)
+      each_row_chunk {|chunk|
+        chunk.each(&block)
+      }
+    end
+
+    def each_row_chunk(&block)
       wait_for_data
 
       raise_error unless @client.query_succeeded?
 
       if self.columns == nil
-        raise "Query #{@client.current_results.id} has no columns"
+        raise PrestoError, "Query #{@client.current_results.id} has no columns"
       end
 
       begin
         if data = @client.current_results.data
-          data.each(&block)
+          block.call(data)
         end
         @client.advance
       end while @client.has_next?
     end
 
+    def cancel
+      @client.cancel_leaf_stage
+    end
+
+    def close
+      @client.cancel_leaf_stage
+      nil
+    end
+
     def raise_error
       if @client.closed?
-        raise "Query aborted by user"
+        raise PrestoClientError, "Query aborted by user"
       elsif @client.exception?
-        raise "Query is gone: #{@client.exception}"
+        # query is gone
+        raise @client.exception
       elsif @client.query_failed?
         results = @client.current_results
-        # TODO error location
-        raise "Query #{results.id} failed: #{results.error}"
+        error = results.error
+        unless error
+          raise PrestoQueryError.new("Query #{results.id} failed: (unknown reason)", results.id, nil, nil)
+        end
+        raise PrestoQueryError.new("Query #{results.id} failed: #{error.message}", results.id, error.error_code, error.failure_info)
       end
     end
 

data/lib/presto/client/statement_client.rb

@@ -17,6 +17,7 @@ module Presto::Client
 
   require 'multi_json'
   require 'presto/client/models'
+  require 'presto/client/errors'
 
   module PrestoHeaders
     PRESTO_USER = "X-Presto-User"
@@ -68,7 +69,7 @@ module Presto::Client
 
       # TODO error handling
       if response.status != 200
-        raise "Failed to start query: #{response.body}"  # TODO error class
+        raise PrestoHttpError.new(response.status, "Failed to start query: #{response.body}")
       end
 
       body = response.body
@@ -136,7 +137,7 @@ module Presto::Client
 
         if response.status != 503  # retry on 503 Service Unavailable
           # deterministic error
-          @exception = StandardError.new("Error fetching next at #{uri} returned #{response.status}: #{response.body}")  # TODO error class
+          @exception = PrestoHttpError.new(response.status, "Error fetching next at #{uri} returned #{response.status}: #{response.body}")
           raise @exception
         end
 
@@ -144,21 +145,26 @@ module Presto::Client
         sleep attempts * 0.1
       end while (Time.now - start) < 2*60*60 && !@closed
 
-      @exception = StandardError.new("Error fetching next")  # TODO error class
+      @exception = PrestoHttpError.new(408, "Error fetching next due to timeout")
       raise @exception
     end
 
-    def close
-      return if @closed
-
-      # cancel running statement
+    def cancel_leaf_stage
       if uri = @results.next_uri
-        # TODO error handling
-        # TODO make async reqeust and ignore response
-        @faraday.delete do |req|
+        response = @faraday.delete do |req|
           req.url uri
         end
+        return response.status / 100 == 2
       end
+      return false
+    end
+
+    def close
+      return if @closed
+
+      # cancel running statement
+      # TODO make async reqeust and ignore response?
+      cancel_leaf_stage
 
       @closed = true
       nil

data/lib/presto/client/version.rb

@@ -15,6 +15,6 @@
 #
 module Presto
   module Client
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/presto-client.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.has_rdoc = false
 
-  gem.required_ruby_version = ">= 1.9.3"
+  gem.required_ruby_version = ">= 1.9.1"
 
   gem.add_dependency "faraday", ["~> 0.8.8"]
   gem.add_dependency "multi_json", ["~> 1.0"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: presto-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -98,13 +98,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- ChangeLog
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - lib/presto-client.rb
 - lib/presto/client.rb
 - lib/presto/client/client.rb
+- lib/presto/client/errors.rb
 - lib/presto/client/models.rb
 - lib/presto/client/query.rb
 - lib/presto/client/statement_client.rb
@@ -125,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -134,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1002266789771022757
+      hash: 453544593424709681
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23

data/Gemfile.lock

@@ -1,38 +0,0 @@
-PATH
-  remote: .
-  specs:
-    presto-client (0.1.0)
-      faraday (~> 0.8.8)
-      multi_json (~> 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.5)
-    crack (0.3.2)
-    diff-lcs (1.2.4)
-    faraday (0.8.8)
-      multipart-post (~> 1.2.0)
-    multi_json (1.8.2)
-    multipart-post (1.2.0)
-    rake (10.1.1)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
-    webmock (1.16.1)
-      addressable (>= 2.2.7)
-      crack (>= 0.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  presto-client!
-  rake (>= 0.9.2)
-  rspec (~> 2.13.0)
-  webmock (~> 1.16.1)