sequel 5.8.0 → 5.38.0

data/doc/release_notes/4.40.0.txt

@@ -1,179 +0,0 @@
-= New Features
-
-* A Sequel.split_symbols setting has been added.  This setting is
-  true by default, so there is no change to backwards compatibility
-  by default.  However, users can now do:
-
-    Sequel.split_symbols = false
-
-  to disable the splitting of symbols.  This will make Sequel no
-  longer treat symbols with double or triple underscores as qualified
-  or aliased identifiers, instead treating them as plain identifiers.
-  It will also make Sequel no longer treat virtual row methods with
-  double underscores as qualified identifiers.  Examples:
-
-    # Sequel.split_symbols = true
-    :column                    # "column"
-    :table__column             # "table"."column"
-    :column___alias            # "column" AS "alias"
-    :table__column___alias     # "table"."column" AS "alias"
-    Sequel.expr{table__column} # "table"."column"
-
-    # Sequel.split_symbols = false
-    :column                    # "column"
-    :table__column             # "table__column"
-    :column___alias            # "column___alias"
-    :table__column___alias     # "table__column___alias"
-    Sequel.expr{table__column} # "table__column"
-
-  Disabling symbol splitting can make things much easier if leading
-  trailing, double, or triple underscores are used in identifiers
-  in your database.
-
-  Disabling symbol splitting makes Sequel simpler, even if it does
-  make it slightly less easy to create qualified and aliased
-  identifiers.  It is possible that the symbol splitting will be
-  disabled by default starting in Sequel 5.
-
-  Note that due to Database symbol literal caching, you should not
-  change the Sequel.split_symbols setting after creating a
-  Database instance.
-
-* SQL::Identifier#[] and SQL::QualifiedIdentifier#[] have been added
-  for creating qualified identifiers.  This makes it easier and more
-  natural to create qualified identifiers from existing identifiers.
-  Previously, you could do:
-
-    Sequel[:column].qualify(:table)
-
-  You can now use the more natural:
-
-    Sequel[:table][:column]
-
-  This can also be used in virtual rows:
-
-    Sequel.expr{table[:column]}
-
-  This offers a easy way to create qualified identifers when symbol
-  splitting has been disabled.
-
-* A symbol_aref extension has been added, allowing the use of
-  Symbol#[] to create qualified identifiers if passed a Symbol,
-  SQL::Identifier, or SQL::QualifiedIdentifier.  This doesn't
-  break any existing ruby behavior, as ruby currrently raises
-  an exception in such cases.  Example:
-  
-    :table[:column] # "table"."column"
-
-  This extension can make it easier to create qualified identifiers
-  if symbol splitting is disabled.
-
-  A symbol_aref_refinement extension has also been added, which
-  adds a refinement version of the extension that can be enabled via:
-
-    using Sequel::SymbolAref
-
-* A symbol_as extension has been added, which adds the Symbol#as method
-  to create aliased identifiers.  This was previously part of the core
-  extensions, but has been separated so it can be included by itself.
-  Example:
-
-    :column.as(:alias) # "column" AS "alias"
-
-  This extension can make it easier to create aliased identifiers if
-  symbol splitting is disabled.
-
-  A symbol_as_refinement extension has also been added, which
-  adds a refinement version of the extension that can be enabled via:
-
-    using Sequel::SymbolAs
-
-* An s extension has been added, which adds the Sequel::S module,
-  containing a private #S method that calls Sequel.expr.  You can
-  include this module in any module or class where you would like the
-  S method to be available:
-
-    class Album < Sequel::Model
-      extend Sequel::S
-      one_to_many :tracks, :order=>S(:number).desc
-    end
-
-  You can include this in Object if you want the S method to be
-  available globally:
-
-    Object.send(:include, Sequel::S)
-
-  Sequel::S also works if it is used as a refinement, adding the S
-  method to Object while the refinement is active:
-
-    using Sequel::S
-
-  This extension can make it easier to create qualified and aliased
-  identifiers if symbol splitting is disabled:
-
-    S(:table)[:column]
-    S(:column).as(:alias)
-
-* Dataset#insert_conflict on PostgreSQL now supports a :conflict_where
-  option, allowing for the handling of insert conflicts when using a
-  partial unique index:
-
-    DB[:table].insert_conflict(:target=>:a,
-      :conflict_where=>{:c=>true}).insert(:a=>1, :b=>2)
-    # INSERT INTO TABLE (a, b) VALUES (1, 2)
-    # ON CONFLICT (a) WHERE (c IS TRUE) DO NOTHING
-
-= Other Improvements
-
-* Sequel no longer attempts to combine arguments for non-associative
-  operators, as doing so leads to invalid code in cases such as:
-
-    Sequel.expr{column1 - (column2 - 1)}
-
-* Sequel now automatically adds NOT NULL constraints on columns when
-  adding a primary key constraint on the columns, if the database
-  doesn't handle that situation correctly.
-
-* Database#rollback_checker now returns a thread-safe object.
-
-* SQL::QualifiedIdentifier#initialize now converts SQL::Identifier
-  arguments to strings, fixing usage of such objects in the
-  schema methods.
-
-* The prepared_statements plugin now correctly handles lookup by
-  primary key on models with joined datasets.
-
-* The dataset_associations plugin now handles many_through_many and
-  one_through_many associations that use a single join table.  Note
-  there is no reason to create such associations, as many_to_many
-  and one_through_one associations will work for such cases.
-
-* The insert_returning_select plugin now handles cases where the
-  model doesn't have a valid dataset, fixing usage with the
-  lazy_attributes and dataset_associations plugins, and potentially
-  other plugins.
-
-* The column_select plugin no longer raises an exception if the
-  model's table does not exist.
-
-* The class_table_inheritance plugin now works when the
-  prepared_statements plugin is also used.
-
-* Some adapters now avoid thread-safety issues during loading on
-  ruby implementations without a GVL by avoiding the modification of
-  shared datastructures.
-
-* When using Database#tables with the :qualify=>true option on
-  PostgreSQL, table names with double or triple underscores are
-  now handled correctly.
-
-= Backwards Compatibility
-
-* The following Dataset constants are now frozen: NON_SQL_OPTIONS,
-  ACTION_METHODS, QUERY_METHODS, CONDITIONED_JOIN_TYPES,
-  UNCONDITIONED_JOIN_TYPES, and JOIN_METHODS.  Of these,
-  NON_SQL_OPTIONS was previously modified in a non-thread-safe manner
-  by some adapters.  External adapters should switch to having the
-  adapter's dataset non_sql_options method return an array of options
-  that do not affect the SELECT SQL for the adapter's datasets, rather
-  than modifying NON_SQL_OPTIONS.

data/doc/release_notes/4.41.0.txt

@@ -1,77 +0,0 @@
-= New Features
-
-* Dataset#with_* methods have been added as equivalents for a
-  few Dataset#*= methods, but instead of modifying the receiver, they
-  return a modified copy, similar to the dataset query methods.
-  Specific methods added:
-
-  with_extend :: Extends clone with given modules
-  with_row_proc :: Modifies row_proc in clone
-  with_quote_identifiers :: Modifies quote_identifiers setting in
-                            clone
-  with_identifier_input_method :: Modifies identifier_input_method
-                                  setting in clone
-  with_identifier_output_method :: Modifies identifier_output_method
-                                   setting in clone
-
-  Similarly, on Microsoft SQL Server, a with_mssql_unicode_strings
-  method has been added, which returns a clone with the
-  mssql_unicode_strings setting modified.
-
-* On DB2, Sequel now supports an :offset_strategy Database option,
-  which can be set to :limit_offset for "LIMIT X OFFSET Y" or
-  :offset_fetch for "OFFSET Y FETCH FIRST X ROWS ONLY".  Depending
-  on what version of DB2 is used and how DB2 is configured, it's
-  possible one of these strategies will work.  For backwards
-  compatibility, the current default is still to emulate offsets
-  using the ROW_NUMBER window function.
-
-* In the json_serializer plugin, you can now use an
-  Sequel::SQL::AliasedExpression instance as an association name
-  value, which allows you to rename the association in the resulting
-  JSON:
-
-    album.to_json(:include=>{Sequel.as(:album, :s)=>{:only=>:name}})
-    # => '{"id":1,"name":"RF","artist_id":2,"s":{"name":"YJM"}}'
-
-= Other Improvements
-
-* The association dataset methods now correctly handle cases where
-  one of the keys is nil.  Previously, they would incorrectly use an
-  IS NULL predicate in such cases.  Now, they use a false predicate.
-
-* The hook_class_methods plugin handling of commit hooks has been
-  fixed.  The implementation of commit hooks (but not rollback
-  hooks) was broken in hook_class_methods starting in 4.39.0 due to
-  changes to avoid keeping references to all model instances until
-  the transaction was committed or rolled back.
-
-* Using the Fixnum schema method no longer raises a warning on ruby
-  2.4+, as it now uses the Integer class instead of the Fixnum
-  constant.
-
-* The ado adapter has been greatly improved.  It now avoids memory
-  leaks, has much better type handling, and passes almost all specs.
-  Note that the ado adapter's behavior can change depending on the
-  version of ruby in use, try to use ruby 2.2+ for best compatibility.
-
-* Dataset#graph no longer mutates the receiver.  Previously, it set
-  an empty hash as the :graph option in the receiver, which was
-  unintentional and not desired.
-
-* Pure java exceptions that don't support the message= method are now
-  handled properly when reraising the exception on connection errors
-  in the jdbc adapter.
-
-= Backwards Compatibility
-
-* Support for using the Bignum constant as a generic type has been
-  removed, as was preannounced in the 4.36.0 release notes.  Users
-  should switch to using the :Bignum constant if they haven't already.
-
-* Users of the ado adapter may need to update their code now that the
-  ado adapter correctly handles most types.
-
-* The spec_*_w rake tasks in the repository now require ruby 2.4+ and
-  use the warning library for filtering warnings, instead of trying to
-  filter warnings with egrep.

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.