sequel 5.77.0 → 5.81.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9951772dd3785c8ce91090bd31034a1e57ac5dcbc17af774b980a115cea15347
-  data.tar.gz: 3cfcaefaf6aa4758ef2cfaf78cbe6ccdc688e8b3836718bd63c42c5bdb220026
+  metadata.gz: a23afa1510b7bd1ba6918319eedce156450672520ab4798e6de56461a59660e1
+  data.tar.gz: bb6bbfbf0f1f82fe117fa8c725e9cf4fde49644a74b463ab8682018744a8a1de
 SHA512:
-  metadata.gz: '0885577c11fd7285a5278d0a1b52ae411e557cec7bce2f3a49f8128a0be63928ebfa55b2b1a86c8b28ee1c3782c1dc5ebf5d4ecf00f0194ad33da89cb6ffc12a'
-  data.tar.gz: ccc7b8b6c68049ee1fed2211a3d193157ee36fde9c340324eba2a8cebd8925bc97b4dc1777b61f8a2fb94d83439c41f33afb832c080f4d54bab16d09924a4fe2
+  metadata.gz: 9e26620f8f1df2715205e9019c2012ec2e9f392d14ed427d66c76f488bccc3e5d3f27e4d626a47d54903d611695db0487f987d99191602024a1864d6c10f7bde
+  data.tar.gz: cd070d8c35960949039d226b5eaf8c90ebec8d0cef3f09b5dae533551bb35170ca6e2503d88f1b1512110b6617ff9c03d9cb2afb62395c4d953314aa5a5ca87c

data/CHANGELOG

@@ -1,3 +1,37 @@
+=== 5.81.0 (2024-06-01)
+
+* Fix ignored block warnings in a couple plugin apply methods on Ruby 3.4 (jeremyevans)
+
+* Skip Ruby internal caller locations when searching for caller locations in caller_logging and provenance extensions (jeremyevans) 
+
+* Add temporarily_release_connection Database extension for multithreaded transactional testing (jeremyevans)
+
+=== 5.80.0 (2024-05-01)
+
+* Support Dataset#skip_locked on MariaDB 10.6+ (simi) (#2150)
+
+* Avoid allocating datasets in cases where the returned dataset would be the same as the receiver (jeremyevans)
+
+* Add provenance dataset extension, which includes comments in queries showing how and where the dataset was built (jeremyevans)
+
+=== 5.79.0 (2024-04-01)
+
+* Support create_or_replace_view with :materialized option on PostgreSQL (nashby) (#2144)
+
+* Support :unlogged_tables_default Database option on Postgres for making created tables unlogged by default (jeremyevans) (#2134)
+
+* Add Dataset#select_prepend for prepending to the current selected columns (jeremyevans) (#2139)
+
+=== 5.78.0 (2024-03-01)
+
+* Support SQLite 3.45+ jsonb functions in the sqlite_json_ops extension (jeremyevans) (#2133)
+
+* Support compounds (e.g. UNION) in conjunction with Database#values on PostgreSQL (jeremyevans) (#2137)
+
+* Support :use_advisory_lock option to Migrator.run to use advisory locks when running migrations (jeremyevans) (#2089)
+
+* Support Database#with_advisory_lock on PostgreSQL, MySQL, and Microsoft SQL Server (jeremyevans) (#2089)
+
 === 5.77.0 (2024-02-01)
 
 * Support create_table :without_rowid option on SQLite (loranger32) (#2126)
@@ -16,7 +50,7 @@
 
 * Support on_duplicate_columns={raise,warn} parameter in connection URL when using duplicate_columns_handler extension (jeremyevans)
 
-* Add transaction_connection_validator extension for retrying transactions on new connection if ther is a disconnect error when starting transaction (jeremyevans)
+* Add transaction_connection_validator extension for retrying transactions on new connection if there is a disconnect error when starting transaction (jeremyevans)
 
 === 5.76.0 (2024-01-01)
 

data/README.rdoc

@@ -22,10 +22,10 @@ RDoc Documentation :: https://sequel.jeremyevans.net/rdoc
 Source Code :: https://github.com/jeremyevans/sequel
 Bug tracking (GitHub Issues) :: https://github.com/jeremyevans/sequel/issues
 Discussion Forum (GitHub Discussions) :: https://github.com/jeremyevans/sequel/discussions
-Alternate Discussion Forum (sequel-talk Google Group) :: http://groups.google.com/group/sequel-talk
+Archived Discussion Forum (sequel-talk Google Group) :: https://www.mail-archive.com/sequel-talk@googlegroups.com/
 
 If you have questions about how to use Sequel, please ask on
-GitHub Discussions or the sequel-talk Google Group.
+GitHub Discussions.
 Only use the the bug tracker to report
 bugs in Sequel, not to ask for help on using Sequel.
 
@@ -368,10 +368,12 @@ Like +order+, +select+ overrides an existing selection:
   posts.select(:stamp).select(:name)
   # SELECT name FROM posts
 
-As you might expect, there is an +order_append+ equivalent for +select+ called +select_append+:
+As you might expect, there are +order_append+ and +order_prepend+ equivalents for +select+ called +select_append+ and +select_prepend+:
 
   posts.select(:stamp).select_append(:name)
   # SELECT stamp, name FROM posts
+  posts.select(:stamp).select_prepend(:name)
+  # SELECT name, stamp FROM posts
   
 === Deleting Records
 

data/doc/code_order.rdoc

@@ -91,9 +91,11 @@ unsafe runtime modification of the configuration:
   model_classes.each(&:freeze)
   DB.freeze
 
-The `subclasses` plugin can be used to keep track of all model classes
-that have been setup in your application. Finalizing their associations
-and freezing them can easily be achieved through the plugin:
+`model_classes` is not a Sequel method, it indicates an array of model
+classes you defined. Instead of listing them manually, the `subclasses`
+plugin can be used to keep track of all model classes that have been
+setup in your application. Finalizing their associations and freezing
+them can easily be achieved through the plugin:
 
   # Register the plugin before setting up the models
   Sequel::Model.plugin :subclasses

data/doc/dataset_basics.rdoc

@@ -65,7 +65,7 @@ Most Dataset methods that users will use can be broken down into two types:
 
 Most dataset methods fall into this category, which can be further broken down by the clause they affect:
 
-SELECT:: select, select_all, select_append, select_group, select_more
+SELECT:: select, select_all, select_append, select_group, select_more, select_prepend
 FROM:: from, from_self
 JOIN:: join, left_join, right_join, full_join, natural_join, natural_left_join, natural_right_join, natural_full_join, cross_join, inner_join, left_outer_join, right_outer_join, full_outer_join, join_table
 WHERE:: where, filter, exclude, or, grep, invert, unfiltered

data/doc/opening_databases.rdoc

@@ -346,6 +346,8 @@ The following additional options are supported:
                 separated by commas (for use via a URL: <tt>postgres:///?search_path=schema1,schema2</tt>), or it
                 can be an array of strings (for use via an option:
                 <tt>Sequel.postgres(search_path: ['schema1', 'schema2'])</tt>).
+:unlogged_tables_default :: Set to true to use UNLOGGED by default for created tables, for potentially better performance
+                            when data integrity is not important.
 :use_iso_date_format :: This can be set to false to not force the ISO date format.  Sequel forces
                         it by default to allow for an optimization.
 

data/doc/querying.rdoc

@@ -624,11 +624,16 @@ Like +order+, +select+ replaces the existing selected columns:
   Artist.select(:id).select(:name)
   # SELECT name FROM artists
 
-To add to the existing selected columns, use +select_append+:
+To append to the existing selected columns, use +select_append+:
 
   Artist.select(:id).select_append(:name)
   # SELECT id, name FROM artists
 
+To prepend to the existing selected columns, use +select_prepend+:
+
+  Artist.select(:id).select_prepend(:name)
+  # SELECT name, id FROM artists
+
 To remove specifically selected columns, and default back to all
 columns, use +select_all+:
 

data/doc/release_notes/5.78.0.txt

@@ -0,0 +1,67 @@
+= New Features
+
+* SQLite 3.45+ jsonb functions are now supported in the sqlite_json_ops
+  extension.  Similar to the postgres_json_ops extension, there are
+  now separate methods for dealing with json and jsonb types:
+
+    Sequel.sqlite_json_op(:column)  # json
+    Sequel.sqlite_jsonb_op(:column) # jsonb
+
+  Some methods that use json_* functions for json ops use jsonb_*
+  functions for jsonb ops:
+
+    jb = Sequel.sqlite_jsonb_op(:column)
+    jb.extract('$.a')    # jsonb_extract(column, '$.a')
+    jb.insert('$.a', 1)  # jsonb_insert(column, '$.a', 1)
+    jb.set('$.a', 1)     # jsonb_set(column, '$.a', 1)
+    jb.replace('$.a', 1) # jsonb_replace(column, '$.a', 1)
+    jb.remove('$.a')     # jsonb_remove(column, '$.a')
+    jb.patch('{"a":2}')  # jsonb_patch(column, '{"a":2}')
+
+  You can use the json and jsonb methods to convert jsonb to json
+  and json to jsonb, respectively.
+
+    jb.json              # json(column)
+
+  Use of the json method on jsonb types is important, because if you
+  want to be able to deal with the values in Ruby, you must convert
+  the jsonb value to json in the database before the database returns
+  the value.  Unlike PostgreSQL, SQLite will not convert the value
+  from jsonb to json on retrieval, and direct use of SQLite's jsonb
+  format is unsupported by SQLite as it is subject to change.
+
+* Database#with_advisory_lock is now supported on PostgreSQL, MySQL,
+  and Microsoft SQL Server. This supports advisory (explicit)
+  locking, using the database-specific APIs.  To work on all three
+  servers, lock ids should be integers in the signed 64-bit range.
+
+    DB.with_advisory_lock(1234) do
+      # do something
+    end
+
+  By default, an AdvisoryLockError is raised if the lock cannot be
+  immediately acquired.  You can use the :wait option to wait until
+  the lock can be acquired, instead of raising.
+
+    DB.with_advisory_lock(1234, wait: true) do
+      # do something
+    end
+
+* Migrator.run now supports a :use_advisory_lock option to use
+  advisory locks when running migrations, so that it does not
+  attempt to run the same migration more than once in the case
+  where multiple processes are running the migrator simultaneously.
+  It's probably best to avoid running the migrator in multiple
+  processes simultaneously instead of relying on this option.
+
+= Other Improvements
+
+* Database#values now supports chaining with compounds on
+  PostgreSQL.
+
+    DB.values([[1, 2]]).union(DB.values([[3, 4]]))
+    # SELECT * FROM (VALUES (1, 2) UNION (VALUES (3, 4))) AS t1
+
+* The internal hash used to store transaction metadata now uses
+  compare_by_identity, which is faster and avoids potential
+  issues if a driver implements connection object equality.

data/doc/release_notes/5.79.0.txt

@@ -0,0 +1,28 @@
+= New Features
+
+* Dataset#select_prepend has been added for prepending to the
+  currently selected columns:
+
+    DB[:table].select_prepend(:column)
+    # SELECT column, table.*
+
+  As not all databases support "SELECT column, *", select_prepend
+  qualifies wildcard selections to all tables referenced in the
+  query.
+
+  The only reason to use select_prepend is if you want the hashes
+  returned by Sequel to be in a specific order.  Otherwise, it is
+  better to use select_append.
+
+* On PostgreSQL, Sequel now supports an :unlogged_tables_default
+  Database option, which will default created tables to be UNLOGGED.
+  This can be useful to speedup testing in some cases, but it should
+  never be used in cases where data integrity is important.
+
+= Other Improvements
+
+* On PostgreSQL, Database#create_or_replace_view now supports the
+  :materialized option.  This allows for dropping an existing
+  materialized view and creating a new one with the same name
+  (PostgreSQL does not have native support for replacing materialized
+  views).

data/doc/release_notes/5.80.0.txt

@@ -0,0 +1,40 @@
+= New Features
+
+* A provenance dataset extension has been added. This extension makes
+  SQL queries include a comment describing how the dataset was built.
+  This can make debugging complex cases significantly easier. Here's
+  a simple example:
+
+    DB.extension :provenance
+
+    DB[:table].
+      select(:a).
+      where{b > 10}.
+      order(:c).
+      limit(10)
+      # SQL:
+      # SELECT a FROM table WHERE (b > 10) ORDER BY c LIMIT 10 --
+      #  -- Dataset Provenance
+      #  -- Keys:[:from] Source:(eval at bin/sequel:257):2:in `<main>'
+      #  -- Keys:[:select] Source:(eval at bin/sequel:257):3:in `<main>'
+      #  -- Keys:[:where] Source:(eval at bin/sequel:257):4:in `<main>'
+      #  -- Keys:[:order] Source:(eval at bin/sequel:257):5:in `<main>'
+      #  -- Keys:[:limit] Source:(eval at bin/sequel:257):6:in `<main>'
+
+  With the above example, it's obvious how the dataset is created, but
+  but in real applications, where datasets can be built from multiple
+  files, seeing where each dataset clone was made can be helpful.
+
+  The source listed will skip locations in the Ruby standard library
+  as well as Sequel itself.  Other locations can be skipped by
+  providing a Database :provenance_caller_ignore Regexp option:
+
+    DB.opts[:provenance_caller_ignore] = /\/gems\/library_name-/
+
+= Other Improvements
+
+* For dataset methods where Sequel can determine that the return
+  value would be equivalent to the receiver, Sequel now returns the
+  receiver.  This reduces the number of dataset allocations.
+
+* Sequel now supports Dataset#skip_locked on MariaDB 10.6+.

data/doc/release_notes/5.81.0.txt

@@ -0,0 +1,31 @@
+= New Features
+
+* A temporarily_release_connection Database extension has been added,
+  designed for multithreaded transactional testing.
+
+  This allows one thread to start a transaction, and then release
+  the connection back for usage by the connection pool, so that
+  other threads can operate on the connection object safely inside
+  the transaction.  This requires the connection pool be limited
+  to a single connection, to ensure that the released connection
+  can be reacquired.  It's not perfect, because if the connection
+  is disconnected and removed from the pool while temporarily
+  released, there is no way to handle that situation correctly.
+  Example:
+
+    DB.transaction(rollback: :always, auto_savepoint: true) do |conn|
+      DB.temporarily_release_connection(conn) do
+        # Other threads can operate on connection safely inside
+        # the transaction
+        yield
+      end
+    end
+
+= Other Improvements
+
+* In the caller_logging and provenance extensions, Ruby internal
+  caller locations are skipped when trying to locate the appropriate
+  caller line to include.
+
+* A couple ignored block warnings in plugin apply methods have been
+  fixed on Ruby 3.4.

data/doc/schema_modification.rdoc

@@ -81,8 +81,8 @@ appropriate 64-bit integer type for the database you are using.
 
 === Column options
 
-When using the type name as method, the third argument is an options hash, and when using the +column+
-method, the fourth argument is the options hash.  The following options are supported:
+When using the type name as method, the second argument is an options hash, and when using the +column+
+method, the third argument is the options hash.  The following options are supported:
 
 :default :: The default value for the column.
 :index :: Create an index on this column. If given a hash, use the hash as the

data/lib/sequel/adapters/shared/mssql.rb

@@ -32,7 +32,7 @@ module Sequel
       #
       # Options:
       # :args :: Arguments to stored procedure.  For named arguments, this should be a
-      #          hash keyed by argument named.  For unnamed arguments, this should be an
+      #          hash keyed by argument name.  For unnamed arguments, this should be an
       #          array.  Output parameters to the function are specified using :output.
       #          You can also name output parameters and provide a type by using an
       #          array containing :output, the type name, and the parameter name.
@@ -246,6 +246,34 @@ module Sequel
         information_schema_tables('VIEW', opts)
       end
       
+      # Attempt to acquire an exclusive advisory lock with the given lock_id (which will
+      # be converted to a string). If successful, yield to the block, then release the advisory lock
+      # when the block exits.  If unsuccessful, raise a Sequel::AdvisoryLockError.
+      #
+      # Options:
+      # :wait :: Do not raise an error, instead, wait until the advisory lock can be acquired.
+      def with_advisory_lock(lock_id, opts=OPTS)
+        lock_id = lock_id.to_s
+        timeout = opts[:wait] ? -1 : 0
+        server = opts[:server]
+      
+        synchronize(server) do
+          begin
+            res = call_mssql_sproc(:sp_getapplock, :server=>server, :args=>{'Resource'=>lock_id, 'LockTimeout'=>timeout, 'LockMode'=>'Exclusive', 'LockOwner'=>'Session'})
+
+            unless locked = res[:result] >= 0
+                raise AdvisoryLockError, "unable to acquire advisory lock #{lock_id.inspect}"
+            end
+
+            yield
+          ensure
+            if locked
+              call_mssql_sproc(:sp_releaseapplock, :server=>server, :args=>{'Resource'=>lock_id, 'LockOwner'=>'Session'})
+            end
+          end
+        end
+      end
+
       private
       
       # Add CLUSTERED or NONCLUSTERED as needed

data/lib/sequel/adapters/shared/mysql.rb

@@ -197,6 +197,41 @@ module Sequel
         renames.each{|from,| remove_cached_schema(from)}
       end
       
+      # Attempt to acquire an exclusive advisory lock with the given lock_id (which will be
+      # converted to a string).  If successful, yield to the block, then release the advisory lock
+      # when the block exits.  If unsuccessful, raise a Sequel::AdvisoryLockError.
+      #
+      #   DB.with_advisory_lock(1357){DB.get(1)}
+      #   # SELECT GET_LOCK('1357', 0) LIMIT 1
+      #   # SELECT 1 AS v LIMIT 1
+      #   # SELECT RELEASE_LOCK('1357') LIMIT 1
+      #
+      # Options:
+      # :wait :: Do not raise an error, instead, wait until the advisory lock can be acquired.
+      def with_advisory_lock(lock_id, opts=OPTS)
+        lock_id = lock_id.to_s
+        ds = dataset
+        if server = opts[:server]
+          ds = ds.server(server)
+        end
+
+        # MariaDB doesn't support negative values for infinite wait.  A wait of 34 years
+        # should be reasonably similar to infinity for this case.
+        timeout = opts[:wait] ? 1073741823 : 0
+      
+        synchronize(server) do |c|
+          begin
+            unless locked = ds.get{GET_LOCK(lock_id, timeout)} == 1
+              raise AdvisoryLockError, "unable to acquire advisory lock #{lock_id.inspect}"
+            end
+
+            yield
+          ensure
+            ds.get{RELEASE_LOCK(lock_id)} if locked
+          end
+        end
+      end
+
       private
       
       def alter_table_add_column_sql(table, op)
@@ -891,9 +926,9 @@ module Sequel
         (type == :insert && db.mariadb? && db.adapter_scheme != :jdbc) ? (db.server_version >= 100500) : false
       end
 
-      # MySQL 8+ supports SKIP LOCKED.
+      # MySQL 8+ and MariaDB 10.6+ support SKIP LOCKED.
       def supports_skip_locked?
-        !db.mariadb? && db.server_version >= 80000
+        db.server_version >= (db.mariadb? ? 100600 : 80000)
       end
 
       # Check the database setting for whether fractional timestamps

data/lib/sequel/adapters/shared/postgres.rb

@@ -859,6 +859,41 @@ module Sequel
         pg_class_relname(relkind, opts)
       end
 
+      # Attempt to acquire an exclusive advisory lock with the given lock_id (which should be
+      # a 64-bit integer).  If successful, yield to the block, then release the advisory lock
+      # when the block exits.  If unsuccessful, raise a Sequel::AdvisoryLockError.
+      #
+      #   DB.with_advisory_lock(1347){DB.get(1)}
+      #   # SELECT pg_try_advisory_lock(1357) LIMIT 1
+      #   # SELECT 1 AS v LIMIT 1
+      #   # SELECT pg_advisory_unlock(1357) LIMIT 1
+      #
+      # Options:
+      # :wait :: Do not raise an error, instead, wait until the advisory lock can be acquired.
+      def with_advisory_lock(lock_id, opts=OPTS)
+        ds = dataset
+        if server = opts[:server]
+          ds = ds.server(server)
+        end
+      
+        synchronize(server) do |c|
+          begin
+            if opts[:wait]
+              ds.get{pg_advisory_lock(lock_id)}
+              locked = true
+            else
+              unless locked = ds.get{pg_try_advisory_lock(lock_id)}
+                raise AdvisoryLockError, "unable to acquire advisory lock #{lock_id.inspect}"
+              end
+            end
+
+            yield
+          ensure
+            ds.get{pg_advisory_unlock(lock_id)} if locked
+          end
+        end
+      end
+
       private
 
       # Dataset used to retrieve CHECK constraint information
@@ -1390,7 +1425,7 @@ module Sequel
         elsif options[:foreign]
           raise(Error, "can't provide both :foreign and :unlogged to create_table") if options[:unlogged]
           'FOREIGN '
-        elsif options[:unlogged]
+        elsif options.fetch(:unlogged){typecast_value_boolean(@opts[:unlogged_tables_default])}
           'UNLOGGED '
         end
 
@@ -1785,7 +1820,7 @@ module Sequel
 
       Dataset.def_sql_method(self, :delete, [['if server_version >= 90100', %w'with delete from using where returning'], ['else', %w'delete from using where returning']])
       Dataset.def_sql_method(self, :insert, [['if server_version >= 90500', %w'with insert into columns override values conflict returning'], ['elsif server_version >= 90100', %w'with insert into columns values returning'], ['else', %w'insert into columns values returning']])
-      Dataset.def_sql_method(self, :select, [['if opts[:values]', %w'values order limit'], ['elsif server_version >= 80400', %w'with select distinct columns from join where group having window compounds order limit lock'], ['else', %w'select distinct columns from join where group having compounds order limit lock']])
+      Dataset.def_sql_method(self, :select, [['if opts[:values]', %w'values compounds order limit'], ['elsif server_version >= 80400', %w'with select distinct columns from join where group having window compounds order limit lock'], ['else', %w'select distinct columns from join where group having compounds order limit lock']])
       Dataset.def_sql_method(self, :update, [['if server_version >= 90100', %w'with update table set from where returning'], ['else', %w'update table set from where returning']])
 
       # Return the results of an EXPLAIN ANALYZE query as a string

data/lib/sequel/database/misc.rb

@@ -149,6 +149,7 @@ module Sequel
       @schemas = {}
       @prepared_statements = {}
       @transactions = {}
+      @transactions.compare_by_identity
       @symbol_literal_cache = {}
 
       @timezone = nil

data/lib/sequel/database/schema_methods.rb

@@ -252,10 +252,10 @@ module Sequel
     # For databases where replacing a view is not natively supported, support
     # is emulated by dropping a view with the same name before creating the view.
     def create_or_replace_view(name, source, options = OPTS)
-      if supports_create_or_replace_view?
+      if supports_create_or_replace_view? && !options[:materialized]
         options = options.merge(:replace=>true)
       else
-        swallow_database_error{drop_view(name)}
+        swallow_database_error{drop_view(name, options)}
       end
 
       create_view(name, source, options)

data/lib/sequel/dataset/dataset_module.rb

@@ -21,7 +21,7 @@ module Sequel
         where exclude exclude_having having
         distinct grep group group_and_count group_append 
         limit offset order order_append order_prepend reverse 
-        select select_all select_append select_group server
+        select select_all select_append select_group select_prepend server
       METHS
 
       # Define a method in the module

data/lib/sequel/dataset/graph.rb

@@ -253,6 +253,7 @@ module Sequel
     # Remove the splitting of results into subhashes, and all metadata
     # related to the current graph (if any).
     def ungraphed
+      return self unless opts[:graph]
       clone(:graph=>nil)
     end