mini_sql 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 491de0ce7925ad9ec428409af4a78e5ce3f91b6f886bfcca7c17544a4b44e23a
-  data.tar.gz: 2269da4aa96ec6d58c2141b82cae6d3764664e312ada254fe7f45476e6cb5b55
+  metadata.gz: 1160fe3ddc5b4d248f62efcb205d6bc83982912355a932f23ab9620fbbd0c8fe
+  data.tar.gz: f60fe47f807aa8273ce5d018611f111b0e99b21552ac258ac0b8594035fb0725
 SHA512:
-  metadata.gz: dddf4370cdff6041fc2a0ceb338aa387ddcca76b65e135838cd0c3a1bfcf0bd0fcae37ea7504052b89b505b8c5478fb6d11e260e2349e25131b01853d42eae2d
-  data.tar.gz: 8d2f7087f39d05a4e8ccf72e675a07a38d9f371bdcfef33d96589a085f13abef53feb6986668fb12c75886ff9db301c0b7753b36e72177ef33944f08ce347734
+  metadata.gz: ca800672b020af15bb69ca8b3cad63d435835c67f27d052ee01039eb31b7f0f8c4719ca9330f3ada3ff29b4442f2f423861686876e004d72bad7116be9b08235
+  data.tar.gz: 9394f995fe546af9c908597928699f7a1214dc3b5ae18ddb4a224b2c1d335da4a17be63c6e4b25adc0b8984af43259eec1ebaec0ceeceef31678115dbe790cae

data/.github/workflows/ci.yml

@@ -36,7 +36,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.1", "3.0", "2.7"]
+        ruby: ["3.1", "3.2", "3.3"]
         experimental: [false]
         include:
           - ruby: ruby-head

data/CHANGELOG

@@ -1,3 +1,8 @@
+2024-08-21 - 1.6.0
+
+- FEATURE: optionaly allow encoding pg arrays efficiently
+- FEATURE: decoder for pgvector
+
 2023-08-16 - 1.5.0
 
 - FEATURE: add to_sql for easy conversion of builder to sql

data/README.md

@@ -56,6 +56,15 @@ p conn.query_array("select 1 as a, '2' as b union select 3, 'e'").to_h
 # {1 => '2', 3 => 'e'}
 ```
 
+## Auto Encode Arrays (only PostgreSQL)
+```ruby
+pg_conn = PG.connect(db_name: 'my_db')
+conn = MiniSql::Connection.get(pg_conn, auto_encode_arrays: true)
+
+# select * from table where id = ANY('{1,2,3}')
+conn.query("select * from table where id = ANY(?)", [1, 2, 3])
+```
+
 ## The query builder
 
 You can use the simple query builder interface to compose queries.
@@ -241,15 +250,33 @@ Streaming support is only implemented in the postgres backend at the moment, PRs
 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)
+```
+
+### Prepared Statement Bloat in PostgreSQL
+By default prepared cache size is __500__ queries per connection. Use prepared queries only for frequent queries.
+
+The following code will create 100 prepared statements in PostgreSQL for a single database connection:
 
-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
+```ruby
+100.times do |i|
+  ids = (1..i).to_a
+  conn.prepared.query("SELECT * FROM table WHERE id IN (?)", ids)
+end
+```
+
+This can lead to high memory usage and performance issues due to the overhead of maintaining numerous prepared statements.
+
+To improve performance, you can enable `auto_encode_arrays: true`. With this option, only one prepared statement is created, regardless of the size of ids:
+
+```ruby
+pg_conn = PG.connect(db_name: 'my_db')
+conn = MiniSql::Connection.get(pg_conn, auto_encode_arrays: true)
+100.times do |i|
+  ids = (1..i).to_a
+  conn.prepared.query("select * from table where id = ANY (?)", ids)
+end
 ```
 
 ## Active Record Postgres
@@ -276,7 +303,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
   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
+  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 # or ankane/pgvector for testing vector type decoder
   export MINI_SQL_PG_USER=postgres
   export MINI_SQL_PG_HOST=127.0.0.1
   export MINI_SQL_PG_PORT=55432

data/lib/mini_sql/inline_param_encoder.rb

@@ -2,10 +2,11 @@
 
 module MiniSql
   class InlineParamEncoder
-    attr_reader :conn
+    attr_reader :conn, :array_encoder
 
-    def initialize(conn)
+    def initialize(conn, array_encoder = nil)
       @conn = conn
+      @array_encoder = array_encoder
     end
 
     def encode(sql, *params)
@@ -62,7 +63,7 @@ module MiniSql
       when false      then "false"
       when nil        then "NULL"
       when []         then "NULL"
-      when Array      then value.map { |v| quote_val(v) }.join(', ')
+      when Array      then array_encoder ? "'#{array_encoder.encode(value)}'" : value.map { |v| quote_val(v) }.join(', ')
       else raise TypeError, "can't quote #{value.class.name}"
       end
     end

data/lib/mini_sql/postgres/connection.rb

@@ -26,6 +26,20 @@ module MiniSql
             else
               map.add_coder(MiniSql::Postgres::Coders::TimestampUtc.new(name: "timestamp", oid: 1114, format: 0))
             end
+
+            if defined? Pgvector::PG
+              vector_oid =
+                PG::BasicTypeRegistry::CoderMapsBundle
+                  .new(conn)
+                  .typenames_by_oid
+                  .find { |k, v| v == "vector" }
+                  &.first
+
+              if !vector_oid.nil?
+                map.add_coder(Pgvector::PG::TextDecoder::Vector.new(name: "vector", oid: vector_oid, format: 0))
+                map.add_coder(Pgvector::PG::BinaryDecoder::Vector.new(name: "vector", oid: vector_oid, format: 1))
+              end
+            end
             map
           end
       end
@@ -38,7 +52,8 @@ module MiniSql
       def initialize(raw_connection, args = nil)
         @raw_connection = raw_connection
         @deserializer_cache = (args && args[:deserializer_cache]) || self.class.default_deserializer_cache
-        @param_encoder = (args && args[:param_encoder]) || InlineParamEncoder.new(self)
+        array_encoder = PG::TextEncoder::Array.new if args && args[:auto_encode_arrays]
+        @param_encoder = (args && args[:param_encoder]) || InlineParamEncoder.new(self, array_encoder)
         @type_map = args && args[:type_map]
       end
 

data/lib/mini_sql/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module MiniSql
-  VERSION = "1.5.0"
+  VERSION = "1.6.0"
 end

data/mini_sql.gemspec

@@ -49,5 +49,8 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency "mysql2"
     spec.add_development_dependency "sqlite3", "~> 1.4.4"
     spec.add_development_dependency "activerecord", "~> 7.0.0"
+    if RUBY_VERSION >= "3.0"
+      spec.add_development_dependency "pgvector", "~> 0.2.1"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_sql
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
+date: 2024-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler