sequel 4.49.0 → 5.3.0

data/doc/reflection.rdoc

@@ -6,7 +6,7 @@ Sequel supports reflection information in multiple ways.
 
 You can get the adapter in use using Database#adapter_scheme:
 
-  DB.adapter_scheme # e.g. :postgres, :jdbc, :odbc
+  DB.adapter_scheme # :postgres, :jdbc, :odbc
 
 == Database Connected To
 
@@ -97,17 +97,17 @@ You can get an array of association symbols with Model.associations:
 
   Model.associations # [:association1, :association2, ...]
 
-You can get the association reflection for a single association via the Model.association_reflection.  Association reflections are subclasses of hash, for ease of use and introspection (and backwards compatibility):
+You can get the association reflection for a single association via the Model.association_reflection.  Association reflections are subclasses of hash:
 
-  Model.association_reflection(:association1) # {:name=>:association1, :type=>:many_to_one, :model=>Model, ...}
+  Model.association_reflection(:association1) # #<Sequel::Model::Associations::ManyToOneAssociationReflection Model.many_to_one :association1>
 
 You can get an array of all association reflections via Model.all_association_reflections:
 
-  Model.all_association_reflections # [{:name=>:association1, :type=>:many_to_one, :model=>Model, ...}, ...]
+  Model.all_association_reflections # [#<Sequel::Model::Associations::ManyToOneAssociationReflection Model.many_to_one :association1>, ...]
 
 Finally, you can get a hash of association reflections via Model.association_reflections:
 
-  Model.association_reflections # {:association1=>{:name=>:association1, :type=>:many_to_one, :model=>Model, ...}, ...}
+  Model.association_reflections # {:association1=>#<Sequel::Model::Associations::ManyToOneAssociationReflection Model.many_to_one :association1>, ...}
 
 == Validations Defined
 
@@ -118,4 +118,3 @@ When using the validation_class_methods plugin, you can use the validation_refle
 Similarly, when using the constraint_validations plugin, you can use the constraint_validation_reflections class method:
 
   Model.constraint_validation_reflections[:column] # => [[:presence, {}], [:max_length, {:argument=>255, :message=>'is just too long'}]]
-

data/doc/release_notes/5.0.0.txt

@@ -0,0 +1,159 @@
+= Major Changes
+
+* Datasets are now frozen by default.  Since Sequel's inception,
+  datasets have used a method-chaining API that returned modified
+  copies, but previously they still supported direct mutation.  Now,
+  datasets are always frozen and cannot be mutated. This allows many
+  additional default optimizations related to caching, and provides
+  greater thread safety.
+
+    ds = DB[:table]
+
+    # Before
+    ds.row_proc = lambda{|h| h}
+
+    # Now
+    ds = ds.with_row_proc(lambda{|h| h})
+
+* Symbol splitting to create qualified and/or aliased identifiers is
+  now disabled by default.  While symbol splitting allowed for shorter
+  code, it was not obvious and caused significant issues when using
+  column names with embedded double or triple underscores.  Sequel now
+  offers many ways to create qualified and/or aliased identifiers.
+
+    # Before
+    :table__column          # "table"."column"
+
+    # Now
+    :table__column          # "table__column"
+    Sequel[:table][:column] # "table"."column"
+
+    # To get back historical behavior
+    Sequel.split_symbols = true
+
+* Sequel no longer allows the use of plain ruby strings as SQL code
+  fragments in the dataset filtering methods, as that makes it
+  easier to introduce SQL injection vulnerabilities.  You can use
+  Sequel.lit to create literal strings (SQL code fragments), which
+  makes it easier to do security auditing of applications using
+  Sequel.
+
+    # Before
+    DB[:table].where("column = 1").all
+
+    # Now 
+    DB[:table].where(Sequel.lit("column = 1")).all
+    # or better
+    DB[:table].where(column: 1).all
+
+    # To get back historical behavior
+    DB.extension :auto_literal_strings
+
+= Backwards Compatibility
+
+* All adapters, extensions, plugins, features, and constants
+  deprecated in 4.49.0 have been removed.  Before upgrading to Sequel
+  5.0.0, upgrade to 4.49.0 and fix all deprecation warnings.
+
+* Support for ruby 1.8.7 has been dropped, the minimum ruby version is
+  now 1.9.2.
+
+* The {before,after,around}_validation hooks are now always called
+  when saving, even if the validate: false option is used.  This
+  allows you to use the before_validation hook to make changes
+  to the model instance that are required before validation and
+  before saving even if not validating.
+
+* Getting column values for newly created model instances after
+  insertion now happens before after_create is called, instead of
+  after.
+
+* Sequel now immediately attempts to the connect to the database
+  when a Database instance is created, in order to fail fast if the
+  connection parameters are invalid.
+
+* The validates_unique method in the validation_helpers plugin
+  now only checks for uniqueness by default if the record is new or
+  one of the related columns has been modified by default.
+
+* Database schema modification methods and schema generator methods
+  now return nil instead of some internal value.
+
+* Many cases where Sequel used Kernel#send internally have been
+  switched to Kernel#public_send so they only call public methods.
+
+* Model association hooks are now nil instead of empty arrays by
+  default.
+
+* Internal uses of instance_eval with a block have been changed to
+  instance_exec.  This allows them to be used with lambdas that
+  take no arguments.
+
+* Most internal constants are now frozen, unless there is a
+  requirement that they be modified at runtime.
+  
+* The Model @was_new instance variable is now no longer set when
+  saving new model instances.
+
+* The private Sequel::Postgres::PGArray::Parser#new_entry_buffer
+  method in the pg_array extension has been removed.
+
+* Modifying Model.input_transformer_order in the input_transformer
+  plugin no longer has an effect.
+
+= New Features
+
+* Database#add_index :if_not_exists option is now supported on
+  PostgreSQL 9.5+.
+
+* SQL::Subscript#expression has been added to retrieve the
+  expression that is subscripted.
+
+= Other Improvements
+
+* Threaded connection pools no longer block while new connections
+  are being made.  Previously, attempting to establish a new
+  connection blocked all connection pool activity until the new
+  connection was made.
+
+* Many minor performance improvements have been made.
+
+* The class_table_inheritance plugin now raises an error during
+  Model#update if a query does not modify a single row, just as
+  the default Model#update does.
+
+* ConnectionPool#size is now thread-safe in both threaded
+  connection pools. Internal callers that already have the
+  connection pool mutex should switch to using #_size (a new
+  private method).
+
+* Registration of new serialization formats in the serialization
+  plugin is now thread-safe.
+
+* If transactional schema modifications are not supported, a
+  savepoint will not automatically be created when adding
+  indexes for new tables inside transactions.  This fixes issues
+  when making schema changes inside transactions on MySQL.
+
+* Attempting to create a prepared statement using a dataset that
+  uses a delayed evaluation now raises an error, because the
+  prepared statement would not respect the delayed evaluation.
+
+* The bin/sequel -M option now uses base 10.  Previously, it
+  used the Kernel#Integer default, which was base 8 if there was
+  a preceding 0.
+
+= Deprecated Features
+
+These deprecated features will be removed in Sequel 5.1.0.
+
+* Model.allowed_columns in the base plugin is now deprecated. Use
+  the whitelist_security plugin if you want to call it.
+
+* Model use_after_commit_rollback class and instance accessors are
+  now deprecated.
+
+* Defining the Model#_before_validation method is now deprecated.
+  You can change to using before_validation.
+
+* The private Model.plugin_module_defined? method is now deprecated.

data/doc/release_notes/5.1.0.txt

@@ -0,0 +1,31 @@
+= Improvements
+
+* Database#copy_into in the jdbc/postgresql adapter now works
+  correctly when using multibyte characters in strings.
+
+* The alter_table add_foreign_key method is now reversible when the
+  :foreign_key_constraint_name option is used.
+
+* The jdbc/h2 and jdbc/hsqldb adapters now respect the
+  :foreign_key_constraint_name option.
+
+* Calling Model.freeze on an already frozen model no longer raises
+  an error.
+
+* An unnecessary database query is now avoided when loading the
+  pg_inet extension when the pg_array extension is already loaded.
+
+* A better exception message is now used when migrating with an
+  empty migration directory.
+
+= Backwards Compatibility
+
+* Model.allowed_columns has been removed. Use the whitelist_security
+  plugin if you want to call it.
+
+* Model use_after_commit_rollback class and instance accessors have
+  been removed.
+
+* Support for the Model#_before_validation method has been removed.
+
+* The private Model.plugin_module_defined? method has been removed.

data/doc/release_notes/5.2.0.txt

@@ -0,0 +1,33 @@
+= 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.3.0.txt

@@ -0,0 +1,121 @@
+= 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.