mini_sql 1.0 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d668e0b456e27a572040825399ca9477d6c4404bfc09e6e87b1330a106491a0
-  data.tar.gz: 3fb2027b34d3837e06f6c92b7075f8811296c0750c5c4c3ae48d6053189a4000
+  metadata.gz: 8d46350915a655a1692de9b775f879609f83ff068bf9b62be6498672b223ee03
+  data.tar.gz: 192596f2834a676f123afcfb969a32267b311fe20318527ae13b92dd95efc757
 SHA512:
-  metadata.gz: 60449b0a92a13aa471dbc1dd6db2b8ba0571bca67f81bd46644bf8678ab794b5447e59cd3ea7a24d4732bcdb8eca44c9dfec748c57418d826444305395f62190
-  data.tar.gz: a249f769da221d659d1b4dceaf3dd153578fbda3f0951bdac938d178923a54ad852106629d76be38b5c4ad83c4175592b9971223f8e0aab49e91a48747ad7148
+  metadata.gz: 9820695fc27ced3ce61b2a131201c6bb954eca9919cd49f29f2877ebccbbd33ef8e36b4a0284d0a04fde9ec92c1f33bbfe75780515cdec26bdf9493e676b631d
+  data.tar.gz: d2ba6adbdf07a1a3fb11192ad949c8f632035a357d792eb895350ee3af30f7977d6b8e64d5df59b1338e9349d213e4472099593c6296e39203fac7ee8147da7d

data/.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
     name: Ruby ${{ matrix.ruby }}
     services:
       postgres:
-        image: postgres:9.6
+        image: postgres:10
         env:
           POSTGRES_PASSWORD: postgres
         ports:

data/CHANGELOG

@@ -1,3 +1,23 @@
+2021-03-22 - 1.1.3
+
+- DEV: reduce coupling of internal interfaces and allow or cleaner override of prepared connections
+
+2021-03-22 - 1.1.2
+
+- FEATURE: improve compatability with clients overriding raw_connection
+
+2021-03-22 - 1.1.1
+
+- FIX: compatability with ActiveRecord param encoder
+
+2021-03-22 - 1.1.0
+
+- FEATURE: added new APIs to support prepared statements
+
+2020-12-31 - 1.0.1
+
+- FIX: revert perf fix broke param_encoder interface, we were expecting never to be called if no encoding was to happen
+
 2020-12-30 - 1.0
 
 - Added serialization support using MiniSql::Serializer.to_json / .from_json

data/README.md

@@ -187,6 +187,21 @@ Note, in Postgres streaming is going to be slower than non-streaming options due
 
 Streaming support is only implemented in the postgres backend at the moment, PRs welcome to add to other backends.
 
+## Prepared Statements
+See [benchmark mini_sql](https://github.com/discourse/mini_sql/tree/master/bench/prepared_perf.rb)
+[benchmark mini_sql vs rails](https://github.com/discourse/mini_sql/tree/master/bench/bilder_perf.rb).
+
+By default prepared cache size is 500 queries. Use prepared queries only for frequent queries.
+
+```ruby
+conn.prepared.query("select * from table where id = ?", id: 10)
+
+ids = rand(100) < 90 ? [1] : [1, 2]
+builder = conn.build("select * from table /*where*/")
+builder.where("id IN (?)", ids)
+builder.prepared(ids.size == 1).query # most frequent query
+```
+
 ## I want more features!
 
 MiniSql is designed to be very minimal. Even though the query builder and type materializer give you a lot of mileage, it is not intended to be a fully fledged ORM. If you are looking for an ORM I recommend investigating ActiveRecord or Sequel which provide significantly more features.
@@ -194,6 +209,27 @@ MiniSql is designed to be very minimal. Even though the query builder and type m
 ## 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).
+### Local testing
+```bash
+  docker run --name mini-sql-mysql --rm -it -p 33306:3306 -e MYSQL_DATABASE=test_mini_sql -e MYSQL_ALLOW_EMPTY_PASSWORD=yes -d mysql:5.7
+  export MINI_SQL_MYSQL_HOST=127.0.0.1
+  export MINI_SQL_MYSQL_PORT=33306
+  
+  docker run --name mini-sql-postgres --rm -it -p 55432:5432 -e POSTGRES_DB=test_mini_sql -e POSTGRES_HOST_AUTH_METHOD=trust -d postgres
+  export MINI_SQL_PG_USER=postgres
+  export MINI_SQL_PG_HOST=127.0.0.1
+  export MINI_SQL_PG_PORT=55432
+
+  sleep 10 # waiting for up databases
+
+  bundle exec rake
+
+  # end working on mini-sql
+  docker stop mini-sql-postgres mini-sql-mysql
+```
+
+Sqlite tests rely on the SQLITE_STMT view existing. This is enabled by default on most systems, however some may
+opt for a leaner install. See: https://bugs.archlinux.org/task/70072. You may have to recompile sqlite on such systems.
 
 ## Contributing
 

data/bench/builder_perf.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'mini_sql', path: '../'
+  gem 'pg'
+  gem 'activerecord'
+  gem 'activemodel'
+  gem 'benchmark-ips'
+end
+
+require 'active_record'
+require 'benchmark/ips'
+require 'mini_sql'
+
+require '../mini_sql/bench/shared/generate_data'
+
+ar_connection, _ = GenerateData.new(count_records: 10_000).call
+MINI_SQL = MiniSql::Connection.get(ar_connection.raw_connection)
+
+def mini_sql(is_prepared, user_id)
+  MINI_SQL
+    .build(<<~SQL)
+      /*select*/ from topics /*join*/ /*where*/ /*group_by*/
+    SQL
+    .select('users.first_name, count(distinct topics.id) topics_count')
+    .join('users on user_id = users.id')
+    .join('categories on category_id = categories.id')
+    .where('users.id = ?', user_id)
+    .group_by('users.id')
+    .prepared(is_prepared)
+    .query
+end
+
+def mini_sql_optim(is_prepared, user_id)
+  @builder ||=
+    MINI_SQL
+      .build(<<~SQL)
+        /*select*/ from topics /*join*/ /*where*/ /*group_by*/
+      SQL
+      .select('users.first_name, count(distinct topics.id) topics_count')
+      .join('users on user_id = users.id')
+      .join('categories on category_id = categories.id')
+      .where('users.id = :user_id')
+      .group_by('users.id')
+
+  @builder
+    .prepared(is_prepared)
+    .query(user_id: user_id)
+end
+
+def ar_prepared(user_id)
+  Topic
+    .select(User.arel_table[:first_name] , Topic.arel_table[:id].count)
+    .joins(:user, :category)
+    .where(user_id: user_id)
+    .group(User.arel_table[:id])
+    .load
+end
+
+def ar_prepared_optim(user_id)
+  @rel ||= Topic
+    .select(User.arel_table[:first_name] , Topic.arel_table[:id].count)
+    .joins(:user, :category)
+    .group(User.arel_table[:id])
+
+  @rel
+    .where(user_id: user_id)
+    .load
+end
+
+def ar_unprepared(user_id)
+  Topic
+    .select('users.first_name, count(distinct topics.id) topics_count')
+    .joins(:user, :category)
+    .where(user_id: user_id)
+    .group('users.id')
+    .load
+end
+
+Benchmark.ips do |x|
+  x.report("mini_sql_prepared") do |n|
+    while n > 0
+      mini_sql(true, rand(100))
+      n -= 1
+    end
+  end
+  x.report("mini_sql") do |n|
+    while n > 0
+      mini_sql(false, rand(100))
+      n -= 1
+    end
+  end
+
+  x.report("mini_sql_prepared_optim") do |n|
+    while n > 0
+      mini_sql_optim(true, rand(100))
+      n -= 1
+    end
+  end
+  x.report("mini_sql_optim") do |n|
+    while n > 0
+      mini_sql_optim(false, rand(100))
+      n -= 1
+    end
+  end
+
+  x.report("ar_prepared") do |n|
+    while n > 0
+      ar_prepared(rand(100))
+      n -= 1
+    end
+  end
+
+  x.report("ar_prepared_optim") do |n|
+    while n > 0
+      ar_prepared_optim(rand(100))
+      n -= 1
+    end
+  end
+
+  x.report("ar_unprepared") do |n|
+    while n > 0
+      ar_unprepared(rand(100))
+      n -= 1
+    end
+  end
+
+  x.compare!
+end
+
+# Comparison:
+#    mini_sql_prepared:     8386.2 i/s
+#             mini_sql:     2742.3 i/s - 3.06x  (± 0.00) slower
+#          ar_prepared:     1599.3 i/s - 5.24x  (± 0.00) slower
+#        ar_unprepared:      868.9 i/s - 9.65x  (± 0.00) slower

data/bench/decorator_perf.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'pg', github: 'ged/ruby-pg'
+  gem 'mini_sql', path: '../'
+  gem 'activerecord'
+  gem 'activemodel'
+  gem 'benchmark-ips'
+  gem 'sequel', github: 'jeremyevans/sequel'
+  gem 'sequel_pg', github: 'jeremyevans/sequel_pg', require: 'sequel'
+  gem 'draper'
+  gem 'pry'
+end
+
+require 'active_record'
+require 'benchmark/ips'
+require 'mini_sql'
+
+require '../mini_sql/bench/shared/generate_data'
+
+ar_connection, conn_config = GenerateData.new(count_records: 1_000).call
+MINI_SQL = MiniSql::Connection.get(ar_connection.raw_connection)
+DB = Sequel.connect(ar_connection.instance_variable_get(:@config).slice(:database, :user, :password, :host, :adapter))
+
+
+# https://github.com/drapergem/draper
+class TopicDraper < Draper::Decorator
+  delegate :id
+
+  def title_bang
+    object.title + '!!!'
+  end
+end
+
+# https://ruby-doc.org/stdlib-2.5.1/libdoc/delegate/rdoc/SimpleDelegator.html
+class TopicSimpleDelegator < SimpleDelegator
+  def title_bang
+    title + '!!!'
+  end
+end
+
+class TopicSequel < Sequel::Model(DB[:topics]); end
+class TopicDecoratorSequel < TopicSequel
+  def title_bang
+    title + '!!!'
+  end
+end
+
+class Topic < ActiveRecord::Base;end
+class TopicArModel < Topic
+  def title_bang
+    title + '!!!'
+  end
+end
+
+module TopicDecorator
+  def title_bang
+    title + '!!!'
+  end
+end
+
+Benchmark.ips do |r|
+  r.report('query_decorator') do |n|
+    while n > 0
+      MINI_SQL.query_decorator(TopicDecorator, 'select id, title from topics order by id limit 1000').each do |obj|
+        obj.title_bang
+        obj.id
+      end
+      n -= 1
+    end
+  end
+  r.report('extend') do |n|
+    while n > 0
+      MINI_SQL.query('select id, title from topics order by id limit 1000').each do |obj|
+        d_obj = obj.extend(TopicDecorator)
+        d_obj.title_bang
+        d_obj.id
+      end
+      n -= 1
+    end
+  end
+  r.report('draper') do |n|
+    while n > 0
+      MINI_SQL.query('select id, title from topics order by id limit 1000').each do |obj|
+        d_obj = TopicDraper.new(obj)
+        d_obj.title_bang
+        d_obj.id
+      end
+      n -= 1
+    end
+  end
+  r.report('simple_delegator') do |n|
+    while n > 0
+      MINI_SQL.query('select id, title from topics order by id limit 1000').each do |obj|
+        d_obj = TopicSimpleDelegator.new(obj)
+        d_obj.title_bang
+        d_obj.id
+      end
+      n -= 1
+    end
+  end
+  r.report('query') do |n|
+    while n > 0
+      MINI_SQL.query('select id, title from topics order by id limit 1000').each do |obj|
+        obj.title + '!!!'
+        obj.id
+      end
+      n -= 1
+    end
+  end
+  r.report('ar model') do |n|
+    while n > 0
+      TopicArModel.limit(1000).order(:id).select(:id, :title).each do |obj|
+        obj.title_bang
+        obj.id
+      end
+      n -= 1
+    end
+  end
+  r.report('sequel model') do |n|
+    while n > 0
+      TopicDecoratorSequel.limit(1000).order(:id).select(:id, :title).each do |obj|
+        obj.title_bang
+        obj.id
+      end
+      n -= 1
+    end
+  end
+
+  r.compare!
+end
+
+# Comparison:
+#                query:     1102.9 i/s
+#      query_decorator:     1089.0 i/s - same-ish: difference falls within error
+#         sequel model:      860.2 i/s - 1.28x  (± 0.00) slower
+#     simple_delegator:      679.8 i/s - 1.62x  (± 0.00) slower
+#               extend:      678.1 i/s - 1.63x  (± 0.00) slower
+#               draper:      587.2 i/s - 1.88x  (± 0.00) slower
+#             ar model:      172.5 i/s - 6.39x  (± 0.00) slower

data/bench/mini_sql_methods_perf.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+  gem 'pg', github: 'ged/ruby-pg'
+  gem 'mini_sql', path: '../'
+  gem 'activerecord'
+  gem 'activemodel'
+  gem 'benchmark-ips'
+  gem 'draper'
+  gem 'pry'
+end
+
+require 'active_record'
+require 'benchmark/ips'
+require 'mini_sql'
+
+require '../mini_sql/bench/shared/generate_data'
+
+ar_connection, conn_config = GenerateData.new(count_records: 1_000).call
+MINI_SQL = MiniSql::Connection.get(ar_connection.raw_connection)
+
+
+Benchmark.ips do |r|
+  r.report('query_hash') do |n|
+    while n > 0
+      MINI_SQL.query_hash('select id, title from topics order by id limit 1000').each do |hash|
+        [hash['id'], hash['title']]
+      end
+      n -= 1
+    end
+  end
+  r.report('query_array') do |n|
+    while n > 0
+      MINI_SQL.query_array('select id, title from topics order by id limit 1000').each do |id, title|
+        [id, title]
+      end
+      n -= 1
+    end
+  end
+  r.report('query') do |n|
+    while n > 0
+      MINI_SQL.query('select id, title from topics order by id limit 1000').each do |obj|
+        [obj.id, obj.title]
+      end
+      n -= 1
+    end
+  end
+
+  r.compare!
+end
+
+# Comparison:
+#          query_array:     1663.3 i/s
+#                query:     1254.5 i/s - 1.33x  (± 0.00) slower
+#           query_hash:     1095.4 i/s - 1.52x  (± 0.00) slower
+
+
+Benchmark.ips do |r|
+  r.report('query_single') do |n|
+    while n > 0
+      MINI_SQL.query_single('select id from topics order by id limit 1000')
+      n -= 1
+    end
+  end
+  r.report('query_array') do |n|
+    while n > 0
+      MINI_SQL.query_array('select id from topics order by id limit 1000').flatten
+      n -= 1
+    end
+  end
+
+  r.compare!
+end
+
+# Comparison:
+#         query_single:     2445.1 i/s
+#          query_array:     1681.1 i/s - 1.45x  (± 0.00) slower