mini_sql 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b4a853f294d878decdf635afbfe2ef4029fe994ec710172038ec2a9ac664980
-  data.tar.gz: 278a68ac45dda9070d30fd08d98ca9bb93ea6c8e5b378d7ebe7f085620797c77
+  metadata.gz: e88eaeeb85de88eed3c83b12481b9682a1de4327ee433098a46932866884c1d3
+  data.tar.gz: eac737d3b6281392099675b6d3bcd25d6493d836d66204fa7de229583c2a3be8
 SHA512:
-  metadata.gz: ae6b7f73423e5001d80f0fc027fe0f2c557ac4961c1868e642087c50b8147bf2fca8b3431f8bec2603c33d762c533be57bb742d1ea5983481b4c3045ca348e73
-  data.tar.gz: c6628d1b1ce3b9c2d0f6f553370f705f649d643c25ec1a524415fb5f3c871a9c93f80834698d6df8b82b04012917baaf3ada442bea585ddce3692bcc7af40870
+  metadata.gz: 166faf87640bb2a07fe7d2f4e146274f7229f8c56f61e4160c1296a7f5d9587a5e11be09168abd792807f3bc5a08cec21b835e2ae81dc978c175bec6e155d607
+  data.tar.gz: d43a73fa9abb29de17005b4e361c607509c7a34a82b88e07ad2a344820c3c1efe7bfced0358310c2286d1bf9cc63977c2159c8bbdc3df6233d028a3ca45dadec

data/.travis.yml

@@ -1,5 +1,21 @@
-sudo: false
 language: ruby
 rvm:
   - 2.5.1
-before_install: gem install bundler -v 1.16.2
+  - ruby-head
+
+before_install:
+  - gem install bundler
+
+cache: bundler
+sudo: false
+
+addons:
+  postgresql: 9.6
+
+install:
+  - createdb test_mini_sql
+  - bundle install
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mini_sql (0.1.1)
+    mini_sql (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -37,6 +37,34 @@ puts conn.query_single('select 1 union select 2')
 
 ```
 
+## Is it fast?
+
+Yes, it is very fast, see benchmarks [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.
+
+```ruby
+pg_conn = PG.connect(db_name: 'my_db')
+
+# this is slower, and less safe
+pg_conn.async_exec('select * from table') do |r|
+  name = r['name']
+end
+
+# this is faster and safer
+conn = MiniSql::Connection.new(pg_conn)
+conn.query('select * from table') do |r|
+  name = r.name
+end
+```
+
+## Safety
+
+In current version of the PG gem you should be careful to clear results. If you do not you risk memory bloat.
+See: [Sam's blog post](https://samsaffron.com/archive/2018/06/13/ruby-x27-s-external-malloc-problem).
+
+MiniSql is careful to always clear results as soon as possible.
+
 ## Development
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/bench/topic_perf.rb

@@ -34,7 +34,7 @@ SQL
 
 pg.async_exec <<SQL
 CREATE TABLE topics (
-    id integer NOT NULL,
+    id integer NOT NULL PRIMARY KEY,
     title character varying NOT NULL,
     last_posted_at timestamp without time zone,
     created_at timestamp without time zone NOT NULL,
@@ -172,6 +172,56 @@ results = [ar_title_id, ar_title_id_pluck, pg_title_id, mini_sql_title_id, seque
 
 exit(-1) unless results.uniq.length == 1
 
+
+def wide_topic_ar
+  Topic.first
+end
+
+def wide_topic_pg
+  r = $conn.async_exec("select * from topics limit 1")
+  row = r.first
+  r.clear
+  row
+end
+
+def wide_topic_sequel
+  TopicSequel.first
+end
+
+def wide_topic_mini_sql
+  $conn.query("select * from topics limit 1").first
+end
+
+Benchmark.ips do |r|
+  r.report("wide topic ar") do |n|
+    while n > 0
+      wide_topic_ar
+      n -= 1
+    end
+  end
+  r.report("wide topic sequel") do |n|
+    while n > 0
+      wide_topic_sequel
+      n -= 1
+    end
+  end
+  r.report("wide topic pg") do |n|
+    while n > 0
+      wide_topic_pg
+      n -= 1
+    end
+  end
+  r.report("wide topic mini sql") do |n|
+    while n > 0
+      wide_topic_mini_sql
+      n -= 1
+    end
+  end
+  r.compare!
+end
+
+
+
 Benchmark.ips do |r|
   r.report("ar select title id") do |n|
     while n > 0

data/lib/mini_sql.rb

@@ -1,6 +1,7 @@
 require_relative "mini_sql/version"
 require_relative "mini_sql/connection"
 require_relative "mini_sql/deserializer_cache"
+require_relative "mini_sql/builder"
 
 module MiniSql
   autoload :Coders, "mini_sql/coders"

data/lib/mini_sql/builder.rb

@@ -0,0 +1,65 @@
+class MiniSql::Builder
+
+  def initialize(connection, template)
+    @args = {}
+    @sql = template
+    @sections = {}
+    @connection = connection
+  end
+
+  [:set, :where2, :where, :order_by, :limit, :left_join, :join, :offset, :select].each do |k|
+    define_method k do |data, args = {}|
+      @args.merge!(args)
+      @sections[k] ||= []
+      @sections[k] << data
+      self
+    end
+  end
+
+  def to_sql
+    sql = @sql.dup
+
+    @sections.each do |k, v|
+      joined = nil
+      case k
+      when :select
+        joined = "SELECT " << v.join(" , ")
+      when :where, :where2
+        joined = "WHERE " << v.map { |c| "(" << c << ")" }.join(" AND ")
+      when :join
+        joined = v.map { |item| "JOIN " << item }.join("\n")
+      when :left_join
+        joined = v.map { |item| "LEFT JOIN " << item }.join("\n")
+      when :limit
+        joined = "LIMIT " << v.last.to_s
+      when :offset
+        joined = "OFFSET " << v.last.to_s
+      when :order_by
+        joined = "ORDER BY " << v.join(" , ")
+      when :set
+        joined = "SET " << v.join(" , ")
+      end
+
+      sql.sub!("/*#{k}*/", joined)
+    end
+    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.query(sql, args)
+  end
+
+end
+

data/lib/mini_sql/coders.rb

@@ -5,5 +5,10 @@ module MiniSql
         string.to_f
       end
     end
+    class IPAddrCoder < PG::SimpleDecoder
+      def decode(string, tuple = nil, field = nil)
+        IPAddr.new(string)
+      end
+    end
   end
 end

data/lib/mini_sql/connection.rb

@@ -10,6 +10,7 @@ module MiniSql
         begin
           map = PG::BasicTypeMapForResults.new(conn)
           map.add_coder(MiniSql::Coders::NumericCoder.new(name: "numeric", oid: 1700, format: 0))
+          map.add_coder(MiniSql::Coders::IPAddrCoder.new(name: "inet", oid: 869, format: 0))
         end
     end
 
@@ -43,6 +44,10 @@ module MiniSql
       result.clear if result
     end
 
+    def build(sql)
+      Builder.new(self, sql)
+    end
+
     private
 
     def run(sql, params)
@@ -55,11 +60,26 @@ module MiniSql
 
     def process_params(sql, params)
       sql = sql.dup
-      param_array = []
+      param_array = nil
 
-      params.each do |k, v|
-        sql.gsub!(":#{k.to_s}", "$#{param_array.length + 1}")
-        param_array << v
+      if Hash === params
+        param_array = []
+        params.each do |k, v|
+          sql.gsub!(":#{k.to_s}", "$#{param_array.length + 1}")
+          param_array << v
+        end
+      elsif Array === params
+        i = 0
+        sql.gsub!("?") do
+          i += 1
+          case params[i-1]
+          when Integer then "$#{i}::bigint"
+          when Float then "$#{i}::float8"
+          when String then "$#{i}::text"
+          else "$#{i}::unknown"
+          end
+        end
+        param_array = params
       end
 
       [sql, param_array]

data/lib/mini_sql/version.rb

@@ -1,3 +1,3 @@
 module MiniSql
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_sql
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-15 00:00:00.000000000 Z
+date: 2018-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler