sqlite3 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 479e7054b162696f5eb93924c679100d344ad55a99c89b78388e4704607671b9
-  data.tar.gz: '0284ba95e06b2b6e5ecb3da9254e0821deb9bde428971376f13de1a7402aade8'
+  metadata.gz: a17035c1e1072a5231c5b05ea95a9bbe5e55090b92e51eae0098dcffed86dca2
+  data.tar.gz: f5bb0c4c6cc6baacef41d168ea6b00f5b20620bc348715722400f3cc9bf6e1ed
 SHA512:
-  metadata.gz: a166ac9e72cdb74d1b632610ad11e60ed6fc80bd35bdcabd324e311d47143e1fe2a31011e19a7105ffeb688439e024b55e896e499ce34c9bedd1053b36e1274b
-  data.tar.gz: aa22f0c6720ae18619f206330fd47aab916bb4916b147686813c8f8fc7240ed0da9da33360f77e6b85ae9a4465c96fa4b29bdc67138be26130f9ab74ecf155a7
+  metadata.gz: 77bd1ee33f9d84393f5b9e3cc5ce225a39b67de4017526ccb90d6bccb017f95c529ace626121373e382ee20164117ab1959cefc456c004ecfc1b82784f731011
+  data.tar.gz: 628d16452c3e2f1181da73f7d8af8e8247b2a84159b810ef5c9c3ea5d0eddc21c06fa3bb6c6d4d4d6a3beb0a7f6c8e3378cde9e7ea20ae6cff5342b46a2d0ef1

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # sqlite3-ruby Changelog
 
+## 2.3.0 / 2024-11-20
+
+### Added
+
+- The SQLITE_DBPAGE extension is now enabled by default, which implements an eponymous-only virtual table that provides direct access to the underlying database file by interacting with the pager. See https://www.sqlite.org/dbpage.html for more information. [#578] @flavorjones
+- The DBSTAT extension is now enabled by default, which implements a read-only eponymous virtual table that returns information about the amount of disk space used to store the content of an SQLite database. See https://sqlite.org/dbstat.html for more information. [#580] @pawurb @flavorjones
+- `Database#optimize` which wraps the `pragma optimize;` statement. Also added `Constants::Optimize` to allow advanced users to pass a bitmask of options. See https://www.sqlite.org/pragma.html#pragma_optimize. [#572] @alexcwatt @flavorjones
+- `SQLite3::VERSION_INFO` is contains a bag of metadata about the gem and the sqlite library used. `SQLite3::SQLITE_PACKAGED_LIBRARIES` and `SQLite3::SQLITE_PRECOMPILED_LIBRARIES` are indicate how the gem was built. [#581] @flavorjones
+
+
+### Fixed
+
+- `Database#encoding=` support for switching the database encoding to `UTF-16BE`, which has been broken since `Database#encoding=` was introduced in v1.3.12 in 2016. [#575] @miyucy
+- Omit mention of the `pkg-config` gem when failing to build from source, since it is not used. [#358] @flavorjones
+
+
 ## 2.2.0 / 2024-10-30
 
 ### Added

data/ext/sqlite3/extconf.rb

@@ -62,7 +62,9 @@ module Sqlite3
               "-O2", # see https://github.com/sparklemotion/sqlite3-ruby/issues/335 for some benchmarks
               "-fvisibility=hidden", # see https://github.com/rake-compiler/rake-compiler-dock/issues/87
               "-DSQLITE_DEFAULT_WAL_SYNCHRONOUS=1",
-              "-DSQLITE_USE_URI=1"
+              "-DSQLITE_USE_URI=1",
+              "-DSQLITE_ENABLE_DBPAGE_VTAB=1",
+              "-DSQLITE_ENABLE_DBSTAT_VTAB=1"
             ]
             env["CFLAGS"] = [user_cflags, env["CFLAGS"], more_cflags].flatten.join(" ")
             recipe.configure_options += env.select { |k, v| ENV_ALLOWLIST.include?(k) }
@@ -95,6 +97,9 @@ module Sqlite3
           end
 
           ldflags.each { |ldflag| append_ldflags(ldflag) }
+
+          append_cppflags("-DUSING_PACKAGED_LIBRARIES")
+          append_cppflags("-DUSING_PRECOMPILED_LIBRARIES") if cross_build?
         end
       end
 
@@ -171,7 +176,7 @@ module Sqlite3
       end
 
       def abort_pkg_config(id)
-        abort("\nCould not configure the build properly (#{id}). Please install either the `pkg-config` utility or the `pkg-config` rubygem.\n\n")
+        abort("\nCould not configure the build properly (#{id}). Please install the `pkg-config` utility.\n\n")
       end
 
       def cross_build?

data/ext/sqlite3/sqlite3.c

@@ -201,8 +201,25 @@ Init_sqlite3_native(void)
     rb_define_singleton_method(mSqlite3, "libversion", libversion, 0);
     rb_define_singleton_method(mSqlite3, "threadsafe", threadsafe_p, 0);
     rb_define_singleton_method(mSqlite3, "status", rb_sqlite3_status, -1);
+
+    /* (String) The version of the sqlite3 library compiled with (e.g., "3.46.1") */
     rb_define_const(mSqlite3, "SQLITE_VERSION", rb_str_new2(SQLITE_VERSION));
+
+    /* (Integer) The version of the sqlite3 library compiled with (e.g., 346001) */
     rb_define_const(mSqlite3, "SQLITE_VERSION_NUMBER", INT2FIX(SQLITE_VERSION_NUMBER));
+
+    /* (String) The version of the sqlite3 library loaded at runtime (e.g., "3.46.1") */
     rb_define_const(mSqlite3, "SQLITE_LOADED_VERSION", rb_str_new2(sqlite3_libversion()));
 
+#ifdef USING_PACKAGED_LIBRARIES
+    rb_define_const(mSqlite3, "SQLITE_PACKAGED_LIBRARIES", Qtrue);
+#else
+    rb_define_const(mSqlite3, "SQLITE_PACKAGED_LIBRARIES", Qfalse);
+#endif
+
+#ifdef USING_PRECOMPILED_LIBRARIES
+    rb_define_const(mSqlite3, "SQLITE_PRECOMPILED_LIBRARIES", Qtrue);
+#else
+    rb_define_const(mSqlite3, "SQLITE_PRECOMPILED_LIBRARIES", Qfalse);
+#endif
 }

data/lib/sqlite3/constants.rb

@@ -170,5 +170,29 @@ module SQLite3
       # This parameter records the number of separate memory allocations currently checked out.
       MALLOC_COUNT = 9
     end
+
+    module Optimize
+      # Debugging mode. Do not actually perform any optimizations but instead return one line of
+      # text for each optimization that would have been done. Off by default.
+      DEBUG = 0x00001
+
+      # Run ANALYZE on tables that might benefit. On by default.
+      ANALYZE_TABLES = 0x00002
+
+      # When running ANALYZE, set a temporary PRAGMA analysis_limit to prevent excess run-time. On
+      # by default.
+      LIMIT_ANALYZE = 0x00010
+
+      # Check the size of all tables, not just tables that have not been recently used, to see if
+      # any have grown and shrunk significantly and hence might benefit from being re-analyzed. Off
+      # by default.
+      CHECK_ALL_TABLES = 0x10000
+
+      # Useful for adding a bit to the default behavior, for example
+      #
+      #     db.optimize(Optimize::DEFAULT | Optimize::CHECK_ALL_TABLES)
+      #
+      DEFAULT = ANALYZE_TABLES | LIMIT_ANALYZE
+    end
   end
 end

data/lib/sqlite3/fork_safety.rb

@@ -2,10 +2,10 @@
 
 require "weakref"
 
-# based on Rails's active_support/fork_tracker.rb
 module SQLite3
+  # based on Rails's active_support/fork_tracker.rb
   module ForkSafety
-    module CoreExt
+    module CoreExt # :nodoc:
       def _fork
         pid = super
         if pid == 0
@@ -20,17 +20,17 @@ module SQLite3
     @suppress = false
 
     class << self
-      def hook!
+      def hook! # :nodoc:
         ::Process.singleton_class.prepend(CoreExt)
       end
 
-      def track(database)
+      def track(database) # :nodoc:
         @mutex.synchronize do
           @databases << WeakRef.new(database)
         end
       end
 
-      def discard
+      def discard # :nodoc:
         warned = @suppress
         @databases.each do |db|
           next unless db.weakref_alive?

data/lib/sqlite3/pragmas.rb

@@ -93,7 +93,7 @@ module SQLite3
     LOCKING_MODES = [["normal"], ["exclusive"]]
 
     # The list of valid encodings.
-    ENCODINGS = [["utf-8"], ["utf-16"], ["utf-16le"], ["utf-16be "]]
+    ENCODINGS = [["utf-8"], ["utf-16"], ["utf-16le"], ["utf-16be"]]
 
     # The list of valid WAL checkpoints.
     WAL_CHECKPOINTS = [["passive"], ["full"], ["restart"], ["truncate"]]
@@ -338,6 +338,20 @@ module SQLite3
       set_int_pragma "mmap_size", size
     end
 
+    # Attempt to optimize the database.
+    #
+    # To customize the optimization options, pass +bitmask+ with a combination
+    # of the Constants::Optimize masks.
+    #
+    # See https://www.sqlite.org/pragma.html#pragma_optimize for more information.
+    def optimize(bitmask = nil)
+      if bitmask
+        set_int_pragma "optimize", bitmask
+      else
+        execute("PRAGMA optimize")
+      end
+    end
+
     def page_count
       get_int_pragma "page_count"
     end

data/lib/sqlite3/version.rb

@@ -1,3 +1,4 @@
 module SQLite3
-  VERSION = "2.2.0"
+  # (String) the version of the sqlite3 gem, e.g. "2.1.1"
+  VERSION = "2.3.0"
 end

data/lib/sqlite3/version_info.rb

@@ -0,0 +1,17 @@
+module SQLite3
+  # a hash of descriptive metadata about the current version of the sqlite3 gem
+  VERSION_INFO = {
+    ruby: RUBY_DESCRIPTION,
+    gem: {
+      version: SQLite3::VERSION
+    },
+    sqlite: {
+      compiled: SQLite3::SQLITE_VERSION,
+      loaded: SQLite3::SQLITE_LOADED_VERSION,
+      packaged: SQLite3::SQLITE_PACKAGED_LIBRARIES,
+      precompiled: SQLite3::SQLITE_PRECOMPILED_LIBRARIES,
+      sqlcipher: SQLite3.sqlcipher?,
+      threadsafe: SQLite3.threadsafe?
+    }
+  }
+end

data/lib/sqlite3.rb

@@ -15,3 +15,5 @@ module SQLite3
     threadsafe > 0
   end
 end
+
+require "sqlite3/version_info"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sqlite3
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Jamis Buck
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-30 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_portile2
@@ -76,6 +76,7 @@ files:
 - lib/sqlite3/statement.rb
 - lib/sqlite3/value.rb
 - lib/sqlite3/version.rb
+- lib/sqlite3/version_info.rb
 - ports/archives/sqlite-autoconf-3470000.tar.gz
 homepage: https://github.com/sparklemotion/sqlite3-ruby
 licenses:
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Ruby library to interface with the SQLite3 database engine (http://www.sqlite.org).