sequel 5.83.1 → 5.84.0

data/doc/release_notes/5.14.0.txt

@@ -1,63 +0,0 @@
-= New Features
-
-* The :nulls option when creating ordered expressions is now supported
-  on all databases that Sequel ships support for.  For databases that
-  do not support NULLS FIRST/NULLS LAST, support is emulated.
-
-    ds.order(Sequel.asc(:name, :nulls=>:last))
-    # When emulated:
-    # ORDER BY (CASE WHEN (name IS NULL) THEN 2 ELSE 1 END), name ASC
-
-* Model#pk_equal? has been added as a more descriptive name for
-  Model#===.  Model#=== is now an alias of Model#pk_equal?.
-
-* The roots and roots_dataset class methods in the tree plugin are now
-  also available as dataset methods.
-
-= Other Improvements
-
-* Inverting expressions using the ANY/SOME/ALL SQL operators now works
-  correctly:
-
-    # Sequel <5.14.0
-    Sequel.~(:a=>Sequel.function(:any, :x))
-    # "(a != any(x))"
-
-    # Sequel >=5.14.0
-    Sequel.~(:a=>Sequel.function(:any, :x))
-    # "NOT (a = any(x))"
-
-  Sequel has always tried to push inversion down to create SQL that is
-  easier to reason about.  However, inversion cannot be pushed down if
-  an ANY/SOME/ALL SQL operator is used, because that is a different
-  type of operation that just happens to use the same syntax.  Sequel
-  now avoids inversion push down for boolean operators where the
-  right hand side is an SQL::Function, LiteralString, or
-  SQL::PlaceholderLiteralString.
-
-* When creating a boolean expression from a hash or array of pairs, if
-  the right hand side is an unfrozen array and string, use a frozen
-  copy in the expression, so that mutating the array or string
-  argument later does not affect the expression.
-
-* When using the defaults_setter plugin with the :cache option, do not
-  cache values for columns without parseable defaults.  If the default
-  value exists but is not parseable, caching such values could result
-  in incorrect behavior if the model instance is saved later.
-
-* For models with composite primary keys, Model#=== now returns false
-  if any primary key value is nil, mirroring the behavior for the
-  scalar primary key case.
-
-* Model datasets no longer cache SQL if they include a subquery that
-  cannot cache SQL.
-
-* The SQL used for constraints in the constraint_validations
-  extension when the :allow_nil option is used is now clearer and
-  easier to understand.
-
-* The postgres adapter no longer specifies a default port when using
-  the pg driver, in order to work with configurations where the
-  :service option is used in the :driver_options hash.  The pg driver
-  defaults to port 5432 if no port is given, so this should not affect
-  backwards compatibility.

data/doc/release_notes/5.15.0.txt

@@ -1,39 +0,0 @@
-= New Features
-
-* A :qualify_tables option has been added to the
-  class_table_inheritance plugin, which will automatically qualify
-  subclass tables with the same qualifier as the superclass table
-  if the superclass table is qualified.
-
-* Model#save_validation_on_next_save! has been added, which skips all
-  validation on the next save to the object, including the running
-  of validation related hooks.  This method is designed for use only
-  when Model#valid? is called on the object before saving, to avoid
-  running validations on the object twice.  This method takes
-  precedence even over an explicit validate: true option passed to
-  Model#save, and as such should be used with care.
-
-* The postgres adapter now supports a :conn_str Database option to
-  use a PostgreSQL connection string (e.g. "host=foo port=2442") when
-  connecting.  This option has preference over other connection
-  related options if it is present.
-
-= Other Improvements
-
-* If a foreign key for a model object is changed from a nil value to
-  a non-nil value, any cached associated objects related to the
-  foreign key are no longer removed.  Such associated objects could
-  only be set manually, and if they have been set manually, it is
-  probably not a good idea to remove them automatically.
-
-* When using the nested_attributes plugin, new *_to_many associated
-  objects are not validated twice when saving.
-
-* The default table alias when using the class_table_inheritance
-  plugin now correctly handles qualified tables.
-
-* A theoretical thread safety issue when assigning connections
-  in the threaded connection pools has been fixed.
-
-* Renaming columns is now supported without emulation when using
-  SQLite 3.25+.

data/doc/release_notes/5.16.0.txt

@@ -1,110 +0,0 @@
-= New Features
-
-* Database#rollback_on_exit has been added, which allows you to
-  rollback transactions instead of committing them when exiting
-  the transaction block.  Previously, the only way to rollback
-  a transaction from inside a transaction block was to raise
-  an exception.  This allows you to tell Sequel to roll the
-  transaction back on exit, and then use return or throw to exit
-  the transaction block.
-
-  Database#rollback_on_exit supports savepoints, including
-  multiple savepoint levels, as well as canceling rollbacks:
-
-    DB.transaction do # BEGIN
-      DB.rollback_on_exit
-    end # ROLLBACK
-  
-    DB.transaction do # BEGIN
-      DB.transaction(savepoint: true) do # SAVEPOINT
-        DB.rollback_on_exit(savepoint: true)
-      end # ROLLBACK TO SAVEPOINT
-    end # COMMIT
-  
-    DB.transaction do # BEGIN
-      DB.transaction(savepoint: true) do # SAVEPOINT
-        DB.transaction(savepoint: true) do # SAVEPOINT
-          DB.rollback_on_exit(savepoint: true)
-        end # ROLLBACK TO SAVEPOINT
-      end # RELEASE SAVEPOINT
-    end # COMMIT
-  
-    DB.transaction do # BEGIN
-      DB.transaction(savepoint: true) do # SAVEPOINT
-        DB.rollback_on_exit(savepoint: true)
-      end # ROLLBACK TO SAVEPOINT
-    end # COMMIT
-  
-    DB.transaction do # BEGIN
-      DB.transaction(savepoint: true) do # SAVEPOINT
-        DB.transaction(savepoint: true) do # SAVEPOINT
-          DB.rollback_on_exit(savepoint: 2)
-        end # ROLLBACK TO SAVEPOINT
-      end # ROLLBACK TO SAVEPOINT
-    end # COMMIT
-  
-    DB.transaction do # BEGIN
-      DB.transaction(savepoint: true) do # SAVEPOINT
-        DB.transaction(savepoint: true) do # SAVEPOINT
-          DB.rollback_on_exit(savepoint: 3)
-        end # ROLLBACK TO SAVEPOINT
-      end # ROLLBACK TO SAVEPOINT
-    end # ROLLBACK
-
-    DB.transaction do # BEGIN
-      DB.rollback_on_exit
-      DB.rollback_on_exit(cancel: true)
-    end # COMMIT
-  
-* Sequel now supports window functions on SQLite 3.26.0+. SQLite
-  technically supports window functions on 3.25.0+, but enabling
-  window function support in Sequel opens up a code path that
-  generates queries that cause older versions of SQLite to produce a
-  segmentation fault.  This bug in SQLite has been fixed in 3.26.0.
-
-= Other Improvements
-
-* Sequel::Model no longer overrides existing methods when defining
-  getters and setters.  Historically, it only checked for existing
-  method definitions for methods that could be directly expressed
-  (e.g. not requiring send).  Sequel 5 broke the check for setter
-  methods that could be directly expressed.  This fixes cases where
-  model inheritance is used and the setter methods are overridden
-  in a parent class.
-
-* Alter table emulation now works correctly on SQLite 3.26.0+.
-
-* The one_to_one association setter does not modify reciprocal
-  associations in cases where doing so is not necessary.  This can
-  fix some cases where the nested_attributes plugin is used.
-
-* The class_table_inheritance plugin can now take advantage of the
-  schema_caching extension to prevent database queries to determine
-  column information when the class is created.
-
-* The nested_attributes plugin no longer validates one_to_one
-  associations twice when saving.
-
-* The class_table_inheritance plugin :qualify_tables option now
-  correctly qualifies subclasses of subclasses.
-
-* SQL expressions that are subscripted are now wrapped in parentheses.
-  This fixes at least subscripting a function expression on
-  PostgreSQL:
-
-    DB[:t].select{array_agg(column).sql_subscript(1)}
-    # SELECT (array_agg(column))[1] FROM t
-
-* Sequel::Migrator now uses more descriptive error messages if a
-  missing or empty migration directory is given.
-
-* bin/sequel -C when converting from SQLite to another database
-  type will now use 64-bit integer columns in the other database when
-  the SQLite column type is integer, as SQLite supports storing
-  64-bit values in integer columns, and most other databases only
-  support 32-bit values in integer columns.
-
-= Backwards Compatibility
-
-* The mysql adapter no longer attempts to load the mysqlplus driver,
-  it now only attempts to load the mysql driver.

data/doc/release_notes/5.17.0.txt

@@ -1,31 +0,0 @@
-= New Features
-
-* An instance-level skip_auto_validations method has been added to
-  the auto_validations plugin, allowing you to skip all or specific
-  types of auto validations inside the block:
-
-    model_instance.skip_auto_validations(:unique) do
-      puts model_instance.valid?
-    end
-
-* A Database :preconnect_extensions option has been added.  This
-  option is similar to :extensions, but the extensions are loaded
-  before the :preconnect option is processed.  This allows you to
-  use the server_logging extension with the :preconnect option.
-
-* For specifying custom table aliases when using eager_graph and
-  association_join, you can now use:
-
-    Sequel[:association].as(:table_alias)
-
-  in addition to:
-
-    Sequel.as(:association, :table_alias)
-
-= Other Improvements
-
-* The ado/mssql adapter now retrieves the number of deleted or
-  updated rows for a query without issuing a separate query.
-
-* Sequel now avoids the use of Proc.new with an implicit block, as
-  that feature will be deprecated starting in Ruby 2.7.

data/doc/release_notes/5.18.0.txt

@@ -1,69 +0,0 @@
-= New Features
-
-* A throw_failures plugin has been added for throwing ValidationFailed
-  and HookFailed exceptions instead of raising them.  This can improve
-  performance by up to 10x on JRuby and 10-15% on CRuby.  However,
-  you would need to modify your exception handling from:
-
-    begin
-      # model.save
-    rescue Sequel::ValidationFailed => e
-      # handle failure
-    end
-
-  to:
-
-    e = catch(Sequel::ValidationFailed) do
-      # model.save
-    end
-    if e.is_a?(Sequel::ValidationFailed)
-      # handle failure
-    end
-
-  The throw_failures plugin will still work if you are not catching
-  the exception, falling back to the default behavior of raising
-  the exception.
-
-* SQL::Blob.call has been added, so that SQL::Blob can be used
-  directly as a callable to create a new instance, resulting in
-  better performance in cases where a callable is needed.
-
-= Other Improvements
-
-* Type conversion is many adapters is now faster by switching from
-  Proc/Method instances to using singleton call methods on plain
-  objects.  This can improve performance of row fetching by up to
-  10% in some cases.
-
-* Row fetching is slightly faster in the jdbc and sqlite adapters,
-  by switching from each to while.
-
-* tzinfo 2 is now supported when using the named_timezones extension.
-  tzinfo 1 remains supported.
-
-* The optimized Dataset#paged_each methods in the postgres and mysql2
-  adapters now support being called without a block, returning an
-  Enumerator in that case, to mirror the behavior of the default
-  Dataset#paged_each method.
-
-* Sequel no longer uses flow-control exceptions in the
-  connection_expiration and connection_validator extensions,
-  significantly improving performance on JRuby.
-
-* The after_initialize plugin no longer makes the argument to
-  Model.call optional.
-
-= Backwards Compatibility
-
-* Some internal by not private constants and methods previously used
-  for type conversion in adapters have been removed:
-
-  * JDBC::Oracle.OracleDecimal
-  * JDBC::Oracle.OracleClob
-  * JDBC::Postgres.RubyPGArray
-  * JDBC::Postgres.RubyPGHstore
-  * JDBC::SqlAnywhere.SqlAnywhereBoolean
-  * JDBC::SQLServer.MSSQLRubyTime
-  * MySQL::TYPE_TRANSLATOR
-  * Postgres::TYPE_TRANSLATOR
-

data/doc/release_notes/5.19.0.txt

@@ -1,28 +0,0 @@
-= New Features
-
-* A Database#rename_enum_value method has been added to the pg_enum
-  extension. It is supported on PostgreSQL 10+:
-
-    DB.rename_enum_value(:enum_type, 'old_name', 'new_name')
-
-= Other Improvements
-
-* The performance of row fetching and type conversion in the
-  sqlanywhere adapter has been improved.
-
-* The performance of row fetching in the sqlite adapter has been
-  improved.
-
-* Calling Database#drop_table now drops any constraint validations
-  metadata for the table if using the constraint_validations
-  extension.  However, modifying the table using Database#alter_table
-  does not affect the constraint validations metadata.
-
-* The sqlite adapter when used with ruby-sqlite3 1.4.0+ now uses
-  SQLite extended result codes for a more accurate determination of
-  specific database errors types.
-
-* Performance for typecasting to decimal and floats has been improved
-  slightly.
-
-* Performance when merging hashes has been improved slightly.

data/doc/release_notes/5.2.0.txt

@@ -1,33 +0,0 @@
-= New Features
-
-* A pg_extended_date_support extension has been added.  This
-  extension adds support for infinite and BC dates/timestamps on
-  PostgreSQL.
-
-  The postgres adapter already had a convert_infinite_timestamps
-  setting, but it wasn't supported in the jdbc/postgresql adapter
-  and it didn't handle BC dates/timestamps.  Setting a non-default
-  convert_infinite_timestamps setting in the postgres adapter will
-  now automatically load the extension for backwards compatibility.
-
-  The pg_extended_date_support extension by default just fixes the
-  handling of BC dates/timestamps.  To get it to handle infinite
-  timestamps, you need to choose the appropriate setting for your
-  application:
-
-    DB.extension :pg_extended_date_support
-    DB.convert_infinite_timestamps = :string # or :float or :nil
-
-  This extension also enables the handling of timezone offsets
-  with seconds, which is not natively supported by ruby's Time
-  class in ruby <2.5.
-
-= Improvements
-
-* The jdbc/mysql adapter now handles smallint unsigned and
-  integer unsigned column types where the value for the column
-  is outside of the range of a Java short or integer.
-
-* Sequel::Model.inherited no longer modifies an existing @dataset
-  instance variable if one has already been set.  This fixes a
-  regression that was introduced in Sequel 5.0.0.

data/doc/release_notes/5.20.0.txt

@@ -1,89 +0,0 @@
-= New Features
-
-* Database#after_commit and #after_rollback transaction hook methods
-  now support a :savepoint option.  Using the :savepoint option makes
-  the hooks savepoint-aware, so after_commit will only be called if
-  all enclosing savepoints and the transaction are committed, and
-  after_rollback will be called when any of the enclosing savepoints
-  are rolled back (which may be before transaction commit/rollback).
-  Examples:
-
-    x = nil
-    DB.transaction do # BEGIN
-      DB.transaction(savepoint: true) do # SAVEPOINT
-        DB.after_commit(savepoint: true){x = 1}
-        DB.after_rollback(savepoint: true){x = 2}
-        x # nil
-      end # RELEASE SAVEPOINT
-      x # nil
-    end # COMMIT
-    x # 1
-
-    x = nil
-    DB.transaction do  # BEGIN
-      DB.transaction(savepoint: true) do # SAVEPOINT
-        DB.after_commit(savepoint: true){x = 1}
-        DB.after_rollback(savepoint: true){x = 2}
-        x # nil
-        raise Sequel::Rollback
-      end # ROLLBACK TO SAVEPOINT
-      x # 2
-    end # COMMIT
-    x # 2
-  
-    x = nil
-    DB.transaction do # BEGIN
-      DB.transaction(savepoint: true) do # SAVEPOINT
-        DB.after_commit(savepoint: true){x = 1}
-        DB.after_rollback(savepoint: true){x = 2}
-      end # RELEASE SAVEPOINT
-      x # nil
-      raise Sequel::Rollback
-    end
-    x # 2
-
-* The pg_auto_constraint_validations plugin now supports a
-  pg_auto_constraint_validation_override method for overriding
-  the columns and message for a specific constraint.  This is
-  useful if the database cannot determine the columns (due
-  to the constraint containing a database function call), or
-  if you would like to customize the message per constraint.
-
-= Other Improvements
-
-* The one_to_one association setter now works with models that use
-  joined datasets, such as child models when using the
-  class_table_inheritance plugin.
-
-* Database#check_constraints on PostgreSQL now also includes CHECK
-  constraints where the related columns are not known.  The :columns
-  entry in the hash will be an empty array in such cases.  The
-  exclusion of such constraints in previous versions was not
-  intentional, and the documentation implied that all CHECK
-  constraints were returned.
-
-* Many cases where instance_exec was previously used on model
-  instances have been changed so that instance methods are defined
-  and called instead.  This avoids the creation of singleton classes
-  for model instances, and can significantly improve performance in
-  some cases.  This affects all associations as well as the
-  following plugins:
-
-  * composition
-  * hook_class_methods
-  * validation_class_methods
-
-  Other cases where instance_exec is now avoided and a different
-  approach is used:
-
-  * association_dependencies plugin
-  * PlaceholderLiteralString#with_dataset
-
-* The auto_validations plugin now works with child models when using
-  the class_table_inheritance plugin.
-
-* Database#server_version now works correctly in the mysql2 adapter
-  when using the MySQL driver with MariaDB 10+.
-
-* The float unsigned type is now recognized and supported in the
-  schema parser and schema_dumper extension.

data/doc/release_notes/5.21.0.txt

@@ -1,87 +0,0 @@
-= New Features
-
-* The pg_json extension now adds a Database#wrap_json_primitives
-  accessor.  When set to true, JSON primitive values (string, number,
-  true, false, and null) will be wrapped by delegate Ruby objects
-  instead of using Ruby primitives.  This allows the values to round
-  trip, so the following code will work even for primitive values in
-  json_column:
-
-    DB.extension :pg_json
-    DB.wrap_json_primitives = true
-    value = DB[:table].get(:json_column)
-    DB[:other_table].insert(json_column: value)
-
-  This should be enabled with care, especially in cases where false
-  and null JSON values are used, as the behavior will change if
-  the objects are used in a boolean context in Ruby, as only false
-  and nil in Ruby are treated as false:
-
-    # assume JSON false or null value
-    value = DB[:table].get(:json_column)
-
-    if value
-      # executed if wrap_json_primitives is true
-    else
-      # executed by default
-    end
-
-  When typecasting input in model objects to a JSON type, string
-  input will still be parsed as JSON.  However, you can set the
-  Database#typecast_json_strings accessor to true, and then string
-  input will be considered as a JSON string instead of parsing the
-  string as JSON.
-
-  To prevent backwards compatibility issues, Sequel.pg_json/pg_jsonb
-  behavior has not changed.  To support wrapping Ruby primitives in
-  the delegate objects, new Sequel.pg_json_wrap/pg_jsonb_wrap methods
-  have been added.  These methods only handle the Ruby primitives,
-  they cannot be used if the existing object is already a delegate
-  object.
-
-  As model objects always consider a nil value as SQL NULL and do
-  not typecast it, if you want to explicitly set a JSON null value,
-  you need to wrap it explicitly:
-
-    model_object.json_column = Sequel.pg_json_wrap(nil)
-
-= Other Improvements
-
-* Sequel now supports window function options :window, :exclude, and
-  :frame :type=>:groups, :start, and :end on SQLite 3.28.0+.
-
-* The server_block extension now respects the :servers_hash Database
-  option.  This makes it more similar to Sequel's default behavior.
-  However, that means by default, the server_block extension will
-  default to handling unknown shards as the default shard, instead
-  of raising an error for them.
-
-* The rcte_tree plugin now disallows eager graphing of the ancestors
-  and descendants associations.  Previously, eager graphing of these
-  associations generated incorrect results.  It is not possible to
-  eager graph these extensions, but normal eager loading does work.
-
-* The ado adapter's performance has been improved by using faster
-  callables for type conversion and a more efficient inner loop.
-
-* The sqlite adapter now converts a :timeout option given as a string
-  to an integer.  This allows you to use the option inside of a
-  connection string.
-
-* The mysql and mysql2 adapters now recognize an additional
-  DatabaseLockTimeout error.
-
-* The jdbc/mysql adapter now works correctly when using JRuby with
-  Java 11.
-
-* The ado adapter now handles numeric values when using locales that
-  use comma instead of period as the decimal separator.
-
-= Backwards Compatibility
-
-* In the pg_json extension, the following singleton methods of
-  Sequel::Postgres::JSONDatabaseMethods are now deprecated:
-
-  * parse_json
-  * db_parse_json
-  * db_parse_jsonb 

data/doc/release_notes/5.22.0.txt

@@ -1,48 +0,0 @@
-= New Features
-
-* Sequel now supports Ruby 2.7+ startless ranges in filters:
-
-    DB[:table].where(:column=>(..10))
-    # SELECT * FROM table WHERE (column <= 10)
-
-    DB[:table].where(:column=>(...10))
-    # SELECT * FROM table WHERE (column < 10)
-
-  It also supports startless, endless ranges in filters, using a
-  condition that is always true:
-
-    DB[:table].where(:column=>(nil..nil))
-    # SELECT * FROM table WHERE (1 = 1)
-
-* Sequel now supports startless ranges in the pg_range extension:
-
-    DB.extension :pg_range
-
-    DB[:table].insert(:column=>(..10))
-    # INSERT INTO "table" ("column") VALUES ('[,10]') RETURNING "id"
-
-    DB[:table].insert(:column=>(...10))
-    # INSERT INTO "table" ("column") VALUES ('[,10)') RETURNING "id"
-
-    DB[:table].insert(:column=>(nil..nil))
-    # INSERT INTO "table" ("column") VALUES ('[,]') RETURNING "id"
-
-* Sequel now supports a :materialized option in Dataset#with on
-  PostgreSQL 12+, to control the inlining of common table expressions:
-
-    DB[:t].with(:t, DB[:t2], :materialized=>false)
-    # WITH "t" AS NOT MATERIALIZED (SELECT * FROM "t2")
-    # SELECT * FROM "t"
-
-    DB[:t].with(:t, DB[:t2], :materialized=>true)
-    # WITH "t" AS MATERIALIZED (SELECT * FROM "t2")
-    # SELECT * FROM "t"
-
-= Other Improvements
-
-* Database#primary_key_sequence now works for tables without serial
-  sequences on PostgreSQL 12+.
-
-* Dataset#multi_insert and #import with return: :primary_key option
-  on Microsoft SQL Server now work correctly if the dataset uses
-  a row_proc (e.g. for model datasets).

data/doc/release_notes/5.23.0.txt

@@ -1,56 +0,0 @@
-= New Features
-
-* An insert_conflict plugin has been added for automatically handling
-  constraint conflicts when saving new model instances.  It is
-  supported on PostgreSQL 9.5+ and SQLite 3.24.0+.
-
-    Album.new(name: 'Foo', copies_sold: 1000).
-      insert_conflict(
-        target: :name,
-        update: {copies_sold: Sequel[:excluded][:b]}
-      ).
-      save
-
-* On Microsoft SQL Server, the Database :ansi option has been added,
-  which sets the following ANSI related options:
-
-  * ANSI_NULLS
-  * ANSI_PADDING
-  * ANSI_WARNINGS
-  * ANSI_NULL_DFLT_ON
-  * QUOTED_IDENTIFIER
-  * CONCAT_NULL_YIELDS_NULL
-
-= Other Improvements
-
-* Sequel.datetime_class = Time is now supported when using the
-  named_timezones extension.  For backwards compatibility, the
-  named_timezones extension still sets
-  Sequel.datetime_class = DateTime.  When using Ruby 2.6+, the
-  Time instances have the timezone set on them using Ruby 2.6+'s
-  timezone support, but basic support works correctly in earlier
-  versions of Ruby.
-
-* On Microsoft SQL Server, Sequel now handles parsing schema for
-  tables in another database on the same server or in a database
-  on a linked server.
-
-* The pg_json extension now correctly handles subclasses of core
-  classes when wrapping objects.  This stopped working in Sequel
-  5.21.0, when support for wrapping JSON primitives was added.
-
-* Sequel now works around a couple bugs in jdbc-sqlite 3.27.2.1,
-  allowing schema parsing and foreign key parsing to work.
-
-* Dataset#execute* private methods now respect an explicitly given
-  :server option, fixing Dataset#paged_each in the postgres adapter
-  when using sharding.
-
-* Timezone offsets are now handled correctly when typecasting an array
-  or hash to datetime when Sequel.datetime_class = Time.
-
-* Sequel now avoids errors when parsing schema when using the mock
-  SQLite adapter.
-
-* A minor thread-safety issue has been fixed in the named_timezones
-  extension.