sequel 5.28.0 → 5.33.0

data/doc/release_notes/4.43.0.txt

@@ -1,87 +0,0 @@
-= New Features
-
-* Database#freeze has now been implemented.  It is now recommended
-  to use it in production and during testing, after loading
-  extensions and making other changes to Database state.  Once frozen,
-  the Database settings cannot be modified, but the Database can
-  execute queries and return results.  By freezing the Database, you
-  gain greater thread-safety assurance and will be alerted via an
-  exception if runtime code attempts to modify Database state.
-
-= Other Improvements
-
-* Model#refresh now uses the same optimization that Model.with_pk
-  uses, resulting in faster refreshing for most models.
-
-* The prepared_statements plugin no longer automatically uses
-  prepared statements in cases where it is likely to be slower.
-  Now, prepared statements are only used by default for INSERT
-  and UPDATE statements (and DELETE on Oracle and DB2).  This
-  change was made after benchmarking showed that using prepared
-  statements for primary key lookups, refreshes, and deletes is
-  significantly slower than non-prepared statements across almost
-  all adapters.
-
-* Database#extension no longer attempts to load the same extension
-  more than once.
-
-* The timestamp migrator now handles key length limitations when
-  using MySQL with InnoDB engine and utf8mb4 charset default.
-
-* The jdbc/sqlite adapter will now use SQLite result codes for
-  more accurate exception types, if the jdbc-sqlite driver
-  supports them.
-
-* dataset_module is now inherited correctly if using the
-  single_table_inheritance plugin.  This was broken in 4.42.0,
-  and fixed in 4.42.1.
-
-* The prepared_statements plugin now respects a server specified
-  for the model instance, instead of always using the default
-  server.
-
-* The prepared_statements_associations plugin now respects a
-  server specified for the model instance if using the sharding
-  plugin, instead of always using the default server.
-
-* The prepared_statements_associations plugin now works correctly
-  when using some instance-specific associations, such as
-  many_to_one associations using a nil :key option.
-
-* The prepared_statements_with_pk plugin now respects a server
-  specified for the dataset, instead of always using the default
-  server.
-
-* Model#freeze now freezes the associations hash after validating
-  the model instance, instead of before, fixing cases where
-  validation calls association methods.
-
-* Sequel no longer continually tries to determine the server
-  version on HSQLDB, if the first attempt fails.
-
-* The mock adapter now uses a thread-safe incrementor for autoid.
-
-* Mysql2 native prepared statement support now better handles
-  sharding where connection options differ per shard.
-
-* On Oracle, Database#sequence_for_table is now thread-safe.
-
-* On PostgreSQL, Database#type_supported? is now thread-safe.
-
-* On MySQL, Database#supports_timestamp_usecs? now correctly
-  memoizes false values.
-
-* The jdbc/postgresql adapter now works correctly if the
-  pg_hstore extension is loaded first.
-
-= Backwards Compatibility
-
-* Maintainers of external adapters and Database extensions
-  should update their code to support Database#freeze.
-
-* Code that relies on Database extensions being loaded multiple
-  times if called multiple times needs to be updated, because
-  now the extension only gets loaded the first time
-  Database#extension is called.
-
-* @enum_labels in the pg_enum extension is now frozen by default.

data/doc/release_notes/4.44.0.txt

@@ -1,125 +0,0 @@
-= New Features
-
-* Model.freeze is now supported and recommended in production and
-  during testing.  It freezes all class-level metadata, preventing
-  possible thread-safety issues at runtime.
-
-* Model.finalize_associations has been added, speeding up some
-  association reflection methods by about 10x.  This method
-  should be called after all associated models have been loaded.
-  This can speed up the retrieval of associated objects for small
-  datasets by 5-10%.
-
-  One advantage of using this is it will raise an exception if it
-  recognizes that any of your associations are not defined
-  correctly, such as referencing an associated class that doesn't
-  exist.
-
-* Model.freeze_descendents has been added to the subclasses plugin.
-  This method finalizes associations for all descendent classes,
-  then freezes the descendent class.  It's designed to make it
-  easy to freeze all model classes in use:
-
-    Sequel::Model.plugin :subclasses
-    Dir['./models/*.rb'].each{|f| require f}
-    Sequel::Model.freeze_descendents
-
-* An implicit_subquery dataset extension has been added, which
-  implicitly uses a subquery if you have a dataset with raw SQL and
-  you call a method that would modify the SQL used:
-
-    DB['SELECT * FROM foo'].where(:bar=>1)
-    # SELECT * FROM foo
-
-    DB.extension :implicit_subquery
-    DB['SELECT * FROM foo'].where(:bar=>1)
-    # SELECT * FROM (SELECT * FROM foo) AS t1 WHERE (bar = 1)
-
-* Model datasets now have where_all, where_each, and
-  where_single_value methods for returning data:
-
-    class Album < Sequel::Model; end
-    Album.where_all(:id=>[1,2,3])
-    # => [Album[1], Album[3], Album[2]]
-
-    Album.where_each(:id=>[1,2,3]) do |album|
-      # ...
-    end
-
-    Album.select(:name).where_single_value(:id=>1)
-    # "Album's Name"
-
-  These methods are designed for use by other dataset methods you
-  define, and are optimized for frozen datasets if the methods will
-  be called multiple times on the same dataset.  where_all and
-  where_each can increase performance by up to 40% for small datasets
-  compared to where.all and where.each.  where_single_value can be up
-  to twice as fast as where.single_value.
-
-* Model.dataset_module now supports an eager method for eager loading:
-
-    class Album < Sequel::Model
-      many_to_one :artist
-
-      dataset_module do
-        eager :with_artist, :artist
-      end
-    end
-
-    Album.with_artist.all # eagerly loads artist association
-
-= Other Improvements
-
-* The jdbc adapter now supports Database#freeze.  Possible
-  thread-safety issues when initializing multiple jdbc Database
-  instances in separate threads at the same time have been fixed.
-
-* The postgres adapter now raises an exception if it recognizes that
-  the loaded version of sequel_pg is incompatible.
-
-* Sequel classes that are subclasses of core classes now define
-  custom #inspect methods so instances can easily be differentiated from
-  core class instances.  For example:
-
-    Sequel::SQL::Blob.new('a')
-    # => #<Sequel::SQL::Blob:0xa6f3a3c3710 bytes=1 content="a">
-    Sequel::SQLTime.now
-    # => #<Sequel::SQLTime 10:03:06>
-    Sequel::LiteralString.new("foo")
-    # => #<Sequel::LiteralString "foo">
-    class Album < Sequel::Model; end
-    Album.many_to_one :artist
-    # => #<Sequel::Model::Associations::ManyToOneAssociationReflection Album.many_to_one :artist>
-    Sequel::SQL::ValueList.new([[1,2]])
-    # => #<Sequel::SQL::ValueList [[1, 2]]>
-
-* Dataset#from_self now copies the columns from the current dataset
-  if they are present, since wrapping a dataset in a subquery should
-  not change the columns returned.
-
-* On PostgreSQL, array type conversion now correctly handles false
-  values.
-
-* Another disconnect error is now recognized by the jdbc/as400
-  adapter.
-
-* Modifications to Sequel::Model::Associations::ASSOCIATION_TYPES
-  are now thread safe, fixing issues if separate threads attempt
-  to load separate model plugins that modify this hash.
-
-* The force_encoding plugin no longer modifies the encoding of
-  Sequel::SQL::Blob instances.
-
-* Many plugins were updated so they no longer add constants to the
-  namespace of the model that loads them.
-
-= Backwards Compatibility
-
-* Maintainers of external model plugins should update their
-  code to support Model.freeze.
-
-= Upcoming Deprecation
-
-* Starting in Sequel 4.45.0, Sequel will be adding deprecation
-  warnings for features that will be removed or where behavior will
-  change in Sequel 5.

data/doc/release_notes/4.45.0.txt

@@ -1,370 +0,0 @@
-= Deprecated Features
-
-* Dataset mutation is now deprecated.  Users should switch to using
-  the non-mutating methods.
-
-    # Instead of:
-    dataset.where!(:foo)
-    # Switch to:
-    dataset = dataset.where(:foo)
-
-* Support for the Cubrid, Firebird, Informix, and Progress databases
-  has been deprecated.  Any users of this support should consider
-  creating an external adapter with the current code and maintaining
-  such support themselves.
-
-* The do (DataObjects), swift, and jdbc/as400 adapters have been
-  deprecated.  Any users of these adapters should consider creating an
-  external adapter with the current code and maintaining the adapter
-  themselves.
-
-* Model transaction hooks (after_commit, after_rollback,
-  after_destroy_commit, after_destroy_rollback) are now deprecated.
-  Users should switch to calling the after_commit and after_rollback
-  database transaction hooks directly.
-
-    # Instead of:
-    def after_commit
-      super
-      do_something
-    end
-    # Switch to:
-    def after_save
-      super
-      db.after_commit{do_something}
-    end
-
-* Passing a block to Database#from is now deprecated.  For backwards
-  compatibility, this block affected the WHERE clause instead of the
-  FROM clause.  In Sequel 5, Database#from blocks will be treated like
-  Dataset#from blocks, and will affect the FROM clause.  This behavior
-  has been available for years by using the from_block extension.
-
-    # Instead of:
-    DB.from(:foo){a > b}
-    # Switch to:
-    DB.from(:foo).where{a > b}
-
-* Passing non-hash arguments and multiple arguments to the
-  model association methods is now deprecated.  Switch to using a
-  hash as an argument.
-
-    # Instead of:
-    model.association(true)
-    model.association(proc{|ds| ds.where(:foo)})
-    # Switch to:
-    model.association(:reload=>true)
-    model.association(:callback=>proc{|ds| ds.where(:foo)})
-    model.association{|ds| ds.where(:foo)}
-
-* Passing procs as filter arguments is now deprecated.  These should
-  now be passed as blocks instead of arguments.
-
-    # Instead of:
-    dataset.where(proc{foo > bar})
-    # Switch to:
-    dataset.where{foo > bar}
-
-* Passing multiple arguments or an array as filter arguments when the
-  array/arguments does not represent a conditions specifier (array of
-  two element arrays, treated like a hash) is now deprecated.  Switch
-  to calling the filter method separately with each argument or using
-  Sequel.& to combine the arguments:
-
-    # Instead of:
-    dataset.where(:foo, :bar)
-    dataset.where([:foo, :bar])
-    # Switch to:
-    dataset.where(:foo).where(:bar)
-    dataset.where(Sequel.&(:foo, :bar))
-
-* Returning false from model before hooks to cancel an action is
-  now deprecated.  Switch to calling cancel_action instead.
-
-    # Instead of:
-    def before_save
-      return false if something
-      super
-    end
-    # Switch to:
-    def before_save
-      cancel_action('something bad') if something
-      super
-    end
-
-* Database#each_server has been deprecated.  Switch to using
-  Database#servers and Database#with_server from server_block
-  extension:
-
-    # Instead of:
-    DB.each_server{|db| db.run("foo")}
-    # Switch to:
-    DB.extension :server_block
-    DB.servers.each{|s| DB.with_server(s){DB.run("foo")}}
-
-* Calling Database#add_servers and Database#remove_servers on a
-  database that does not use the :servers option is now deprecated.
-  Currently, the calls to add_servers and remove_servers are
-  ignored for such databases, which can hide errors.
-
-* Sequel::Postgres::PG_NAMED_TYPES is now deprecated.  Switch to
-  calling Database#add_named_conversion_proc instead.
-
-    # Instead of:
-    require 'sequel/adapters/utils/pg_types'
-    Sequel::Postgres::PG_NAMED_TYPES[:foo] = lambda{|v| v}
-    DB = Sequel.connect('postgres://...')
-    # Switch to:
-    DB = Sequel.connect('postgres://...')
-    DB.add_named_conversion_proc(:foo){|v| v}
-
-* Modifying the identifier mangling settings for a Database or
-  Dataset is now deprecated unless the identifier_mangling extension
-  is explicitly loaded into the Database instance.
-
-* The Sequel::Database.single_threaded accessor is now deprecated.
-  Switch to using Sequel.single_threaded= and Sequel.single_threaded?.
-
-* Sequel::Database.identifier_input_method,
-  Sequel::Database.identifier_output_method,
-  and Sequel::Database.quote_identifier accessors are now deprecated.
-  Switch to modifying the setting for each Database instance.
-
-* Sequel.identifier_input_method=, Sequel.identifier_output_method=,
-  and Sequel.quote_identifer= setter methods are now deprecated.
-  Switch to modifying the setting for each Database instance.
-
-* Calling Dataset#delete/update/truncate on datasets with limits
-  or offsets is now deprecated, unless the database will respect
-  the limit or offset.  Currently, only MySQL and Microsoft SQL
-  Server have limited support for such deletes and updates.  You
-  should either call unlimited or skip_limit_check before calling
-  delete/update/truncate.
-
-* Deprecate having duplicate column names in subclass tables when
-  using the class_table_inheritance plugin.  The documentation has
-  warned against this for a long time, but the code did not enforce
-  it.
-
-* When using the association_pks plugin setter methods without the
-  :delay_pks association option set, a warning is now issued. In
-  Sequel 5, the default will be to assume that the :delay_pks
-  option is :always, and not to make modifications until the object
-  is saved.  If you would like to keep the current behavior, set
-  the :delay_pks=>false association option.
-
-  The current :delay_pks=>true behavior will be removed in Sequel 5,
-  with it being treated like :delay_pks=>:always.  If you are relying
-  on the current behavior of :delay_pks=>true (delay for new objects,
-  immediate for existing objects), you will need to update your code.
-
-* Database#dup/clone are now deprecated.  They have never been
-  handled correctly, since the default implementation from Kernel
-  has been used.
-
-* Model.dup/clone are now deprecated.  They have never been
-  handled correctly, as the default implemenation from Kernel/Module
-  has been used.
-
-* Database#use on MySQL is now deprecated.  Switch to creating a new
-  Database instance instead of modifying the database for an existing
-  instance.
-
-* Database#database_name on MySQL is now deprecated. Switch to asking
-  the database server which database you are connected to:
-
-    # Instead of:
-    DB.database_name
-    # Switch to:
-    DB.get{DATABASE{}}
-
-* In the lazy_attributes, nested_attributes, composition, and
-  serialization plugins, the *_module accessors are now deprecated.
-  These were implementation details that should not have been
-  exposed.
-
-* The schema plugin is now deprecated.  Switch to defining the schema
-  before creating the model class using the Database schema methods.
-
-* The scissors plugin is deprecated.  It existed for compatibility
-  with Sequel 3, but it is dangerous as it makes it easier to modify
-  all rows when the intent was to modify a single row.
-
-* The prepared_statements_associations and prepared_statements_with_pk
-  plugins are now deprecated.  These plugins generally make things
-  slower.
-
-* Dataset#unbind, Sequel::Unbinder, and Sequel::UnbindDuplicate are
-  now deprecated.  This mostly existed to support the
-  prepared_statements_associations and prepared_statements_with_pk
-  plugins.
-
-* Sequel::Error::* exception class aliases are now deprecated. Switch
-  to using the exception classes in the Sequel namespace.
-
-* Sequel::BeforeHookFailed is now deprecated.  Switch to using
-  Sequel::HookFailed.
-
-* Calling Sequel::Qualifier.new with 2 arguments is now deprecated.
-  Users should switch to calling it with a single argument (the
-  table used for qualifying unqualified identifiers).
-
-* Treating unrecognized prepared statement types as :select is now
-  deprecated.  Switch to using :select as the prepared statement
-  type.
-
-* The @was_new instance variable available in model after_save hooks
-  is now deprecated.  There is no deprecation warning associated
-  with this change.
-
-    # Instead of:
-    def after_save
-      super
-      if @was_new
-        do_something
-      else
-        do_something_else
-      end
-    end
-    # Switch to:
-    def after_create
-      super
-      do_something
-    end
-    def after_update
-      super
-      do_something_else
-    end
-
-* The @columns_updated instance variable available in model
-  after_save and after_update hooks is deprecated.  Switch to
-  using the new columns_updated plugin and calling the
-  columns_updated method.
-
-* The Sequel.cache_anonymous_models accessor has been deprecated.
-  Switch to using Sequel::Model.cache_anonymous_models.
-
-* Sequel::Model::ANONYMOUS_MODEL_CLASSES and
-  Sequel::Model::ANONYMOUS_MODEL_CLASSES_MUTEX have been
-  deprecated.
-
-* Sequel::Database::ResetIdentifierMangling has been deprecated.
-
-= New Features
-
-* A validation_contexts plugin has been added, which adds support
-  for a :validation_context option to Model#save and Model#valid?.
-  The value for this option will be available via the
-  validation_context method inside the validation hooks and
-  validate method.
-
-    class Album < Sequel::Model
-      plugin :validation_contexts
-
-      def validate
-        super
-        if validation_context == :approve
-          errors.add(:status_id, 'not 42') unless status_id == 42
-        end
-      end
-    end
-
-    album = Album.first
-    album.status_id = 41
-    album.valid?(:validation_context=>:approve) # => false
-    album.status_id = 42
-    album.valid?(:validation_context=>:approve) # => true
-
-* A columns_updated plugin has been added, allowing you to get
-  access to the hash used for updating a model instance via the
-  columns_updated method:
-
-    class Album < Sequel::Model
-      plugin :columns_updated
-
-      def after_update
-        super
-        if columns_updated.has_key?(:foo)
-          do_something(columns_updated[:foo])
-        end
-      end
-    end
-
-* Dataset#delete on Microsoft SQL Server now respects limits.  Note
-  that Microsoft SQL Server does not respect orders for deletes, only
-  limits, which makes this support not very useful.  Currently a
-  deprecation warning will be issued when using a delete with an
-  order and a limit, and in Sequel 5 an exception will be raised.
-
-* An odbc/oracle subadapter has been added.
-
-* A Model.dataset_module_class accessor has been added, allowing
-  plugins to add support for custom behavior in dataset_module blocks.
-
-* Support for deprecating constants on Ruby 2.3+ has been added.
-  Note that you will only get warnings for deprecated constant
-  use if you are running on Ruby 2.3+.  If you are running on a
-  previous version of Ruby, you should scan your code manually for
-  deprecated constant use.
-
-= Other Improvements
-
-* Using Model#cancel_action inside validation hooks now works
-  correctly when Model#valid? is called.
-
-* Model#[] now handles columns with false values correctly when using
-  the split_values plugin.
-
-* When calling Dataset#union/intersect/except on a dataset with
-  an offset but no limit, the dataset is wrapped in a subquery, just
-  like a dataset with a limit.
-
-* The dumping of 64-bit autoincrementing primary key columns by the
-  schema_dumper extension is now handled correctly when using the
-  :same_db option.
-
-* The schema_dumper extension now supports the :schema option when
-  dumping schema.
-
-* On Microsoft SQL Server and SQLAnywhere, ORDER BY clauses now come
-  after UNION/INTERSECT/EXCEPT instead of before, fixing issues when
-  the :from_self=>false option is used with union/intersect/except
-  and an order is applied afterward.
-
-* On Microsoft SQL Server, if calling Dataset#union/intersect/except
-  on a dataset with an order and without a limit or offset, the order
-  is removed.  When using UNION/INTERSECT/EXCEPT, Microsoft SQL
-  Server does not guarantee any ordering unless you specify an order
-  for the compound dataset.  As a general rule, you should always
-  apply orders after compounds instead of before.
-
-* On Microsoft SQL Server <2012, when using a dataset with an offset
-  without a limit in a UNION/INTERSECT/EXCEPT query, Sequel now uses
-  TOP (100) PERCENT to work around the limitation that using orders
-  in subqueries is not supported unless there is a limit (offsets
-  are emulated by a ROW_NUMBER window function with an order in this
-  case).
-
-* Database#indexes on MySQL now handles qualified identifiers.
-
-* Sequel now literalizes Sequel::SQLTime instances with 3 fractional
-  digits in the jdbc/postgresql adapter, fixing issues on JRuby
-  9.1.8.0+ (the first JRuby version to support greater than
-  millisecond precision).
-
-= Backwards Compatibility
-
-* When using the association_proxies plugin and passing a block when
-  loading the plugin, the :proxy_argument option in hash passed to
-  the block is now an empty hash instead of nil if no argument was
-  given to the association method.
-
-* The private Model#_valid? method now takes a single options hash
-  argument, instead of 2 arguments.
-
-* The pg_hstore extension no longer modifies PG_NAMED_TYPES.  This
-  should not affect behavior if the pg_hstore extension is loaded
-  into the Database instance.
-
-* Support for pg <0.8.0 has been dropped.  pg 0.8.0 was released in
-  January 2008.