sequel 5.20.0 → 5.49.0

data/doc/release_notes/4.42.0.txt

@@ -1,221 +0,0 @@
-= New Features
-
-* There have been numerous improvements this release related to
-  frozen datasets.  Frozen datasets now work in almost all cases,
-  except when calling a dataset mutation method.
-
-  When using ruby 2.4, Sequel uses the new support for
-  clone(:freeze=>false) to actually freeze datasets while allowing
-  them to copy singleton classes/extended modules from the dataset
-  calling clone.  On earlier versions of ruby, the dataset opts
-  are now frozen, preventing more types of accidental modification.
-
-  The dataset internals were refactored to reduce the number of
-  instance variables.  Now, datasets store all of their state
-  in opts.  Additionally, all datasets now use a thread-safe
-  cache for storing cached state such as the dataset's columns.
-  Previously, accessing/setting the columns was not thread-safe,
-  unless the ruby interpreter used thread-safe methods for
-  instance variable getting/setting.
-
-  Frozen datasets use this new cache to optimize repeated method
-  calls, resulting in substantial performance speedups.  This can
-  include caching returned and/or intermediate datasets, SELECT and
-  DELETE SQL generated, as well as internal objects designed to
-  optimize the building of SQL strings with different arguments.
-
-  Even for fairly simple datasets, this can result in up to 10x
-  performance improvements for dataset methods that don't require
-  database access, and up to 3x performance improvements for dataset
-  methods that do require database access.
-
-* A freeze_datasets Database extension has been added which
-  automatically freezes all datasets for the Database instance.
-  This also enables dataset caching when creating datasets using
-  Database#[] and #from using a single symbol, such as
-  DB[:table_name].  In addition to speeding up the methods
-  themselves, this also allows code such as:
-
-    DB[:foo].for_update.first
-
-  To run much faster by avoiding any dataset creation or SQL
-  string building after the first call.
-
-  The freeze_datasets extension makes #dup an alias of #clone,
-  ensuring that all cloned datasets that were originally created
-  by the Database instance are frozen.
-
-  It is highly recommended that you start using the
-  freeze_datasets extension in your applications using Sequel,
-  as this extension will become the default and only behavior
-  in Sequel 5.  Unfrozen datasets and dataset mutation will
-  not be supported in Sequel 5.
-
-* The dataset methods created by Model#subset and
-  Model::DatasetModule#subset now cache the returned dataset if the
-  current dataset is frozen, none of the arguments are Procs, and a
-  block is not provided.  This can result in up to a 3x performance 
-  improvement for method chains that use subsets, such as:
-
-    ModelClass.subset1.subset2.subset3.first
-
-* Model::DatasetModule has had the following methods added to it:
-  distinct, exclude, exclude_having, grep, group, group_and_count,
-  group_append, having, limit, offset, order, order_append,
-  order_prepend, select, select_all, select_append, select_group,
-  where, and server. These methods create dataset methods that
-  when called call the dataset method with the same name on the
-  receiver.  Example:
-
-    class ModelClass < Sequel::Model
-      dataset_module do
-        select :with_id_and_name, :id, :name
-        where :active, :active
-        order :by_name, :name
-      end
-    end
-
-    ModelClass.active.by_name.with_id_and_name.all
-    # SELECT id, name FROM model_classes WHERE active ORDER BY name
-    # Equivalent to:
-    ModelClass.
-      where(:active).
-      order(:name).
-      select(:id, :name).
-      all
-
-  In addition to being easier than defining the methods manually, this
-  also enables caching of the datasets in most cases, so that the
-  above method chain does not create any additional datasets after the
-  first call.
-
-* Dataset#with_extend now accepts a block and will create a module
-  with that block that will be used to extend the object, after any
-  modules given as arguments have been applied:
-
-    DB[:table].with_extend{def foo; 1 end}.foo => 1
-
-* The identifier mangling support for datasets
-  (identifier_input_method and identifier_output_method) has been
-  moved to a identifier_mangling database extension, but it is still
-  loaded by default.  You can disable the loading of this extension
-  by using the :identifier_mangling=>false Database option.  Sequel
-  5 will stop loading of this extension by default, requiring you to
-  load it manually via Database#extension if you need it.
-
-  Sequel's default remains the same as before, to convert identifiers
-  to uppercase on input and lowercase on output on databases that
-  fold unquoted identifiers to uppercase (per the SQL standard), and
-  to not mangle identifiers at all on databases that fold unquoted
-  identifiers to lowercase (MySQL, PostgreSQL, SQLite).  The
-  identifier_mangling extension just allows you to change the default
-  behavior.
-
-* On DB2, Dataset#with_convert_smallint_to_bool has been added,
-  which returns a modified dataset with the
-  convert_smallint_to_bool setting changed.  Previously,
-  chaging the smallint_to_bool setting required mutating a
-  dataset.
-
-* The mock adapter now supports Dataset#with_{autoid,fetch,numrows},
-  allowing mocking of results when using frozen datasets.
-
-= Other Improvements
-
-* Using an eager load callback when eager loading a one_to_one
-  association that uses an order or offset now works correctly
-  on databases that do not support window functions.
-
-* Dataset#== and Dataset#hash are now faster as they don't need
-  to generate SQL.  As all internal state is now stored in the
-  opts, it just considers the class, db, and opts.
-
-* The prepared statement/bound variable internals were heavily
-  refactored to be simpler and more robust, to more easily
-  support native prepared statements, and to work with frozen
-  datasets.
-
-* When emulating alter table operations on SQLite, integer
-  primary keys now use AUTOINCREMENT, since that is Sequel's
-  default when creating tables on SQLite.
-
-* On SQLite, Database#schema no longer uses :auto_increment entries
-  when the table has a composite primary key.
-
-* Most dataset opts values are now frozen to prevent accidental
-  modification and allow for thread-safe access.
-
-* SQL::Expression subclass instances are now always frozen.
-
-* Dataset::PlaceholderLiteralizer and 
-  Dataset::PlaceholderLiteralizer::Argument instances are now
-  always frozen.
-
-* Dataset#ungraphed now works on a frozen model dataset.
-
-* Model#set_server now works when the model uses a frozen dataset.
-
-* The pagination and null_dataset extensions now work on frozen
-  datasets.
-
-* Dataset#server now works for frozen model datasets when the
-  model uses the sharding plugin.
-
-* Calling eager_graph or association_join on a model dataset
-  is now deprecated if it would ignore the association's
-  :conditions option and the :graph_conditions, :graph_block,
-  or :graph_only_conditions association option is not used.
-
-* Using the :eager_limit dataset option in an eager_load
-  callback with a singular association now raises an Error.
-  Previously, the behavior was undefined.
-
-* Calling Dataset#prepare without a name argument is now
-  deprecated.  Previously, it raised an Error in the mysql, mysql2,
-  and postgres adapters, but was allowed on other adapters.
-
-* The looser_typecasting extension now handles the strict
-  BigDecimal parsing introduced in ruby 2.4.
-
-* When using the duplicate_columns_handler extension with
-  :on_duplicate_columns=>:warn, the warning message is now
-  prepend with the file and line.
-
-* Internally, Sequel uses Dataset#where instead of #filter,
-  reverse instead of reverse_order, and select_append instead
-  of select_more to save a method call and array creation.
-
-* Dataset#db= and #opts= in the sequel_3_dataset_methods
-  extension now raise a RuntimeError if the dataset is frozen.
-
-* Sequel's tests now run without warnings when using Minitest
-  5.10.
-
-* Sequel now issues a deprecation message instead of a warning
-  when used with PostgreSQL <8.2.
-
-= Backwards Compatibility
-
-* Any external dataset extensions or adapters that modified or
-  directly accessed dataset instance variables other than @db and
-  @opts (such as @columns) needs to be updated to work with the
-  new dataset internals.
-
-* Any external adapters that implemented native prepared statements/
-  bound variables need to be updated to work with the new internal
-  prepared statement API.
-
-* Model.set_dataset and .dataset= now operate on a clone of the
-  dataset given, instead of mutating the dataset that is passed in.
-  This allows them to work with frozen datasets, but can change
-  the behavior if you mutate a dataset after passing it to one
-  of these methods.  Anyone doing that needs to change their code
-  to get the current copy of the model's dataset, and mutate that,
-  or better yet, avoid mutating datasets at all.
-
-* Dataset#columns now calls #columns! instead of the other way around,
-  which may require external plugins/extensions that override #columns
-  to switch to overriding #columns!.
-
-* External adapters that want to disable identifier mangling by
-  default need to be updated.

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.