sequel 5.83.1 → 5.84.0

data/doc/release_notes/5.24.0.txt

@@ -1,56 +0,0 @@
-= New Features
-
-* A :cache_file plugin option has been added to the
-  pg_auto_constraint_validations plugin.  This option specifies
-  a file to use to cache the metadata the plugin uses, so the
-  plugin does not need to run 5 queries per model at startup to
-  load the metadata.  This can dramatically improve startup time
-  when using the plugin with a large number of models.
-
-  To create the metadata file, load the plugin into Sequel::Model
-  (or whatever class you are using as the base class for your
-  model classes) with the :cache_file option, and after loading
-  all of the subclasses of that class, run:
-
-    Sequel::Model.dump_pg_auto_constraint_validations_cache
-
-  As when using the schema_caching and index_caching extensions,
-  it is up to the user to ensure that the cached metadata matches
-  the current database schema.  Sequel does no checking of this,
-  as checking would take more time, and the point of this plugin
-  is to improve startup performance.
-
-* A static_cache_cache plugin has been added.  This plugin allows
-  for caching rows for models using the static_cache plugin. This
-  prevents the need to issue a query at model creation time to
-  get the rows.  This plugin should be loaded into Sequel::Model
-  (or whatever class you are using as the base class for your
-  model classes) before loading the models using the static_cache
-  plugin.  To create the metadata file, after all subclasses of
-  that class have been loaded, run:
-
-    Sequel::Model.dump_static_cache_cache
-
-* :unique_deferrable and :primary_key_deferrable column
-  options are now supported on PostgreSQL 9+ and Oracle. This
-  allows you to created deferrable unique and primary key
-  column constraints.  You could already create deferrable
-  table constraints using the :deferrable option to the primary_key
-  and unique methods.
-
-* A :generated_always_as column option is now supported on
-  PostgreSQL 12+, for creating generated columns.
-
-* A Database#skip_logging? private method has been added.  This
-  is designed for use in extensions, to force log timing even
-  when no loggers are configured.
-
-= Other Improvements
-
-* Sequel no longer sets the :host option to localhost by default
-  in the mysql2 adapter.  This prevents Sequel from overriding
-  a host specified in the defaults_file.
-
-* All database array types are converted to Ruby arrays in the
-  jdbc adapter.  Previously, this was only done in the
-  jdbc/postgresql subadapter.

data/doc/release_notes/5.25.0.txt

@@ -1,32 +0,0 @@
-= New Features
-
-* An association_multi_add_remove plugin has been added.  This plugin
-  adds a shortcut for adding or removing multiple associated objects
-  in a single method call:
-
-    Artist.plugin :association_multi_add_remove
-    Artist.many_to_one :albums
-    Artist[1].add_albums([Album[2], Album[3]])
-    Artist[1].remove_albums([Album[4], Album[5]])
-
-  It also offers a setter method, which will add and remove associated
-  objects as necessary:
-
-    Artist[1].albums = [Album[3], Album[4]]
-
-= Other Improvements
-
-* The sharding plugin now integrates with the server_block extension.
-  This makes it so if you retrieve a model instance inside a
-  with_server block, saving the model instance will save it back to
-  the shard from which it was retrieved.
-
-* Setting a default for a column on Microsoft SQL Server now works
-  correctly if the column already has a default.
-
-* Sequel::SQL::NumericMethods#coerce no longer raises NoMethodError
-  if the super method is not defined.  This fixes some cases when
-  comparing Date/DateTime instances to Sequel objects.
-
-* The csv_serializer plugin now avoids keyword argument separation
-  issues on Ruby 2.7+.

data/doc/release_notes/5.26.0.txt

@@ -1,35 +0,0 @@
-= New Features
-
-* Support for SQL/JSON path expressions has been added to the
-  pg_json_ops extension. These are supported in PostgreSQL 12+.
-  Examples:
-
-    j = Sequel.pg_json_op(:json_column)
-    j.path_exists('$.foo')      # (jsonb_column @? '$.foo')
-    j.path_match('$.foo')       # (jsonb_column @@ '$.foo')
-    j.path_exists!('$.foo')     # jsonb_path_exists(jsonb_column, '$.foo')
-    j.path_match!('$.foo')      # jsonb_path_match(jsonb_column, '$.foo')
-    j.path_query('$.foo')       # jsonb_path_query(jsonb_column, '$.foo')
-    j.path_query_array('$.foo') # jsonb_path_query_array(jsonb_column, '$.foo')
-    j.path_query_first('$.foo') # jsonb_path_query_first(jsonb_column, '$.foo')
-
-* The nested_attributes method in the nested_attributes plugin now
-  supports a :require_modification option, which can override the
-  default require_modification setting for the nested objects. This
-  can be useful to avoid errors if multiple requests are submitted
-  simultaneously to delete the same nested row.
-
-= Other Improvements
-
-* The dirty plugin now works correctly with the typecast_on_load
-  plugin.
-
-* Sequel::Postgres::PGRange#hash has been added to the pg_range
-  extension, allowing PGRange instances to be usable as hash keys.
-
-* Table aliases are now supported for single table INSERT
-  statements on PostgreSQL 9.5+, which can make some insert_conflict
-  usage easier.
-
-* Two more foreign key constraint violation types are now recognized
-  on MySQL 8.0.13+.

data/doc/release_notes/5.27.0.txt

@@ -1,21 +0,0 @@
-= New Features
-
-* Sequel::DEFAULT has been added a constant for the DEFAULT expression,
-  useful in inserts and especially updates:
-
-    DB[:a].where(:id=>1).update(:b=>Sequel::DEFAULT)
-    # UPDATE "a" SET "b" = DEFAULT WHERE "id" = 1
-
-* SQL::Function#filter for filtered aggregate functions is now
-  supported on all databases.  On databases not supporting it natively
-  (all except PostgreSQL 9.4+ and SQLite 3.30+), a CASE statement is
-  used to emulate the support.
-
-= Other Improvements
-
-* NULLS FIRST/LAST is now used without emulation on SQLite 3.30+.
-
-* The pg_enum extension now works correctly on PostgreSQL 8.3-9.0.
-
-* Postgres::ArrayOp#join in the pg_array_ops extension now works
-  correctly on PostgreSQL <9.1.

data/doc/release_notes/5.28.0.txt

@@ -1,16 +0,0 @@
-= New Features
-
-* An any_not_empty extension has been added, for making Dataset#any?
-  without a block be the same as !empty?.  This can result in a
-  much faster database query.
-
-* An exclude_or_null extension has been added, adding a
-  Dataset#exclude_or_null method that returns rows where the given
-  expression is false or NULL.  This extension is supported on
-  PostgreSQL, SQLite, MySQL, H2, and HSQLDB.
-
-= Other Improvements
-
-* When using the jdbc/postgresql adapter, calling with_fetch_size
-  on a dataset will emit a warning.  This is because the driver
-  will ignore the setting.

data/doc/release_notes/5.29.0.txt

@@ -1,22 +0,0 @@
-= New Features
-
-* An empty_failure_backtraces plugin has been added for using empty
-  backtraces for ValidationFailed and HookFailed exceptions. In many
-  cases, these exceptions are automatically handled (e.g. web form
-  submission handling to display appropriate error pages), and using
-  empty backtraces is 10-15x faster on JRuby 9.2.7.0+.
-
-* Dataset#json_serializer_opts has been added to the json_serializer
-  plugin.  This allows setting default options on a per-Dataset basis
-  for all Dataset#to_json calls.
-
-= Other Improvements
-
-* Another disconnect error is now recognized in the tinytds adapter.
-
-* Using Sequel with the the CRuby master branch (what will be Ruby 3)
-  now works by supporting a second argument for
-  Dataset#initialize_clone.
-
-* Sequel now avoids a warning in verbose mode when using the postgres
-  adapter, a recent version of ruby-pg, and bound variables.

data/doc/release_notes/5.3.0.txt

@@ -1,121 +0,0 @@
-= New Features
-
-* An :extensions Database option is now supported, which will load the
-  named extensions into the Database before any connections are
-  initiated:
-
-    DB = Sequel.connect('mock:///', :extensions=>[:error_sql, :synchronize_sql])
-    DB = Sequel.connect('mock:///?extensions=error_sql,synchronize_sql')
-
-* A :connect_sqls Database option is now supported, which will issue
-  the given queries on all new connections:
-
-    DB = Sequel.connect('postgres:///', :connect_sqls=>[
-        'SET random_page_cost = 1.0',
-        "SET default_tablespace = 'foo'"
-      ])
-
-* DatasetModule#reverse has been added for simpler use of descending
-  orders:
-
-    class Foo < Sequel::Model
-      dataset_module do
-        reverse :newest_first, :created_at
-      end
-    end
-    Foo.newest_first.first(10)
-
-* A synchronize_sql extension has been added.  This extension checks
-  out a connection around SQL string creation, and is useful in the
-  cases where escaping values in the query requires a connection and
-  a large number of values need to be escaped.
-
-* The following features are now supported on MariaDB 10.2+:
-
-  * Common table expressions.
-
-  * Window functions.
-
-  * Dropping CHECK constraints. Older versions of MariaDB/MySQL
-    ignored CHECK constraints that were added, and Sequel did not
-    attempt to filter them out, so Sequel did not require changes to
-    add CHECK constraints.  MariaDB 10.2 CHECK constraints work
-    correctly with Sequel's constraint_validations extension/plugin.
-
-  * Raising CHECK constraint violations as
-    Sequel::CheckConstraintViolation instances.
-
-  * Recognizing curdate() as Sequel::CURRENT_DATE when used as the
-    default value for a date column.
-
-* Date::Infinity values are now supported in the
-  pg_extended_date_support extension:
-
-    DB.convert_infinite_timestamps = :date  
-
-  This returns infinite dates/timestamps as Date::Infinity instances,
-  and literalizes Date::Infinity instances correctly.
-
-= Improvements
-
-* Database#reset_primary_key_sequence now works correctly on
-  PostgreSQL 10.
-
-* If a commit or rollback raises an exception when using the postgres
-  adapter, Sequel will check the connection's current transaction
-  status and only send another rollback if the connection is currently
-  inside a transaction.  This fixes a warning that is issued in most
-  cases if a commit or rollback fails.
-
-* The jdbc/postgresql adapter now forces JDBC PreparedStatement
-  instances created by Dataset#call to never be prepared server side,
-  working around an caching issue in the jdbc-postgres drier in
-  versions greater than 9.4.1200.
-
-* Database#indexes will no longer return indexes which are in the
-  process of being dropped on PostgreSQL 9.3+.  Additionally,
-  Database#indexes will now return indexes that have indcheckxmin
-  set.  The previous removal of indexes with indcheckxmin set is
-  more likely to cause false negatives than correctly remove
-  indexes not yet valid.
-
-* Common table expressions are no longer hoisted from subqueries on
-  SQLite.  They are still hoisted from queries used in
-  UNION/INSERT/EXCEPT, since SQLite does not support common table
-  expressions at that level.
-
-* On Microsoft SQL Server, using an INSERT query with a subquery that
-  uses a common table expression now hoists the common table
-  expression from subquery level to main query level, allowing such
-  queries to work.
-
-* An additional disconnect error is now recognized in the oracle
-  adapter.
-
-* bin/sequel now adds a Database logger before the initial
-  connection is made, allowing you to see any connection setup
-  statements issued to the database.
-
-= Backwards Compatibility
-
-* Calling a filtering method with no argument and a virtual row
-  block that returns nil on a dataset with no existing filter is
-  deprecated in this version and will emit a warning.  The behavior
-  in this version remains the same, where the dataset is not
-  modified. The behavior will change in Sequel 5.4.0 so that a
-  WHERE NULL filter will be added in that case, instead of the
-  filter being ignored, so that the behavior is similar to calling
-  the filtering method with a nil argument.
-
-    # Sequel 5.3.0
-    DB[:a].where{nil}
-    # SELECT * FROM a
-
-    # Sequel 5.4.0
-    DB[:a].where{nil}
-    # SELECT * FROM a WHERE NULL
-
-* Support for PostgreSQL <8.1 has been dropped from Database#indexes.
-  Sequel's PostgreSQL support requires >=8.2 for Dataset#insert to
-  work, so it doesn't make sense to support earlier versions in other
-  cases.

data/doc/release_notes/5.30.0.txt

@@ -1,20 +0,0 @@
-= New Features
-
-* Sequel now supports generated columns on SQLite 3.31+ using the
-  :generated_always_as and :generated_type options. Example:
-
-    DB.create_table(:table) do
-      primary_key :id
-      Numeric :amount, null: false
-      Numeric :tax, null: false
-      Numeric :total, generated_always_as: (Sequel[:amount] + :tax)
-    end
-
-= Other Improvements
-
-* The Database#transaction :before_retry option is now called before
-  retrying the transaction even when the :num_retries option is set
-  to nil.
-
-* The gem no longer ships with specs and older release notes, reducing
-  the gem size by over 40%.

data/doc/release_notes/5.31.0.txt

@@ -1,148 +0,0 @@
-= New Features
-
-* A forbid_lazy_load plugin has been added to forbid the lazy loading
-  of model associations if the current object was retreived with other
-  objects.  This plugin helps detect N+1 query issues.  This plugin
-  will raise an error if a lazy load is detected in such cases:
-
-    Album.plugin :forbid_lazy_load
-    Album.one_to_many :tracks
-
-    Album.each do |album|
-      album.tracks
-      # Could be N+1, raises Sequel::Plugins::ForbidLazyLoad::Error
-    end
-
-    Album.first.tracks
-    # Could not be N+1, no error raised
-
-  The forbid_lazy_load plugin is designed to be loaded into the base
-  model class (generally Sequel::Model), and can be loaded only in
-  test mode, or only in certain test mode configurations, so that it
-  does not have any production performance impact.
-
-  Note that an alternative approach that Sequel has supported for many
-  years is the tactical_eager_loading plugin, which automatically
-  eager loads when an N+1 query issue is detected.
-
-* An association_lazy_eager_option plugin has been added which supports
-  the :eager option for the association method.  If the association has
-  not been loaded, this eagerly loads the associations specified by the
-  :eager option when loading the association.  If the association has
-  already been loaded, this option is ignored, with the assumption that
-  whatever loaded the association already used the correct eager
-  loading.  Example:
-
-    Album.plugin :association_lazy_eager_option
-    Album.one_to_many :tracks
-    Track.many_to_one :artist
-
-    album = Album.first
-    album.tracks(:eager=>:artist)
-    # Loads tracks for album, then artist for each track (2 queries)
-
-    album.tracks(:eager=>:artist)
-    # No query issued as association is cached
-
-  You could previously have similar behavior for uncached associations
-  by passing a block to the association method and calling eager on
-  the yielded dataset.  However, that would ignore any cached
-  association, causing redundant loading of the association in such
-  cases.
-
-* On PostgreSQL 10+, creating partitioned tables and partitions of
-  other tables is now supported.
-
-  To create a partitioned table, use the :partition_by option:
-
-    DB.create_table(:table1, partition_by: :date_column,
-                            partition_type: :range) do
-      Integer :id
-      Date :date_column
-    end
-
-    DB.create_table(:table2, partition_by: :string_column,
-                             partition_type: :list) do
-      Integer :id
-      String :string_column
-    end
-
-    DB.create_table(:table3, partition_by: :int_column,
-                             partition_type: :hash) do
-      Integer :id
-      Integer :int_column
-    end
-
-  To add partitions of other tables, use the :partition_of option.
-  This option will use a custom DSL specific to partitions of other
-  tables.
-  
-  For range partitioning, you can use the from and to methods to
-  specify the inclusive beginning and exclusive ending of the range
-  of the partition.  You can call the minvalue and maxvalue methods
-  to get the minimum and maximum values for the column(s) in the
-  range, useful as arguments to from and to:
-
-    DB.create_table(:table1a, partition_of: :table1) do
-      from minvalue
-      to 0
-    end
-    DB.create_table(:table1b, partition_of: :table1) do
-      from 0
-      to 100
-    end
-    DB.create_table(:table1c, partition_of: :table1) do
-      from 100
-      to maxvalue
-    end
-
-  For list partitioning, you use the values_in method.  You can also
-  use the default method to mark a partition as the default partition:
-
-    DB.create_table(:table2a, partition_of: :table2) do
-      values_in 1, 2, 3
-    end
-    DB.create_table(:table2b, partition_of: :table2) do
-      values_in 4, 5, 6
-    end
-    DB.create_table(:table2c, partition_of: :table2) do
-      default
-    end
-
-  For hash partitioning, you use the modulus and remainder methods:
-
-    DB.create_table(:table3a, partition_of: :table3) do
-      modulus 3
-      remainder 0
-    end
-    DB.create_table(:table3b, partition_of: :table3) do
-      modulus 3
-      remainder 1
-    end
-    DB.create_table(:table3c, partition_of: :table3) do
-      modulus 3
-      remainder 2
-    end
-
-* On PostgreSQL 12+ and SQLite 3.31+, column schema hashes now have
-  a :generated entry for whether the column is a generated column.
-
-* The schema_dumper extension now dumps generated columns correctly
-  when using the :same_db option on PostgreSQL 12+.
-
-* A skip_saving_columns plugin has been added.  This allows skipping
-  saving of specific columns for the model.  By default, it skips
-  saving of generated columns, but you can customize the columns
-  that it skips:
-
-    Album.plugin :skip_saving_columns
-    Album.skip_saving_columns = [:some_column]
-
-= Other Improvements
-
-* The alter_table drop_constraint :primary_key option on SQLite now
-  works correctly for non-integer primary keys.
-
-* When an error is raised due to an irreversible migration, the error
-  message now includes the file containing the migration for easier
-  debugging.

data/doc/release_notes/5.32.0.txt

@@ -1,46 +0,0 @@
-= New Features
-
-* A fiber_concurrency extension has been added, for using
-  Fiber.current instead of Thread.current when checking out a
-  connection.  This allows separate fibers of the same thread
-  to use separate connections.  In addition to allowing direct use
-  of fibers, this also allows concurrent use of multiple enumerators
-  that use database connections in the same thread.
-
-  When using this extension, you must be careful and ensure that you
-  are not using more concurrent fibers than your connection pool size.
-  Otherwise, all fibers will block while one fiber waits until a
-  connection is available.  It is possible this issue will be
-  addressed when Ruby implements a fiber scheduler (currently
-  being discussed for inclusion in Ruby 3).
-
-* A run_transaction_hooks Database extension has been added,
-  allowing for running the transaction hooks before commit/rollback,
-  which can be helpful for testing the hooks when using transactional
-  testing.
-
-= Other Improvements
-
-* Database#create_table? now works correctly with the :partition_of
-  option on PostgreSQL.
-
-* The timestamp(N) with time zone type is now recognized by the
-  schema parser.
-
-* Singleton methods of the Sequel module have now been moved into a
-  Sequel::SequelMethods module.  This allows you to extend Sequel
-  with a module that overrides the methods and call super to get
-  the default behavior.
-
-* The pg_inet extension no longer defines inet/cidr conversion procs
-  if sequel_pg 1.13.0+ is in use.  This is because sequel_pg 1.13.0+
-  will respect the conversion procs and defining them makes things
-  slower.  sequel_pg 1.13.0+ handles the same conversion by default
-  without needing a conversion proc.
-
-* Method visibility issues in the model, plugin, extension, and adapter
-  code have been fixed.  Most cases fixed were private methods being
-  accidentally made public when they were overridden.
-
-  During this change, Model#_insert_values was changed from public to
-  private, since it was originally intended to be private.

data/doc/release_notes/5.33.0.txt

@@ -1,24 +0,0 @@
-= New Features
-
-* Custom join types are now supported on a per-association basis when
-  using eager_graph/association_join.  This builds on the previous
-  support for custom aliases, using Sequel::SQL::AliasedExpression:
-
-    class Artist < Sequel::Model; end
-    class Album < Sequel::Model; end
-    class Track < Sequel::Model; end
-    Artist.one_to_many :albums
-    Album.one_to_many :tracks
-    Artist.eager_graph(
-      Sequel[:albums].as(:a, join_type: :inner) =>
-        Sequel[:tracks].as(:t, join_type: :left)
-    )
-
-* A Database#current_timestamp_utc accessor has been added on SQLite.
-  Setting this to true will keep CURRENT_TIMESTAMP, CURRENT_TIME, and
-  CURRENT_DATE in UTC instead of converting them to localtime.
-
-= Other Improvements
-
-* The smallserial PostgreSQL type is now recognized and Sequel will
-  not try to mark smallserial columns as identity columns.

data/doc/release_notes/5.34.0.txt

@@ -1,40 +0,0 @@
-= New Features
-
-* The association_pks plugin now creates *_pks_dataset methods for
-  each association.  These are similar to the existing *_pks getter
-  methods, but they return a dataset of the keys instead of the keys
-  themselves.
-
-* The association_pks plugin now supports a :cache_pks association
-  option, which will cache calls to the *_pks getter method. The
-  default behavior remains that the *_pks getter method only returns
-  cached values if the *_pks= setter method has been used to set the
-  values.
-
-* The *_pks getter methods supported by the association_pks plugin
-  now support a :refresh option to ignore any cached values, similar
-  to how the association getter methods work.
-
-= Other Improvements
-
-* If trying to disconnect a server that doesn't exist when using a
-  sharded connection pool, a Sequel::Error is now raised.  Previously,
-  the sharded threaded pool raised a NoMethodError and the sharded
-  single connection pool did not raise an error.
-
-* If using the :savepoint option when savepoints are not supported,
-  a Sequel::InvalidOperation exception is now raised, instead of a
-  NoMethodError.
-
-* Calling Dataset#eager_graph with no arguments now returns the
-  dataset.
-
-* If not connected to the database, the single connection pool will
-  not yield any connections to Database#pool.all_connections.
-
-* Forcing a :ruby eager limit strategy for an association without a
-  limit or offset now works correctly.
-
-* Multiple unnecessary conditionals have been removed.
-
-* Sequel core and model code now have 100% branch coverage.

data/doc/release_notes/5.35.0.txt

@@ -1,56 +0,0 @@
-= New Features
-
-* An instance_specific_default plugin has been added for setting the
-  default for the :instance_specific association option, or
-  warning/raises in cases where it is not specified.  This allows
-  you to easily find associations that would be considering instance
-  specific by default, and mark them as not instance specific for
-  better performance.
-
-= Other Improvements
-
-* Setting the :instance_specific association option to false now
-  works correctly if the association uses a block.  Associations
-  that set the :dataset option are now always considered instance
-  specific, even if the :instance_specific option is explicitly
-  passed.
-
-* The validation_class_methods plugin now considers all :if,
-  :allow_missing, :allow_nil, and :allow_blank options.  Previously,
-  it only considered the first of those options that was set.
-
-* Model.finalize_associations no longer breaks if you have
-  instance-specific associations.
-
-* Model.plugin now warns if you load the plugin with arguments or a
-  block if the plugin does not accept arguments or block.  This is
-  because a future change to Sequel could break the call.
-
-* When emulating unsupported alter table operations on SQLite, Sequel
-  now copies composite unique constraints unless the alter table
-  operation is the dropping of a unique constraint.
-
-* Sequel now recognizes an additional disconnect error in the oracle
-  adapter.
-
-* In the run_transaction_hooks extension, calling
-  run_after_{commit,rollback}_hooks now raises the correct exception
-  class.
-
-* In the pg_range extension, conversion procs for the tsrange[] and
-  tstzrange[] types are not added unless the Database uses the
-  pg_array extension.
-
-* Multiple unnecessary conditionals in plugins and extensions have
-  been removed.
-
-* Sequel plugin and extension code now have 100% branch coverage.
-
-* Sequel now avoids a statement not reached verbose warning in
-  Dataset#clone.
-
-= Backwards Compatibility
-
-* The output of Dataset#to_dot in the to_dot extension has changed
-  slightly, including hash entries with nil keys.  These entries
-  were previously ignored.