mini_sql 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fc60087b4254ce21f8cbe17e3ecbfd980f93a95bbe258f9a7a4d78d7a057d7b
-  data.tar.gz: e2f13c9b9c8f4e3f91570d405a59ba3cfc9c742dd8ecbaeebd75a3b4190fe085
+  metadata.gz: 5fe7bfcf37c73b216a8532cd6b17957733213610c73924e241ba36619ae4ce04
+  data.tar.gz: 21e2f615add1039d3cd6363ce1bdea501dc2b9bc08d17565cb8b6378a508e04e
 SHA512:
-  metadata.gz: 41fb7cdb0ea9365a733629fb1f1c863e3153c077d03754c123249cea1da8edf5ce3e8fd19b95f5922b61cfd4742d87f1431b92b25c974b6a438fa4b449a8b915
-  data.tar.gz: 0e0b2b47a5ed734a4d1bf3d54ce827f27df9a59c886e83913c2eb20abefa8fc88528ee25988ee69042f996a52fd54259160914fb6c56e57f44456b39e6fc361e
+  metadata.gz: 5c8de4d35f5d332dd53925502b3d696782a90862b47e75b28e7402b85f7735c675c64ffd6027e419328396114dd9e1d8fcd62760ceda42e58576f52727da0411
+  data.tar.gz: 23e73177710c4ac500bf2a6d96de4c0b9d191526c9e68cd7fcd29d39a3fd686e39a59ade520bc35f60279b3daf78bd3365b1be06b33642f42ee932946734ed98

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock

data/README.md

@@ -27,19 +27,40 @@ conn = MiniSql::Connection.new(pg_conn)
 puts conn.exec('update table set column = 1 where id in (1,2)')
 # returns 2 if 2 rows changed
 
-conn.query("select 1 id, 'bob' name") do |user|
+conn.query("select 1 id, 'bob' name").each do |user|
   puts user.name # bob
   puts user.id # 1
 end
 
-puts conn.query_single('select 1 union select 2')
+p conn.query_single('select 1 union select 2')
 # [1,2]
 
+p conn.query_hash('select 1 as a, 2 as b union select 3, 4')
+# [{"a" => 1, "b"=> 1},{"a" => 3, "b" => 4}
+```
+
+## The query builder
+
+You can use the simple query builder interface to compose queries.
+
+```ruby
+builder = conn.build("select * from topics /*where*/ /*limit*/")
+
+if look_for_something
+  builder.where("title = :title", title: 'something')
+end
+
+builder.limit(20)
+
+builder.query.each do |t|
+  puts t.id
+  puts t.title
+end
 ```
 
 ## Is it fast?
 
-Yes, it is very fast, see benchmarks [the bench directory](https://github.com/discourse/mini_sql/tree/master/bench)
+Yes, it is very fast. See benchmarks in [the bench directory](https://github.com/discourse/mini_sql/tree/master/bench).
 
 As a rule it will outperform similar naive PG code while remaining safe.
 
@@ -47,14 +68,18 @@ As a rule it will outperform similar naive PG code while remaining safe.
 pg_conn = PG.connect(db_name: 'my_db')
 
 # this is slower, and less safe
-pg_conn.async_exec('select * from table') do |r|
+result = pg_conn.async_exec('select * from table')
+result.each do |r|
   name = r['name']
 end
+# ideally you want to remember to run r.clear here
 
 # this is faster and safer
 conn = MiniSql::Connection.new(pg_conn)
-conn.query('select * from table') do |r|
-  name = r.name
+r = conn.query('select * from table')
+
+r.each do |row|
+  name = row.name
 end
 ```
 
@@ -79,4 +104,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the MiniSql project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SamSaffron/mini_sql/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the MiniSql project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/discourse/mini_sql/blob/master/CODE_OF_CONDUCT.md).

data/bench/topic_perf.rb

@@ -168,7 +168,28 @@ def sequel_pluck_title_id
   s
 end
 
-results = [ar_title_id, ar_title_id_pluck, pg_title_id, mini_sql_title_id, sequel_pluck_title_id, sequel_select_title_id]
+# usage is not really recommended but just to compare to pluck lets have it
+def mini_sql_title_id_query_single
+  s = +""
+  i = 0
+  r = $mini_sql.query_single(-"select id, title from topics order by id limit 1000")
+  while i < r.length
+    s << r[i].to_s
+    s << r[i+1]
+    i += 2
+  end
+  s
+end
+
+results = [
+  ar_title_id,
+  ar_title_id_pluck,
+  pg_title_id,
+  mini_sql_title_id,
+  sequel_pluck_title_id,
+  sequel_select_title_id,
+  mini_sql_title_id_query_single
+]
 
 exit(-1) unless results.uniq.length == 1
 
@@ -241,12 +262,6 @@ Benchmark.ips do |r|
       n -= 1
     end
   end
-  r.report("sequel title id pluck") do |n|
-    while n > 0
-      sequel_pluck_title_id
-      n -= 1
-    end
-  end
   r.report("pg select title id") do |n|
     while n > 0
       pg_title_id
@@ -259,30 +274,58 @@ Benchmark.ips do |r|
       n -= 1
     end
   end
+  r.report("sequel title id pluck") do |n|
+    while n > 0
+      sequel_pluck_title_id
+      n -= 1
+    end
+  end
+  r.report("mini_sql query_single title id") do |n|
+    while n > 0
+      mini_sql_title_id_query_single
+      n -= 1
+    end
+  end
   r.compare!
 end
 
 
 # Calculating -------------------------------------
-#   ar select title id    144.043  (± 1.4%) i/s -    728.000  in   5.055454s
+#        wide topic ar      2.383k (± 4.9%) i/s -     12.005k in   5.050490s
+#    wide topic sequel      3.449k (± 3.2%) i/s -     17.591k in   5.104951s
+#        wide topic pg      7.345k (± 1.2%) i/s -     37.352k in   5.086015s
+#  wide topic mini sql      7.536k (± 1.4%) i/s -     38.220k in   5.072834s
+#
+# Comparison:
+#  wide topic mini sql:     7535.8 i/s
+#        wide topic pg:     7345.1 i/s - same-ish: difference falls within error
+#    wide topic sequel:     3449.4 i/s - 2.18x  slower
+#        wide topic ar:     2382.9 i/s - 3.16x  slower
+#
+# Calculating -------------------------------------
+#   ar select title id    131.572  (± 3.8%) i/s -    658.000  in   5.008231s
 # ar select title id pluck
-#                         712.818  (± 1.5%) i/s -      3.570k in   5.009412s
+#                         696.233  (± 3.7%) i/s -      3.519k in   5.061335s
 # sequel title id select
-#                         927.011  (± 1.8%) i/s -      4.655k in   5.023228s
-# sequel title id pluck
-#                           1.183k (± 3.2%) i/s -      5.967k in   5.048635s
-#   pg select title id      1.040k (± 1.4%) i/s -      5.253k in   5.051679s
+#                         916.841  (± 3.7%) i/s -      4.655k in   5.084499s
+#   pg select title id      1.002k (± 4.0%) i/s -      5.044k in   5.040584s
 # mini_sql select title id
-#                           1.139k (± 2.5%) i/s -      5.712k in   5.016383s
+#                           1.106k (± 2.4%) i/s -      5.618k in   5.084423s
+# sequel title id pluck
+#                           1.181k (± 3.5%) i/s -      5.980k in   5.069815s
+# mini_sql query_single title id
+#                           1.171k (± 3.1%) i/s -      5.880k in   5.025793s
 #
 # Comparison:
-# sequel title id pluck:     1183.1 i/s
-# mini_sql select title id:     1139.3 i/s - same-ish: difference falls within error
-#   pg select title id:     1040.1 i/s - 1.14x  slower
-# sequel title id select:      927.0 i/s - 1.28x  slower
-# ar select title id pluck:      712.8 i/s - 1.66x  slower
-#   ar select title id:      144.0 i/s - 8.21x  slower
+# sequel title id pluck:     1181.0 i/s
+# mini_sql query_single title id:     1171.1 i/s - same-ish: difference falls within error
+# mini_sql select title id:     1105.6 i/s - 1.07x  slower
+#   pg select title id:     1002.2 i/s - 1.18x  slower
+# sequel title id select:      916.8 i/s - 1.29x  slower
+# ar select title id pluck:      696.2 i/s - 1.70x  slower
+#   ar select title id:      131.6 i/s - 8.98x  slower
 #
+
 # to run deep analysis run
 # MemoryProfiler.report do
 #   ar

data/lib/mini_sql/builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class MiniSql::Builder
 
   def initialize(connection, template)
@@ -8,9 +10,13 @@ class MiniSql::Builder
   end
 
   [:set, :where2, :where, :order_by, :limit, :left_join, :join, :offset, :select].each do |k|
-    define_method k do |data, args = {}|
+    define_method k do |data, *args|
       @args ||= {}
-      @args.merge!(args)
+      if Hash === args
+        @args.merge!(args)
+      elsif args && args.length > 0
+        data = @connection.param_encoder.encode(data, *args)
+      end
       @sections[k] ||= []
       @sections[k] << data
       self
@@ -24,21 +30,21 @@ class MiniSql::Builder
       joined = nil
       case k
       when :select
-        joined = "SELECT " << v.join(" , ")
+        joined = (+"SELECT ") << v.join(" , ")
       when :where, :where2
-        joined = "WHERE " << v.map { |c| "(" << c << ")" }.join(" AND ")
+        joined = (+"WHERE ") << v.map { |c| (+"(") << c << ")" }.join(" AND ")
       when :join
-        joined = v.map { |item| "JOIN " << item }.join("\n")
+        joined = v.map { |item| (+"JOIN ") << item }.join("\n")
       when :left_join
-        joined = v.map { |item| "LEFT JOIN " << item }.join("\n")
+        joined = v.map { |item| (+"LEFT JOIN ") << item }.join("\n")
       when :limit
-        joined = "LIMIT " << v.last.to_s
+        joined = (+"LIMIT ") << v.last.to_i.to_s
       when :offset
-        joined = "OFFSET " << v.last.to_s
+        joined = (+"OFFSET ") << v.last.to_i.to_s
       when :order_by
-        joined = "ORDER BY " << v.join(" , ")
+        joined = (+"ORDER BY ") << v.join(" , ")
       when :set
-        joined = "SET " << v.join(" , ")
+        joined = (+"SET ") << v.join(" , ")
       end
 
       sql.sub!("/*#{k}*/", joined)
@@ -46,20 +52,13 @@ class MiniSql::Builder
     sql
   end
 
-  def query(args = nil)
-    if args
-      @args.merge!(args)
-    end
-    sql = to_sql
-    @connection.query(sql, @args)
-  end
-
-  def exec(args = nil)
-    if args
-      @args.merge!(args)
-    end
-    sql = to_sql
-    @connection.exec(sql, @args)
+  [:query, :query_single, :query_hash, :exec].each do |m|
+    class_eval <<~RUBY
+      def #{m}(hash_args = nil)
+        hash_args = @args.merge(hash_args) if hash_args
+        @connection.#{m}(to_sql, hash_args || @args)
+      end
+    RUBY
   end
 
 end

data/lib/mini_sql/connection.rb

@@ -2,8 +2,7 @@
 
 module MiniSql
   class Connection
-    attr_reader :raw_connection
-    attr_reader :type_map
+    attr_reader :raw_connection, :type_map, :param_encoder
 
     def self.default_deserializer_cache
       @deserializer_cache ||= DeserializerCache.new
@@ -100,7 +99,7 @@ module MiniSql
 
     def run(sql, params)
       if params && params.length > 0
-        sql = @param_encoder.encode(sql, *params)
+        sql = param_encoder.encode(sql, *params)
       end
       raw_connection.async_exec(sql)
     end

data/lib/mini_sql/version.rb

@@ -1,3 +1,3 @@
 module MiniSql
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_sql
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2018-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,7 +119,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md

data/Gemfile.lock

@@ -1,73 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mini_sql (0.1.5)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.2.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    coderay (1.1.2)
-    concurrent-ruby (1.0.5)
-    ffi (1.9.25)
-    formatador (0.2.5)
-    guard (2.14.2)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-minitest (2.4.6)
-      guard-compat (~> 1.2)
-      minitest (>= 3.0)
-    i18n (1.0.1)
-      concurrent-ruby (~> 1.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lumberjack (1.0.13)
-    method_source (0.9.0)
-    minitest (5.11.3)
-    nenv (0.3.0)
-    notiffany (0.1.1)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    pg (1.0.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    ruby_dep (1.5.0)
-    shellany (0.0.1)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (~> 5.2)
-  bundler (~> 1.16)
-  guard (~> 2.14)
-  guard-minitest (~> 2.4)
-  mini_sql!
-  minitest (~> 5.0)
-  pg (~> 1.0.0)
-  rake (~> 10.0)
-
-BUNDLED WITH
-   1.16.2