extralite 2.3 → 2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 130809d0ec92b7ae91e31f05e24c072500ef3096bda542a293469f1e206ff8eb
-  data.tar.gz: b7236d13577003ed2ccd806eb31b3a6703d3126196147f78220504b7fd0264b8
+  metadata.gz: dd2ac51ceb97cc6476f169da43fd11d6dad00ac39d5e9fd5eb0d4842ce670f0e
+  data.tar.gz: f58478324015a1f1827c55ca8b2170b177b270cad0ab8102be225a414da34148
 SHA512:
-  metadata.gz: 44b5ab1374077c97418b14581947aaa2dd20010590e21beaa755be9aaa6228b1408e5593c69f9f901f7935b0ba58494772cd9c0062b7632dc8c48d4ea54845bd
-  data.tar.gz: 218b35977b8ce307b9e738dfb280bfcfa4e67910542d03cf11aaec36acbaf61ba74db5c10f5b2d21364384c9cfbc830f91f945d5417dd00b6b090895dadfe276
+  metadata.gz: 3051d9b5d2a2543be9bdafd5b46aab5574acefa8ca946eaf34f5b1a8097154748f90ab6ba1b7fd76d5bb2b92d97599b35748be0d815258b4b3a499c6c5cefef7
+  data.tar.gz: 148d29ccfff66b0f1531000d0773b8de98b98169594c08ed032fccd7e92ffe1333357aa3da2e168d2b629d4c7b41b14af373e705601bf384b9d4a4f39af9c4f6

data/.editorconfig

@@ -0,0 +1,6 @@
+[*]
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2

data/.github/workflows/test-bundle.yml

@@ -0,0 +1,30 @@
+name: Tests (extralite-bundle)
+
+on: [push, pull_request]
+
+concurrency:
+  group: tests-${{ format('{0}-{1}', github.head_ref || github.run_number, github.job) }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: ['3.0', '3.1', '3.2', '3.3']
+
+    name: >-
+      ${{matrix.os}}, ${{matrix.ruby}}
+
+    runs-on: ${{matrix.os}}
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true # 'bundle install' and cache
+    - name: Compile C-extension
+      run: EXTRALITE_BUNDLE=1 bundle exec rake compile
+    - name: Run tests
+      run:  bundle exec rake test

data/.github/workflows/test.yml

@@ -1,21 +1,25 @@
-name: Tests
+name: Tests (extralite)
 
 on: [push, pull_request]
 
+concurrency:
+  group: tests-${{ format('{0}-{1}', github.head_ref || github.run_number, github.job) }}
+  cancel-in-progress: true
+
 jobs:
   build:
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: ['2.7', '3.0', '3.1', '3.2', '3.3']
+        ruby: ['3.0', '3.1', '3.2', '3.3']
 
     name: >-
       ${{matrix.os}}, ${{matrix.ruby}}
 
     runs-on: ${{matrix.os}}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{matrix.ruby}}

data/.gitignore

@@ -10,6 +10,9 @@
 /test/version_tmp/
 /tmp/
 lib/extralite_ext.*
+Gemfile-bundle.lock
+/cmake-build-debug/
+CMakeLists.txt
 
 # Used by dotenv library to load environment variables.
 # .env

data/CHANGELOG.md

@@ -1,3 +1,43 @@
+# 2.5 2024-01-16
+
+- Update bundled sqlite to version 3.45.0
+- Implement `Database#batch_query` and related methods
+  [53](https://github.com/digital-fabric/extralite/issues/53)
+- Accept more options in `Database#initialize`
+  [48](https://github.com/digital-fabric/extralite/issues/48)
+- Fix `Database#pragma` to return single value when reading pragma value
+- Accept database name in `Database#tables` method
+- Improve `Database#batch_execute` - now accepts Enumerable and Callable
+  parameters [52](https://github.com/digital-fabric/extralite/issues/52)
+- Rename `Database#execute_multi` to `Database#batch_execute`
+- Implement Query#clone
+  [51](https://github.com/digital-fabric/extralite/issues/51)
+- Add support for GC compaction
+- Remove support for Ruby 2.7
+- Implement Query#<< [49](https://github.com/digital-fabric/extralite/issues/49)
+- Allow passing parameters in array
+- Add support for ractors
+  [#50](https://github.com/digital-fabric/extralite/issues/50)
+
+# 2.4 2023-12-24
+
+- Implement GVL release threshold.
+  [#46](https://github.com/digital-fabric/extralite/pull/46)
+- Implement write barriers for better GC performance.
+- Add support for binding large numbers and symbols.
+  [#43](https://github.com/digital-fabric/extralite/pull/43)
+- Implement Database#transaction.
+  [#42](https://github.com/digital-fabric/extralite/pull/42)
+- Add support for binding BLOBs.
+  [#40](https://github.com/digital-fabric/extralite/pull/40)
+- Minor fixes and cleanup of C-code.
+- Fix `Database#inspect` for a closed database instance
+  [#37](https://github.com/digital-fabric/extralite/issues/37)
+- Add support for binding named parameters from Struct and Data classes
+  [#30](https://github.com/digital-fabric/extralite/pull/30)
+- Update bundled SQLite code to version 3.44.2
+  [#32](https://github.com/digital-fabric/extralite/pull/32)
+
 # 2.3 2023-11-12
 
 - Update bundled SQLite to version 3.44.0 (#29)
@@ -16,7 +56,8 @@
 
 - Fix Sequel migrations (#8)
 - Redesign prepared statement functionality (#24)
-  - Rewrite `Extralite::PreparedStatement` into `Extralite::Query` with breaking API changes
+  - Rewrite `Extralite::PreparedStatement` into `Extralite::Query` with breaking
+    API changes
   - Add `Extralite::Iterator` class for external iteration
   - Add `Query#each_xxx`, `Query#to_a_xxx` method
   - Add `Query#eof?` method
@@ -65,7 +106,8 @@
 # 1.20 2023-01-21
 
 - Fix compilation error (#15 @sitano)
-- Add status methods `Extralite.runtime_status`, `Database#status`, `PreparedStatement#status` (#14 @sitano)
+- Add status methods `Extralite.runtime_status`, `Database#status`,
+  `PreparedStatement#status` (#14 @sitano)
 - Add `Database#interrupt` (#13 @sitano)
 - Add `Database#backup` (#11 @sitano)
 - Derive `Extralite::Error` from `StandardError` (#10 @sitano)
@@ -187,4 +229,3 @@
 ## 0.1 2021-05-21
 
 - First release
-

data/Gemfile-bundle

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec name: 'extralite'
+
+gem "extralite-bundle", git: "file://#{File.expand_path(__dir__)}", ref: `git rev-parse --abbrev-ref HEAD`.strip

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    extralite (2.3)
+    extralite (2.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
     docile (1.4.0)
-    json (2.6.3)
+    json (2.7.1)
     minitest (5.15.0)
     rake (13.1.0)
     rake-compiler (1.1.6)
@@ -34,4 +34,4 @@ DEPENDENCIES
   yard (= 0.9.27)
 
 BUNDLED WITH
-   2.3.3
+   2.4.22

data/README.md

@@ -14,14 +14,13 @@ with an SQLite3 database, as well as prepared queries (prepared statements).
 Extralite comes in two flavors: the `extralite` gem which uses the
 system-installed sqlite3 library, and the `extralite-bundle` gem which bundles
 the latest version of SQLite
-([3.44.0](https://sqlite.org/releaselog/3_44_0.html)), offering access to the
+([3.44.2](https://sqlite.org/releaselog/3_44_2.html)), offering access to the
 latest features and enhancements.
 
 ## Features
 
 - Super fast - [up to 11x faster](#performance) than the
-  [sqlite3](https://github.com/sparklemotion/sqlite3-ruby) gem (see also
-  [comparison](#why-not-just-use-the-sqlite3-gem).)
+  [sqlite3](https://github.com/sparklemotion/sqlite3-ruby) gem.
 - A variety of methods for different data access patterns: rows as hashes, rows
   as arrays, single row, single column, single value.
 - Prepared statements.
@@ -30,10 +29,12 @@ latest features and enhancements.
 - Use system-installed sqlite3, or the [bundled latest version of
   SQLite3](#installing-the-extralite-sqlite3-bundle).
 - Improved [concurrency](#concurrency) for multithreaded apps: the Ruby GVL is
-  released while preparing SQL statements and while iterating over results.
+  released peridically while preparing SQL statements and while iterating over
+  results.
 - Automatically execute SQL strings containing multiple semicolon-separated
   queries (handy for creating/modifying schemas).
-- Execute the same query with multiple parameter lists (useful for inserting records).
+- Execute the same query with multiple parameter lists (useful for inserting
+  records).
 - Load extensions (loading of extensions is autmatically enabled. You can find
   some useful extensions here: https://github.com/nalgeon/sqlean.)
 - Includes a [Sequel adapter](#usage-with-sequel).
@@ -48,6 +49,8 @@ gem 'extralite'
 
 You can also run `gem install extralite` if you just want to check it out.
 
+__Note__: Extralite supports Ruby 3.0 and higher.
+
 ### Installing the Extralite-SQLite3 Bundle
 
 If you don't have sqlite3 installed on your system, do not want to use the
@@ -101,15 +104,37 @@ db.query_single_value("select 'foo'") #=> "foo"
 
 # parameter binding (works for all query_xxx methods)
 db.query_hash('select ? as foo, ? as bar', 1, 2) #=> [{ :foo => 1, :bar => 2 }]
+db.query_hash('select ? as foo, ? as bar', [1, 2]) #=> [{ :foo => 1, :bar => 2 }]
+
+# explicit parameter indexes
+db.query_hash('select ?2 as foo, ?1 as bar, ?1 * ?2 as baz', 6, 7) #=> [{ :foo => 7, :bar => 6, :baz => 42 }
 
-# parameter binding of named parameters
+# named parameters
 db.query('select * from foo where bar = :bar', bar: 42)
 db.query('select * from foo where bar = :bar', 'bar' => 42)
 db.query('select * from foo where bar = :bar', ':bar' => 42)
 
+# parameter binding of named parameters from Struct and Data
+SomeStruct = Struct.new(:foo, :bar)
+db.query_single_column('select :bar', SomeStruct.new(41, 42)) #=> [42]
+SomeData = Data.define(:foo, :bar)
+db.query_single_column('select :bar', SomeData.new(foo: 41, bar: 42)) #=> [42]
+
+# parameter binding for binary data (BLOBs)
+db.execute('insert into foo values (?)', File.binread('/path/to/file'))
+db.execute('insert into foo values (?)', Extralite::Blob.new('Hello, 世界!'))
+db.execute('insert into foo values (?)', 'Hello, 世界!'.force_encoding(Encoding::ASCII_8BIT))
+
 # insert multiple rows
-db.execute_multi('insert into foo values (?)', ['bar', 'baz'])
-db.execute_multi('insert into foo values (?, ?)', [[1, 2], [3, 4]])
+db.batch_execute('insert into foo values (?)', ['bar', 'baz'])
+db.batch_execute('insert into foo values (?, ?)', [[1, 2], [3, 4]])
+
+# batch execute from enumerable
+db.batch_execute('insert into foo values (?)', 1..10)
+
+# batch execute from block
+source = [[1, 2], [2, 3], [3, 4]]
+db.batch_execute('insert into foo values (?, ?)') { source.shift }
 
 # prepared queries
 query = db.prepare('select ? as foo, ? as bar') #=> Extralite::Query
@@ -166,6 +191,13 @@ db.pragma(:journal_mode) #=> 'wal'
 # load an extension
 db.load_extension('/path/to/extension.so')
 
+# run queries in a transaction
+db.transaction do
+  db.execute('insert into foo values (?)', 1)
+  db.execute('insert into foo values (?)', 2)
+  db.execute('insert into foo values (?)', 3)
+end
+
 # close database
 db.close
 db.closed? #=> true
@@ -194,6 +226,23 @@ ensure
 end
 ```
 
+### Running transactions
+
+In order to run multiple queries in a single transaction, use
+`Database#transaction`, passing a block that runs the queries. You can specify
+the [transaction
+mode](https://www.sqlite.org/lang_transaction.html#deferred_immediate_and_exclusive_transactions).
+The default mode is `:immediate`:
+
+```ruby
+db.transaction { ... } # Run an immediate transaction
+db.transaction(:deferred) { ... } # Run a deferred transaction
+db.transaction(:exclusive) { ... } # Run an exclusive transaction
+```
+
+If an exception is raised in the given block, the transaction will be rolled
+back. Otherwise, it is committed.
+
 ### Creating Backups
 
 You can use `Database#backup` to create backup copies of a database. The
@@ -295,11 +344,55 @@ p articles.to_a
 
 ## Concurrency
 
-Extralite releases the GVL while making blocking calls to the sqlite3 library,
-that is while preparing SQL statements and fetching rows. Releasing the GVL
-allows other threads to run while the sqlite3 library is busy compiling SQL into
-bytecode, or fetching the next row. This *does not* hurt Extralite's
-performance, as you can see:
+### The Ruby GVL
+
+Extralite releases the [Ruby
+GVL](https://www.speedshop.co/2020/05/11/the-ruby-gvl-and-scaling.html) while
+making calls to the sqlite3 library that might block, such as when backing up a
+database, or when preparing a query. This allows other threads to run while the
+underlying sqlite3 library is busy preparing queries, fetching records and
+backing up databases.
+
+Extralite also releases the GVL periodically when iterating over records. By
+default, the GVL is released every 1000 records iterated. The GVL release
+threshold can be set separately for each database:
+
+```ruby
+db.gvl_release_threshold = 10 # release GVL every 10 records
+
+db.gvl_release_threshold = nil # use default value (currently 1000)
+```
+
+For most applications, there's no need to tune the GVL threshold value, as it
+provides [excellent](#performance) performance characteristics for both
+single-threaded and multi-threaded applications.
+
+In a heavily multi-threaded application, releasing the GVL more often (lower
+threshold value) will lead to less latency (for threads not running a query),
+but will also hurt the throughput (for the thread running the query). Releasing
+the GVL less often (higher threshold value) will lead to better throughput for
+queries, while increasing latency for threads not running a query. The following
+diagram demonstrates the relationship between the GVL release threshold value,
+latency and throughput:
+
+```
+less latency & throughput <<< GVL release threshold >>> more latency & throughput
+```
+
+### Thread Safety
+
+A single database instance can be safely used in multiple threads simultaneously
+as long as the following conditions are met:
+
+- No explicit transactions are used.
+- Each thread issues queries by calling `Database#query_xxx`, or uses a separate
+  `Query` instance.
+- The GVL release threshold is not `0` (i.e. the GVL is released periodically
+  while running queries.)
+
+### Use with Ractors
+
+Extralite databases can be used inside ractors 
 
 ## Performance
 

data/TODO.md

@@ -1,7 +1,5 @@
-- Improve tracing
 - Transactions and savepoints:
 
-  - `DB#transaction {}` - does a `BEGIN..COMMIT` - non-reentrant!
   - `DB#savepoint(name)` - creates a savepoint
   - `DB#release(name)` - releases a savepoint
   - `DB#rollback` - raises `Extralite::Rollback`, which is rescued by `DB#transaction`
@@ -10,7 +8,6 @@
 - More database methods:
 
   - `Database#quote`
-  - `Database#busy_timeout=` https://sqlite.org/c3ref/busy_timeout.html
   - `Database#cache_flush` https://sqlite.org/c3ref/db_cacheflush.html
   - `Database#release_memory` https://sqlite.org/c3ref/db_release_memory.html
 

data/bin/update_sqlite_source

@@ -9,10 +9,10 @@ require 'date'
 
 FileUtils.cd '/tmp'
 
-version_id = version.gsub('.', '')
+version_id = version.split('.').each_with_index.map { |v, i| i == 0 ? v : v.rjust(2, '0') }.join
 version_id += '0' * (7 - version_id.length)
 url = "https://sqlite.org/#{Date.today.year}/sqlite-amalgamation-#{version_id}.zip"
-dest = File.expand_path('../ext/extralite', __dir__)
+dest = File.expand_path('../ext/sqlite3', __dir__)
 
 puts "Downloading from #{url}..."
 `curl #{url} > #{version_id}.zip`
@@ -23,4 +23,11 @@ puts "Unzipping zip file..."
 puts "Copying source files"
 `cp sqlite-amalgamation-#{version_id}/sqlite3.* #{dest}/`
 
-puts 'Done updating source files'
+puts "Updating README"
+readme_path = File.expand_path('../README.md', __dir__)
+readme = File.read(readme_path)
+readme.gsub!(/\[\d+\.\d+\.\d+\]/, "[#{version}]")
+readme.gsub!(/\d+_\d+_\d+\.html/, "#{version.gsub('.', '_')}.html")
+File.write(readme_path, readme)
+
+puts 'Done updating source files'