extralite 2.5 → 2.6

data/README.md

@@ -1,247 +1,888 @@
-# Extralite - a Super Fast Ruby Gem for Working with SQLite3 Databases
-
-* Source code: https://github.com/digital-fabric/extralite
-* Documentation: http://www.rubydoc.info/gems/extralite
-
-[![Ruby gem](https://badge.fury.io/rb/extralite.svg)](https://rubygems.org/gems/extralite) [![Tests](https://github.com/digital-fabric/extralite/workflows/Tests/badge.svg)](https://github.com/digital-fabric/extralite/actions?query=workflow%3ATests) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/digital-fabric/extralite/blob/master/LICENSE)
+<h1 align="center">
+  <br>
+  Extralite
+</h1>
+
+<h4 align="center">SQLite for Ruby</h4>
+
+<p align="center">
+  <a href="http://rubygems.org/gems/extralite">
+    <img src="https://badge.fury.io/rb/extralite.svg" alt="Ruby gem">
+  </a>
+  <a href="https://github.com/digital-fabric/extralite/actions">
+    <img src="https://github.com/digital-fabric/extralite/actions/workflows/test.yml/badge.svg" alt="Tests">
+  </a>
+  <a href="https://github.com/digital-fabric/extralite/blob/master/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT License">
+  </a>
+</p>
+
+<p align="center">
+  <a href="https://www.rubydoc.info/gems/extralite">API reference</a>
+</p>
 
 ## What is Extralite?
 
-Extralite is a super fast, extra-lightweight (about 1300 lines of C-code)
-SQLite3 wrapper for Ruby. It provides a minimal set of methods for interacting
-with an SQLite3 database, as well as prepared queries (prepared statements).
+Extralite is a fast and innovative SQLite wrapper for Ruby with a rich set of
+features. It provides multiple ways of retrieving data from SQLite databases,
+makes it possible to use SQLite databases in multi-threaded and multi-fibered
+Ruby apps, and provides a comprehensive set of tools for managing SQLite
+databases.
 
 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.2](https://sqlite.org/releaselog/3_44_2.html)), offering access to the
+([3.45.0](https://sqlite.org/releaselog/3_45_0.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.
-- A variety of methods for different data access patterns: rows as hashes, rows
-  as arrays, single row, single column, single value.
-- Prepared statements.
+- Best-in-class performance (up to 14X the performance of the
+  [sqlite3](https://github.com/sparklemotion/sqlite3-ruby) gem).
+- Support for [concurrency](#concurrency) out of the box for multi-threaded
+  apps.
+- A variety of methods for retrieving data - hashes, array, single rows, single
+  values.
+- Support for external iteration, allowing iterating through single records or
+  batches of records.
+- Prepared queries.
 - Parameter binding.
-- External iteration - get single records or batches of records.
-- 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 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).
-- 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).
-
-## Installation
-
-To use Extralite in your Ruby app, add the following to your `Gemfile`:
+- Batch execution of queries.
+- Support for transactions and savepoints.
+- Support for loading [SQLite extensions](https://github.com/nalgeon/sqlean).
+- APIs for doing database backups.
+- Sequel adapter.
+
+## Table of Content
+
+- [Installing Extralite](#installing-extralite)
+- [Basic Usage](#basic-usage)
+- [Parameter binding](#parameter-binding)
+- [Data Types](#data-types)
+- [Prepared Queries](#prepared-queries)
+- [Batch Execution of Queries](#batch-execution-of-queries)
+- [Transactions and Savepoints](#transactions-and-savepoints)
+- [Database Information](#database-information)
+- [Error Handling](#error-handling)
+- [Concurrency](#concurrency)
+- [Advanced Usage](#advanced-usage)
+- [Usage with Sequel](#usage-with-sequel)
+- [Performance](#performance)
+- [License](#license)
+- [Contributing](#contributing)
+
+## Installing Extralite
+
+Using bundler:
 
 ```ruby
 gem 'extralite'
 ```
 
-You can also run `gem install extralite` if you just want to check it out.
+Or manually:
 
-__Note__: Extralite supports Ruby 3.0 and higher.
+```bash
+$ gem install extralite
+```
 
-### Installing the Extralite-SQLite3 Bundle
+__Note__: Extralite supports Ruby 3.0 and newer.
 
-If you don't have sqlite3 installed on your system, do not want to use the
-system-installed version of SQLite3, or would like to use the latest version of
-SQLite3, you can install the `extralite-bundle` gem, which integrates the
-SQLite3 source code.
+### Installing the Extralite-SQLite Bundle
 
-> **Important note**: The `extralite-bundle` gem will take a while to install
-> (on my modest machine it takes about a minute), due to the size of the sqlite3
-> code.
+If you don't have the sqlite3 lib installed on your system, do not want to use
+the system-installed version of SQLite, or would like to use the latest version
+of SQLite, you can install the `extralite-bundle` gem, which integrates the
+SQLite source code.
 
 Usage of the `extralite-bundle` gem is identical to the usage of the normal
 `extralite` gem, using `require 'extralite'` to load the gem.
 
-## Synopsis
+## Basic Usage
+
+Here's as an example showing how to open an SQLite database and run some
+queries:
+
+```ruby
+db = Extralite::Database.new('mydb.sqlite')
+db.execute('create table foo (x, y, z)')
+db.execute('insert into foo values (?, ?, ?)', 1, 2, 3)
+db.execute('insert into foo values (?, ?, ?)', 4, 5, 6)
+db.query('select * from foo') #=> [{x: 1, y: 2, z: 3}, {x: 4, y: 5, z: 6}]
+```
+
+The `#execute` method is used to make changes to the database, such as creating
+tables, or inserting records. It returns the number of records changed by the
+query.
+
+The `#query` method is used to read data from the database. It returns an array
+containing the resulting records, represented as hashes mapping column names (as
+symbols) to individual values.
+
+You can also iterate on records by providing a block to `#query`:
 
 ```ruby
-require 'extralite'
+db.query 'select * from foo' do |r|
+  p record: r
+end
+```
 
-# get sqlite3 version
-Extralite.sqlite3_version #=> "3.35.2"
+Extralite also provides other ways of retrieving data:
 
-# open a database
-db = Extralite::Database.new('/tmp/my.db')
+```ruby
+# get rows as arrays
+db.query_ary 'select * from foo'
+#=> [[1, 2, 3], [4, 5, 6]]
 
-# get query results as array of hashes
-db.query('select 1 as foo') #=> [{ :foo => 1 }]
-# or:
-db.query_hash('select 1 as foo') #=> [{ :foo => 1 }]
-# or iterate over results
-db.query('select 1 as foo') { |r| p r }
-# { :foo => 1 }
+# get a single column
+db.query_single_column 'select x from foo'
+#=> [1, 4]
 
-# get query results as array of arrays
-db.query_ary('select 1, 2, 3') #=> [[1, 2, 3]]
-# or iterate over results
-db.query_ary('select 1, 2, 3') { |r| p r }
-# [1, 2, 3]
+# get a single row
+db.query_single_row 'select * from foo order by x desc limit 1'
+#=> { x: 4, y: 5, z: 6 }
 
-# get a single row as a hash
-db.query_single_row("select 1 as foo") #=> { :foo => 1 }
+# get a single value (a single column from a single row)
+db.query_single_value 'select z from foo order by x desc limit 1'
+#=> 6
+```
 
-# get single column query results as array of values
-db.query_single_column('select 42') #=> [42]
-# or iterate over results
-db.query_single_column('select 42') { |v| p v }
-# 42
+## Parameter binding
 
-# get single value from first row of results
-db.query_single_value("select 'foo'") #=> "foo"
+As shown in the above example, the `#execute` and `#query_xxx` methods accept
+parameters that can be bound to the query, which means that their values will be
+used for each corresponding place-holder (expressed using `?`) in the SQL
+statement:
 
-# 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 }]
+```ruby
+db.query('select x from my_table where y = ? and z = ?', 'foo', 'bar')
+```
 
-# 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 }
+You can also express place holders by specifying their index (starting from 1) using `?IDX`:
 
-# 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)
+```ruby
+# use the same value for both place holders:
+db.query('select x from my_table where y = ?1 and z = ?1', 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]
+Another possibility is to use named parameters, which can be done by expressing place holders as `:KEY`, `@KEY` or `$KEY`:
 
-# 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))
+```ruby
+db.query('select x from my_table where y = $y and z = $z', y: 'foo', z: 'bar')
+```
 
-# insert multiple rows
-db.batch_execute('insert into foo values (?)', ['bar', 'baz'])
-db.batch_execute('insert into foo values (?, ?)', [[1, 2], [3, 4]])
+Extralite supports specifying named parameters using `Struct` or `Data` objects:
 
-# batch execute from enumerable
+```ruby
+MyStruct = Struct.new(:x, :z)
+params = MyStruct.new(42, 6)
+db.execute('update foo set x = $x where z = $z', params)
+
+MyData = Data.define(:x, :z)
+params = MyData.new(43, 3)
+db.execute('update foo set x = $x where z = $z', params)
+```
+
+Parameter binding is especially useful for preventing [SQL-injection
+attacks](https://en.wikipedia.org/wiki/SQL_injection), but is also useful when
+combined with [prepared queries](#prepared-queries) when repeatedly running the
+same query over and over.
+
+## Data Types
+
+Extralite supports the following data types for either bound parameters or row
+values:
+
+- `Integer`
+- `Float`
+- `Boolean` (see below)
+- `String` (see below)
+- nil
+
+### Boolean values
+
+SQLite does not have a boolean data type. Extralite will automatically translate
+bound parameter values of `true` or `false` to the integer values `1` and `0`,
+respectively. Note that boolean values stored in the database will be fetched as
+integers.
+
+### String values
+
+String parameter values are translated by Extralite to either `TEXT` or `BLOB`
+values according to the string encoding used. Strings with an `ASCII-8BIT` are
+treated as blobs. Otherwise they are treated as text values.
+
+Likewise, when fetching records, Extralite will convert a `BLOB` column value to
+a string with `ASCII-8BIT` encoding, and a `TEXT` column value to a string with
+`UTF-8` encoding.
+
+```ruby
+# The following calls will insert blob values into the database
+sql = 'insert into foo values (?)'
+db.execute(sql, File.binread('/path/to/file'))
+db.execute(sql, Extralite::Blob.new('Hello, 世界!'))
+db.execute(sql, 'Hello, 世界!'.force_encoding(Encoding::ASCII_8BIT))
+```
+
+## Prepared Queries
+
+Prepared queries (also known as prepared statements) allow you to maximize
+performance and reduce memory usage when running the same query repeatedly. They
+also allow you to create parameterized queries that can be repeatedly executed
+with different parameters:
+
+```ruby
+query = db.prepare('select * from foo where x = ?')
+
+# bind parameters and get results as an array of hashes
+query.bind(1).to_a
+#=> [{ x: 1, y: 2, z: 3 }]
+```
+
+### Binding Values to Prepared Queries
+
+To bind parameter values to the query, use the `#bind` method. The parameters will remain bound to the query until `#bind` is called again.
+
+```ruby
+query.bind(1)
+
+# run the query any number of times
+3.times { query.to_a }
+
+# bind other parameter values
+query.bind(4)
+```
+
+You can also bind parameters when creating the prepared query by passing
+additional parameters to the `Database#prepare` method:
+
+```ruby
+query = db.prepare('select * from foo where x = ?', 1)
+```
+
+### Fetching Records from a Prepared Query
+
+Just like the `Database` interface, prepared queries offer various ways of
+retrieving records: as hashes, as arrays, as single column values, as a single
+value:
+
+```ruby
+# get records as arrays
+query.to_a_ary
+#=> [[1, 2, 3]]
+
+# get records as single values
+query2 = db.prepare('select z from foo where x = ?', 1)
+query2.to_a_single_column
+#=> [3]
+
+# get a single value
+query2.next_single_column
+#=> 3
+```
+
+### Fetching Single Records or Batches of Records
+
+Prepared queries let you iterate over records one by one, or by batches. For
+this, use the `#next` method:
+
+```ruby
+query = db.prepare('select * from foo')
+
+query.next
+#=> { x: 1, y: 2, z: 3 }
+query.next
+#=> { x: 4, y: 5, z: 6 }
+
+# Fetch the next 10 records
+query.reset # go back tpo the beginning
+query.next(10)
+#=> [{ x: 1, y: 2, z: 3 }, { x: 4, y: 5, z: 6 }]
+
+# Fetch the next row as an array
+query.reset
+query.next_ary
+#=> [1, 2, 3]
+
+# Fetch the next row as a single column
+db.prepare('select z from foo').next_single_column
+#=> 3
+```
+
+To detect the end of the result, you can use `#eof?`. To go back to the
+beginning of the result set, use `#reset`. The following example shows how to
+read the query results in batches of 10:
+
+```ruby
+query.reset
+while !query.eof?
+  records = query.next(10)
+  process_records(records)
+end
+```
+
+### Iterating over Records in a Prepared Query
+
+In addition to the `#next` method, you can also iterate over query results by
+using the familiar `#each` method:
+
+```ruby
+# iterate over records as hashes
+query.each { |r| ... }
+
+# iterate over records as arrays
+query.each_ary { |r| ... }
+
+# iterate over records as single values
+query.each_single_column { |v| }
+```
+
+### Prepared Query as an Enumerable
+
+You can also use a prepared query as an enumerable, allowing you to chain
+enumerable method calls while iterating over the query result set. This is done
+by calling `#each` without a block:
+
+```ruby
+iterator = query.each
+#=> Returns an Extralite::Iterator instance
+
+iterator.map { |r| r[:x] *100 + r[:y] * 10 + r[:z] }
+#=> [123, 345]
+```
+
+The Iterator class includes the
+[`Enumerable`](https://rubyapi.org/3.3/o/enumerable) module, with all its
+methods, such as `#map`, `#select`, `#inject`, `#lazy` etc. You can also
+instantiate an iterator explicitly:
+
+```ruby
+# You need to pass the query to iterate over and the access mode (hash, ary, or
+# single_column):
+iterator = Extralite::Iterator(query, :hash)
+```
+
+## Batch Execution of Queries
+
+Extralite provides methods for batch execution of queries, with multiple sets of
+parameters. The `#batch_execute` method lets you insert or update a large number
+of records with a single call:
+
+```ruby
+values = [
+  [1, 11, 111],
+  [2, 22, 222],
+  [3, 33, 333]
+]
+# insert the above records in one fell swoop, and returns the total number of
+# changes:
+db.batch_execute('insert into foo values (?, ?, ?)', values)
+#=> 3
+```
+
+Parameters to the query can also be provided by any object that is an
+`Enumerable` or has an `#each` method, or any *callable* object that responds to
+`#call`:
+
+```ruby
+# Take parameter values from a Range
 db.batch_execute('insert into foo values (?)', 1..10)
+#=> 10
 
-# batch execute from block
-source = [[1, 2], [2, 3], [3, 4]]
-db.batch_execute('insert into foo values (?, ?)') { source.shift }
+# Insert (chomped) lines from a file
+File.open('foo.txt') do |f|
+  source = f.each_line.map(&:chomp)
+  db.batch_execute('insert into foo values (?)', source)
+end
 
-# prepared queries
-query = db.prepare('select ? as foo, ? as bar') #=> Extralite::Query
-query.bind(1, 2) #=> [{ :foo => 1, :bar => 2 }]
+# Insert items from a queue
+parameters = proc do
+  item = queue.shift
+  # when we're done, we return nil
+  (item == :done) ? nil : item
+end
+db.batch_execute('insert into foo values (?)', parameters)
+#=> number of rows inserted
+```
+
+Like its cousin `#execute`, the `#batch_execute` returns the total number of
+changes to the database (rows inserted, deleted or udpated).
 
-query.next #=> next row in result_set (as hash)
-query.next_hash #=> next row in result_set (as hash)
-query.next_ary #=> next row in result_set (as array)
-query.next_single_column #=> next row in result_set (as single value)
+### Batch Execution of Queries that Return Rows
 
-query.next(10) #=> next 10 rows in result_set (as hash)
-query.next_hash(10) #=> next 10 rows in result_set (as hash)
-query.next_ary(10) #=> next 10 rows in result_set (as array)
-query.next_single_column(10) #=> next 10 rows in result_set (as single value)
+Extralite also provides a `#batch_query` method that like `#batch_execute` takes
+a parameter source and returns an array containing the result sets for all query
+invocations. If a block is given, the result sets are passed to the block
+instead.
 
-query.to_a #=> all rows as array of hashes
-query.to_a_hash #=> all rows as array of hashes
-query.to_a_ary #=> all rows as array of arrays
-query.to_a_single_column #=> all rows as array of single values
+The `#batch_query` method is especially useful for batch queries with a
+`RETURNING` clause:
 
-query.each { |r| ... } #=> iterate over all rows as hashes
-query.each_hash { |r| ... } #=> iterate over all rows as hashes
-query.each_ary { |r| ... } #=> iterate over all rows as arrays
-query.each_single_column { |r| ... } #=> iterate over all rows as single columns
+```ruby
+updates = [
+  { id: 3, price: 42 },
+  { id: 5, price: 43 }
+]
+sql = 'update foo set price = $price where id = $id returning id, quantity'
+db.batch_query(sql, updates)
+#=> [[{ id: 3, quantity: 4 }], [{ id: 5, quantity: 5 }]]
+
+# The same with a block (returns the total number of changes)
+db.batch_query(sql, updates) do |rows|
+  p rows
+  #=> [{ id: 3, quantity: 4 }]
+  #=> [{ id: 5, quantity: 5 }]
+end
+#=> 2
+```
 
-iterator = query.each #=> create enumerable iterator
-iterator.next #=> next row
-iterator.each { |r| ... } #=> iterate over all rows
-values = iterator.map { |r| r[:foo] * 10 } #=> map all rows
+And of course, for your convenience there are also `#batch_query_ary` and
+`#batch_query_single_column` methods that retrieve records as arrays or as
+single values.
 
-iterator = query.each_ary #=> create enumerable iterator with rows as arrays
-iterator = query.each_single_column #=> create enumerable iterator with single values
+### Batch Execution of Prepared Queries
 
-# get last insert rowid
-rowid = db.last_insert_rowid
+Batch execution can also be done using prepared queries, using the same methods
+`#batch_execute` and `#batch_query`:
 
-# get number of rows changed in last query
-number_of_rows_affected = db.changes
+```ruby
+query = db.prepare 'update foo set x = ? where z = ? returning *'
 
-# get column names for the given sql
-db.columns('select a, b, c from foo') => [:a, :b, :c]
+query.batch_execute([[42, 3], [43, 6]])
+#=> 2
 
-# get db filename
-db.filename #=> "/tmp/my.db"
+query.batch_query([[42, 3], [43, 6]])
+#=> [{ x: 42, y: 2, z: 3 }, { x: 43, y: 5, z: 6 }]
+```
 
-# get list of tables
-db.tables #=> ['foo', 'bar']
+## Transactions and Savepoints
 
-# get and set pragmas
-db.pragma(:journal_mode) #=> 'delete'
-db.pragma(journal_mode: 'wal')
-db.pragma(:journal_mode) #=> 'wal'
+All reads and writes to SQLite databases occur within a
+[transaction](https://www.sqlite.org/lang_transaction.html). If no explicit
+transaction has started, the submitted SQL statements passed to `#execute` or
+`#query` will all run within an implicit transaction:
 
-# load an extension
-db.load_extension('/path/to/extension.so')
+```ruby
+# The following two SQL statements will run in a single implicit transaction:
+db.execute('insert into foo values (42); insert into bar values (43)')
 
-# run queries in a transaction
+# Otherwise, each call to #execute runs in a separate transaction:
+db.execute('insert into foo values (42)')
+db.execute('insert into bar values (43)')
+```
+
+### Explicit Transactions
+
+While you can issue `BEGIN` and `COMMIT` SQL statements yourself to start and
+commit explicit transactions, Extralite provides a convenient `#transaction`
+method that manages starting, commiting and rolling back of transactions
+automatically:
+
+```ruby
 db.transaction do
-  db.execute('insert into foo values (?)', 1)
-  db.execute('insert into foo values (?)', 2)
-  db.execute('insert into foo values (?)', 3)
+  db.execute('insert into foo values (42)')
+  raise 'Something bad happened' if something_bad_happened
+  db.execute('insert into bar values (43)')
 end
+```
 
-# close database
-db.close
-db.closed? #=> true
+If no exception is raised in the transaction block, the changes are commited. If
+an exception is raised, the changes are rolled back and the exception is
+propagated to the application code. You can prevent the exception from being
+propagated by calling `#rollback!`:
+
+```ruby
+db.transaction do
+  db.execute('insert into foo values (42)')
+  rollback! if something_bad_happened
+  db.execute('insert into bar values (43)')
+end
 ```
 
-## More Features
+### Transaction Modes
 
-### Interrupting Long-running Queries
+By default, `#transaction` starts an `IMMEDIATE` transaction. To start a
+`DEFERRED` or `EXCLUSIVE` transaction, pass the desired mode to `#transaction`:
 
-When running long-running queries, you can use `Database#interrupt` to interrupt
-the query:
+```ruby
+# Start a DEFERRED transaction
+db.transaction(:deferred) do
+  ...
+end
+
+# Start a EXCLUSIVE transaction
+db.transaction(:exclusive) do
+  ...
+end
+```
+
+Note that running an `IMMEDIATE` or `EXCLUSIVE` transaction blocks the database
+for writing (and also reading in certain cases) for the duration of the
+transaction. This can cause queries to the same database on a different
+connection to fail with a `BusyError` exception. This can be mitigated by
+setting a [busy timeout](#dealing-with-a-busy-database).
+
+### Savepoints
+
+In addition to transactions, SQLite also supports the use of
+[savepoints](https://www.sqlite.org/lang_savepoint.html), which can be used for
+more fine-grained control of changes within a transaction, and to be able to
+rollback specific changes without abandoning the entire transaction:
 
 ```ruby
-timeout_thread = Thread.new do
-  sleep 10
-  db.interrupt
+db.transaction do
+  db.execute 'insert into foo values (1)'
+  
+  db.savepoint :my_savepoint
+  db.execute 'insert into foo values (2)'
+  
+  # the following cancels the last insert
+  db.rollback_to :my_savepoint
+  db.execute 'insert into foo values (3)'
+
+  db.release :my_savepoint
 end
+```
 
-result = begin
-  db.query(super_slow_sql)
-rescue Extralite::InterruptError
-  nil
-ensure
+## Database Information
+
+### Getting the list of tables
+
+To get the list of tables in a database, use the `#tables` method:
+
+```ruby
+db.tables
+#=> [...]
+```
+
+To get the list of tables in an attached database, you can pass the database name to `#tables`:
+
+```ruby
+db.execute "attach database 'foo.db' as foo"
+db.tables('foo')
+#=> [...]
+```
+
+### Getting the last insert row id
+
+```ruby
+db.execute 'insert into foo values (?)', 42
+db.last_insert_rowid
+#=> 1
+```
+
+### Getting the columns names for a given query
+
+```ruby
+db.columns('select a, b, c from foo')
+#=> [:a, :b, :c]
+
+# Columns a prepared query:
+query = db.prepare('select x, y from foo')
+query.columns
+#=> [:x, :y]
+```
+
+### Pragmas
+
+You can get or set pragma values using `#pragma`:
+
+```ruby
+# get a pragma value:
+db.pragma(:journal_mode)
+#=> 'delete'
+
+# set a pragma value:
+db.pragma(journal_mode: 'wal')
+db.pragma(:journal_mode)
+#=> 'wal'
+```
+
+## Error Handling
+
+Extralite defines various exception classes that are raised when an error is
+encountered while interacting with the underlying SQLite library:
+
+- `Extralite::SQLError` - raised when SQLite encounters an invalid SQL query.
+- `Extralite::BusyError` - raised when the underlying database is locked for use
+  by another database connection.
+- `Extralite::InterruptError` - raised when a query has been interrupted.
+- `Extralite::ParameterError` - raised when an invalid parameter value has been
+  specified.
+- `Extralite::Error` - raised on all other errors.
+
+In addition to the above exceptions, further information about the last error
+that occurred is provided by the following methods:
+
+- `#errcode` - the [error code](https://www.sqlite.org/rescode.html) returned by
+  the underlying SQLite library.
+- `#errmsg` - the error message for the last error. For most errors, the error
+  message is copied into the exception message.
+- `#error_offset` - for SQL errors, the offset into the SQL string where the
+  error was encountered.
+
+## Concurrency
+
+Extralite provides a comprehensive set of tools for dealing with concurrency
+issues, and for making sure that running queries on SQLite databases does not
+cause the app to freeze.
+
+### The Ruby GVL
+
+In order to support multi-threading, Extralite releases the [Ruby
+GVL](https://www.speedshop.co/2020/05/11/the-ruby-gvl-and-scaling.html)
+periodically while running queries. This allows other threads to run while the
+underlying SQLite library is busy preparing queries, fetching records and
+backing up databases. By default, the GVL is when preparing the query, and once
+for every 1000 iterated records. The GVL release threshold can be set separately
+for each database:
+
+```ruby
+# release the GVL on preparing the query, and every 10 records
+db.gvl_release_threshold = 10 
+
+# release the GVL only when preparing the query
+db.gvl_release_threshold = 0 
+
+# never release the GVL (for single-threaded apps only)
+db.gvl_release_threshold = -1
+
+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
+```
+
+### Dealing with a Busy Database
+
+When multiple threads or processes access the same database, the database may be
+locked for writing by one process, which will block other processes wishing to
+write to the database. When attempting to write to a locked database, a
+`Extralite::BusyError` will be raised:
+
+```ruby
+ready = nil
+locker = Thread.new do
+  db1 = Extralite::Database.new('my.db')
+  # Lock the database for 3 seconds
+  db1.transaction do
+    ready = true
+    sleep(3)
+  end
+end
+
+db2 = Extralite::Database.new('my.db')
+# wait for writer1 to enter a transaction
+sleep(0) while !ready
+# This will raise a Extralite::BusyError
+db2.transaction { }
+# Extralite::BusyError!
+```
+
+You can mitigate this by setting a busy timeout. This will cause SQLite to wait
+for the database to become unlocked up to the specified timeout period:
+
+```ruby
+# Wait for up to 5 seconds before giving up
+db2.busy_timeout = 5
+# Now it'll work!
+db2.transaction { }
+```
+
+For most use cases, setting the busy timeout solves the problem of failing to
+run queries because of a busy database, as normally transactions are
+short-lived.
+
+However, in some cases, such as when running a multi-fibered app or when
+implementing your own timeout mechanisms, you'll want to set a [progress
+handler](#the-progress-handler).
+
+### Interrupting a Query
+
+To interrupt an ongoing query, use the `#interrupt` method. Normally this is done from a separate thread. Here's a way to implement a timeout using  `#interrupt`:
+
+```ruby
+def run_query_with_timeout(sql, timeout)
+  timeout_thread = Thread.new do
+    t0 = Time.now
+    sleep(timeout)
+    @db.interrupt
+  end
+  result = @db.query(sql)
   timeout_thread.kill
-  timeout_thread.join
+  result
+end
+
+run_query_with_timeout('select 1 as foo', 5)
+#=> [{ foo: 1 }]
+
+# A timeout will cause a Extralite::InterruptError to be raised
+run_query_with_timeout(slow_sql, 5)
+#=> Extralite::InterruptError!
+```
+
+You can also call `#interrupt` from within the [progress
+handler](#the-progress-handler).
+
+### The Progress Handler
+
+Extralite also supports setting up a progress handler, which is a piece of code
+that will be called while a query is in progress, or while the database is busy.
+This is useful especially when you want to implement a general purpose timeout
+mechanism that deals with both a busy database and with slow queries.
+
+The progress handler can also be used for performing any kind of operation while
+a query is in progress. Here are some use cases:
+
+- Interrupting queries that take too long to run.
+- Interrupting queries on an exceptional condition, such as a received signal.
+- Updating the UI while a query is running.
+- Switching between fibers in multi-fibered apps.
+- Switching between threads in multi-threaded apps.
+- Instrumenting the performance of queries.
+
+Setting the progress handler requires that Extralite hold the GVL while running
+all queries. Therefore, it should be used with care. In a multi-threaded app,
+you'll need to call `Thread.pass` from the progress handler in order for other
+threads to be able to run while the query is in progress. The progress handler
+is set per-database using `#on_progress`. This method takes a single parameter
+that specifies the approximate number of SQLite VM instructions between
+successive calls to the progress handler:
+
+```ruby
+# Run progress handler every 100 SQLite VM instructions
+db.on_progress(100) do
+  check_for_timeout
+  # Allow other threads to run
+  Thread.pass
+end
+```
+
+The progress handler can be used to interrupt queries in progress. This can be
+done by either calling `#interrupt`, or by raising an exception. As discussed
+above, calling `#interrupt` causes the query to raise a
+`Extralite::InterruptError` exception:
+
+```ruby
+db.on_progress(100) { db.interrupt }
+db.query('select 1')
+#=> Extralite::InterruptError!
+```
+
+You can also interrupt queries in progress by raising an exception. The query
+will be stopped, and the exception will propagate to the call site:
+
+```ruby
+db.on_progress(100) do
+  raise 'BOOM!'
+end
+
+db.query('select 1')
+#=> BOOM!
+```
+
+Here's how a timeout might be implemented using the progress handler:
+
+```ruby
+def setup_progress_handler
+  @db.on_progress(100) do
+    raise TimeoutError if Time.now - @t0 >= @timeout
+    Thread.pass
+  end
+end
+
+# In this example, we just return nil on timeout
+def run_query_with_timeout(sql, timeout)
+  @t0 = Time.now
+  @db.query(sql)
+rescue TimeoutError
+  nil
 end
+
+run_query_with_timeout('select 1 as foo', 5)
+#=> [{ foo: 1 }]
+
+run_query_with_timeout(slow_sql, 5)
+#=> nil
 ```
 
-### Running transactions
+### Extralite and Fibers
+
+The progress handler can also be used to switch between fibers in a
+multi-fibered Ruby app, based on libraries such as
+[Async](https://github.com/socketry/async) or
+[Polyphony](https://github.com/digital-fabric/polyphony). A general solution
+(that also works for multi-threaded apps) is to call `sleep(0)` in the progress
+handler. This will work for switching between fibers using either Polyphony or
+any fiber scheduler gem, such as Async et al:
+
+```ruby
+db.on_progress(100) { sleep(0) }
+```
+
+For Polyphony-based apps, you can also call `snooze` to allow other fibers to
+run while a query is progressing. If your Polyphony app is multi-threaded,
+you'll also need to call `Thread.pass` in order to allow other threads to run:
+
+```ruby
+db.on_progress(100) do
+  snooze
+  Thread.pass
+end
+```
+
+Note that with Polyphony, once you install the progress handler, you can just
+use the regular `#move_on_after` and `#cancel_after` methods to implement
+timeouts for queries:
+
+```ruby
+db.on_progress(100) { snooze }
+
+cancel_after(3) do
+  db.query(long_running_query)
+end
+```
+
+### 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 safely be used inside ractors. Note that ractors are still an experimental feature of Ruby. A ractor has the benefit of using a separate GVL from the maine one, which allows true parallelism for Ruby apps. So when you use Extralite to access SQLite databases from within a ractor, you can do so without any considerations for what's happening outside the ractor when it runs queries.
 
-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`:
+## Advanced Usage
+
+### Loading Extensions
+
+Extensions can be loaded by calling `#load_extension`:
 
 ```ruby
-db.transaction { ... } # Run an immediate transaction
-db.transaction(:deferred) { ... } # Run a deferred transaction
-db.transaction(:exclusive) { ... } # Run an exclusive transaction
+db.load_extension('/path/to/extension.so')
 ```
 
-If an exception is raised in the given block, the transaction will be rolled
-back. Otherwise, it is committed.
+A pretty comprehensive set of extensions can be found here:
+
+https://github.com/nalgeon/sqlean
 
 ### Creating Backups
 
@@ -266,6 +907,51 @@ db.backup('backup.db') do |remaining, total|
 end
 ```
 
+### Working with Changesets
+
+__Note__: as the session extension is by default disabled in SQLite
+distributions, support for changesets is currently only available withthe
+bundled version of Extralite, `extralite-bundle`.
+
+Changesets can be used to track and persist changes to data in a database. They
+can also be used to apply the same changes to another database, or to undo them.
+To track changes to a database, use the `#track_changes` method:
+
+```ruby
+# track changes to the foo and bar tables:
+changeset = db.track_changes(:foo, :bar) do
+  insert_a_bunch_of_records(db)
+end
+
+# to track changes to all tables, pass nil:
+changeset = db.track_changes(nil) do
+  insert_a_bunch_of_records(db)
+end
+```
+
+You can then apply the same changes to another database:
+
+```ruby
+changeset.apply(some_other_db)
+```
+
+To undo the changes, obtain an inverted changeset and apply it to the database:
+
+```ruby
+changeset.invert.apply(db)
+```
+
+You can also save and load the changeset:
+
+```ruby
+# save the changeset
+IO.write('my.changes', changeset.to_blob)
+
+# load the changeset
+changeset = Extralite::Changeset.new
+changeset.load(IO.read('my.changes'))
+```
+
 ### Retrieving Status Information
 
 Extralite provides methods for retrieving status information about the sqlite
@@ -305,16 +991,6 @@ value = db.limit(Extralite::SQLITE_LIMIT_ATTACHED)
 db.limit(Extralite::SQLITE_LIMIT_ATTACHED, new_value)
 ```
 
-### Setting the Busy Timeout
-
-When accessing a database concurrently it can be handy to set a busy timeout, in
-order to not have to deal with rescuing `Extralite::BusyError` exceptions. The
-timeout is given in seconds:
-
-```ruby
-db.busy_timeout = 5
-```
-
 ### Tracing SQL Statements
 
 To trace all SQL statements executed on the database, pass a block to
@@ -342,58 +1018,6 @@ p articles.to_a
 
 (Make sure you include `extralite` as a dependency in your `Gemfile`.)
 
-## Concurrency
-
-### 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
 
 A benchmark script is included, creating a table of various row counts, then
@@ -405,35 +1029,36 @@ large number of rows.
 
  [Benchmark source code](https://github.com/digital-fabric/extralite/blob/main/test/perf_hash.rb)
 
-|Row count|sqlite3 1.6.0|Extralite 1.21|Advantage|
+|Row count|sqlite3 1.7.0|Extralite 2.5|Advantage|
 |-:|-:|-:|-:|
-|10|63.7K rows/s|94.0K rows/s|__1.48x__|
-|1K|299.2K rows/s|1.983M rows/s|__6.63x__|
-|100K|185.4K rows/s|2.033M rows/s|__10.97x__|
+|10|184.9K rows/s|473.2K rows/s|__2.56x__|
+|1K|290.5K rows/s|2320.7K rows/s|__7.98x__|
+|100K|143.0K rows/s|2061.3K rows/s|__14.41x__|
 
 ### Rows as Arrays
 
 [Benchmark source code](https://github.com/digital-fabric/extralite/blob/main/test/perf_ary.rb)
 
-|Row count|sqlite3 1.6.0|Extralite 1.21|Advantage|
+|Row count|sqlite3 1.7.0|Extralite 2.5|Advantage|
 |-:|-:|-:|-:|
-|10|71.2K rows/s|92.1K rows/s|__1.29x__|
-|1K|502.1K rows/s|2.065M rows/s|__4.11x__|
-|100K|455.7K rows/s|2.511M rows/s|__5.51x__|
+|10|276.9K rows/s|472.3K rows/s|__1.71x__|
+|1K|615.6K rows/s|2324.3K rows/s|__3.78x__|
+|100K|477.4K rows/s|1982.7K rows/s|__4.15x__|
 
 ### Prepared Queries (Prepared Statements)
 
-[Benchmark source code](https://github.com/digital-fabric/extralite/blob/main/test/perf_prepared.rb)
+[Benchmark source code](https://github.com/digital-fabric/extralite/blob/main/test/perf_hash_prepared.rb)
 
-|Row count|sqlite3 1.6.0|Extralite 1.21|Advantage|
+|Row count|sqlite3 1.7.0|Extralite 2.5|Advantage|
 |-:|-:|-:|-:|
-|10|232.2K rows/s|741.6K rows/s|__3.19x__|
-|1K|299.8K rows/s|2386.0M rows/s|__7.96x__|
-|100K|183.1K rows/s|1.893M rows/s|__10.34x__|
+|10|228.5K rows/s|707.9K rows/s|__3.10x__|
+|1K|296.5K rows/s|2396.2K rows/s|__8.08x__|
+|100K|145.9K rows/s|2107.3K rows/s|__14.45x__|
+
+As those benchmarks show, Extralite is capabale of reading up to 2.4M rows per
+second, and can be more than 14 times faster than the `sqlite3` gem.
 
-As those benchmarks show, Extralite is capabale of reading up to 2.5M
-rows/second when fetching rows as arrays, and up to 2M rows/second when fetching
-rows as hashes.
+Note that the benchmarks above were performed on synthetic data, in a single-threaded environment, with the GVL release threshold set to -1, which means that both Extralite and the `sqlite3` gem hold the GVL for the duration of the query.
 
 ## License