sequel 4.36.0 → 5.61.0

data/doc/release_notes/3.41.0.txt

@@ -1,155 +0,0 @@
-= New Features
-
-* A connection_validator extension has been added, which
-  automatically determines if connections checked out from the pool
-  are still valid.  If they are not valid, the connection is
-  disconnected and another connection is used automatically,
-  transparent to user code.
-
-  Checking if connections are valid requires a query, so this
-  extension causes a performance hit.  For that reason, connections
-  are only checked by default if they have been inactive for more than
-  a configured amount of time (1 hour by default).  You can choose to
-  validate connections on every checkout via:
-
-    DB.pool.connection_validation_timeout = -1
-
-  However, this can cause a substantial performance hit unless you are
-  purposely using coarse connection checkouts via manual calls to
-  Database#synchronize (for example, in a Rack middleware).  Using
-  coarse checkouts can greatly reduce the amount of concurrency that
-  Sequel supports (for example, limiting the number of concurrent
-  requests to the number of database connections), so this method is
-  not without its tradeoffs.
-
-* Sequel.delay has been added for a generic form of delayed
-  evaluation.  This method takes a block and delays evaluating it
-  until query literalization.  By default, Sequel evaluates most
-  arguments immediately:
-
-    foo = 1
-    ds = DB[:bar].where(:baz=>foo)
-    # SELECT * FROM bar WHERE (baz = 1)
-    foo = 2
-    ds
-    # SELECT * FROM bar WHERE (baz = 1)
-
-  Using Sequel.delay, you can delay the evaluation:
-
-    foo = 1
-    ds = DB[:bar].where(:baz=>Sequel.delay{foo})
-    # SELECT * FROM bar WHERE (baz = 1)
-    foo = 2
-    ds
-    # SELECT * FROM bar WHERE (baz = 2)
-
-* Sequel now supports the :unlogged option when creating tables on
-  PostgreSQL, to create an UNLOGGED table.
-
-* On SQLite, Database#transaction now supports a :mode option for
-  setting up IMMEDIATE/EXCLUSIVE SQLite transactions.  Sequel also
-  supports a Database#transaction_mode accessor for setting the
-  default transaction mode on SQLite.
-
-* Most pg_* extension objects (e.g. PGArray) now support the #as
-  method for creating an SQL::AliasedExpression object.
-
-* The single_table_inheritance plugin now supports non-bijective
-  mappings.  In lay terms, this means that a one-to-one mapping
-  of column values to classes is no longer required.  You can now
-  have multiple column values that map to a single class in the
-  :model_map option, and specify a :key_chooser option to choose
-  which column value to use for the given model class.
-
-* The touch plugin now handles the touching of many_to_many
-  associations, and other associations that use joined datasets.
-
-* ConnectionPool#pool_type has been added. It returns a symbol
-  representing the type of connection pool in use (similar to
-  Database#database_type).
-
-* Database#valid_connection? has been added for checking if a given
-  connection is still valid.
-
-* Database#disconnect_connection is now part of the public API, and
-  can be used to disconnect a given connection.
-
-= Other Improvements
-
-* Uniqueness validation now correctly handles nil values.
-  Previously, it checked the underlying table for other rows where
-  the column IS NULL, but that is incorrect behavior.  Sequel's new
-  (correct) behavior is to skip the uniqueness check if the column
-  is nil.
-
-* Foreign key parsing is now supported on Microsoft SQL Server.
-
-* Dataset#reverse and #reverse_order now accept virtual row blocks.
-
-* Changing the name of the primary key column, and possibly other
-  schema changes on the primary key column, are now supported on
-  MySQL.
-
-* Primary key columns are now specifically marked as NOT NULL on
-  SQLite, as non-integer primary keys on SQLite are not considered
-  NOT NULL by default.
-
-* Failure to create a native prepared statement is now handled
-  better in the postgres, mysql, and mysql2 adapters.
-
-* Firebird now emulates selecting data without an underlying table
-  (e.g. DB.get(1)).
-
-* Finding the name of the constraint that sets column defaults on
-  Microsoft SQL Server now works correctly on JRuby 1.7.
-
-* An additional type of disconnect error is now recognized in the
-  jdbc/sqlserver adapter.
-
-* Many adapters have been fixed so that they don't raise an exception
-  if trying to disconnect an already disconnected connection.
-
-* Many adapters have been fixed so that
-  Database#log_connection_execute logs and executes the given SQL
-  on the connection.
-
-* Many adapters have been fixed so that
-  Database#database_error_classes returns an array of database
-  exception classes for that adapter.
-
-* Database#log_exception now handles a nil exception message.
-
-* Dataset#limit(nil, nil) now resets offset in addition to limit, but
-  you should still use Dataset#unlimited instead.
-
-* A bin/sequel usage quide has been added to the documentation.
-
-= Backwards Compatibility
-
-* Sequel now treats clob columns as strings instead of blobs
-  (except on DB2 when use_clob_as_blob = true).  This can make it
-  so the values are returned as strings instead of SQL::Blob values.
-  Since SQL::Blob is a String subclass, this generally will
-  not affect user code unless you are passing the values as input
-  to a separate blob column.
-
-* The Database <-> ConnectionPool interface was completely changed.
-  Sequel no longer supports custom connection procs or disconnection
-  procs in the connection pools.  The :disconnection_proc Database
-  option is no longer respected, and blocks passed to Database.new
-  are now ignored.
-
-  This change should not be user-visible, but if you had any code
-  that was monkeying with the connection pool internals, you may
-  need to modify it.
-
-* Code that was using the uniqueness check to also check for presence
-  should add a separate check for presence.  Such code was broken,
-  as it only worked if there was already a NULL column value in the
-  table. If you were relying on this broken behavior, you should
-  clean up the NULL data in the column and then mark the database
-  column as NOT NULL.
-
-* If you have code that specifically abuses the fact that non-integer
-  primary keys on SQLite allow NULL values by default, it will no
-  longer work.

data/doc/release_notes/3.42.0.txt

@@ -1,74 +0,0 @@
-= New Features
-
-* Dataset#avg, #interval, #min, #max, #range, and #sum now
-  accept virtual row blocks, allowing you to more easily get
-  aggregate values of expressions based on the table:
-
-    DB[:table].sum{some_function(column1, column2)} # => 134
-    # SELECT sum(some_function(column1, column2)) FROM table
-
-* Database#do has been added on PostgreSQL for using the DO
-  anonymous code block execution statement.
-
-* Model.dataset_module now uses a Module subclass, which allows
-  you to call subset inside a dataset_module block, making
-  it easier to consolidate dataset method code:
-
-    class Album < Sequel::Model
-      dataset_module do
-        subset(:gold){copies_sold > 500000}
-      end
-    end
-
-* Database#copy_table and #copy_into are now supported on
-  jdbc/postgres.
-
-* Sequel now supports deferred constraints on constraint types other
-  than foreign keys.  The only databases that appear to implement
-  this are Oracle and PostgreSQL.
-
-* Sequel now supports INITIALLY IMMEDIATE deferred constraints via
-  the :deferrable=>:immediate constraint/column option.
-
-* Sequel now supports setting the default size of string columns,
-  via the default_string_column_size option or accessor.  In some
-  cases, Sequel's default string column size of 255 is too large
-  (e.g. MySQL with utf8mb4 character set), and this allows you to
-  change it.
-
-= Other Improvements
-
-* Dataset#count and other methods now use a subselect in the case
-  where the dataset has an offset but no limit.
-
-* If an error occurs while attempting to commit a transaction, Sequel
-  now attempts to rollback the transaction.  Some databases do this
-  automatically, but not all.  Among other things, this fixes issues
-  with deferred foreign key constraint violations on SQLite.
-
-* When extending a model's dataset, the model's instance_dataset is
-  reset, insuring that it will also be extended with the module.
-
-* When passing an invalid argument to Dataset#filter, the exception
-  message now includes the argument.
-
-* The force_encoding plugin now works with frozen string values.
-
-* Public methods added to a model dataset_module now have model
-  class methods created for them even if the method was added outside
-  of a dataset_module block.
-
-* On PostgreSQL, Database#indexes now includes a :deferrable entry
-  for each index hash, which will be true for unique indexes where
-  the underlying constraint is deferrable.
-
-* On Microsoft SQL Server 2000, Dataset#update no longer includes a
-  limit (TOP), allowing it to work correctly. 
-
-= Backwards Compatibility
-
-* Model.dataset_methods has been removed.  This was used to store
-  blocks for methods created via def_dataset_method and subset.
-  The internals have been changed so that a dataset_module is
-  always used in these cases, therefore there was no longer a reason
-  for this method.

data/doc/release_notes/3.43.0.txt

@@ -1,105 +0,0 @@
-= New Features
-
-* A core_refinements extension has been added, which offers
-  refinement versions of Sequel's core extensions.  This requires
-  the new experimental refinement support added in ruby 2.0, and
-  allows you to use the Sequel DSL methods in a file without
-  actually modifying the Symbol, String, Array, and Hash classes.
-
-* A date_arithmetic extension has been added for performing
-  database-independent date calculations (adding/subtracting an
-  interval to/from a date):
-
-    Sequel.extension :date_arithmetic
-    e = Sequel.date_add(:date_column, :years=>1, :months=>2, :days=>3)
-    DB[:table].where(e > Sequel::CURRENT_DATE)
-
-  In addition to providing the interval as a hash, you can also
-  provide it as an ActiveSupport::Duration object.  This extension
-  is supported on 11 database types.
-
-* Dataset#get can now take an array of multiple expressions to get
-  an array of values, similar to map/select_map:
-
-    value1, value2 = DB[:table].get([:column1, :column2])
-
-* Sequel can now handle [host.]database.schema.table qualified
-  tables on Microsoft SQL Server.  To implement this support,
-  the split_qualifiers method has been added to Database and
-  Dataset for taking a possibly qualified identifier and splitting
-  it into an array of identifier strings.
-
-* The string_stripper plugin now offers the ability to manually
-  specify which columns to skip stripping for via
-  Model.skip_string_stripping. 
-
-= Other Improvements
-
-* The jdbc adapter now works with the new jdbc-* gems, which require
-  a manual load_driver step that the older jdbc-* gems did not
-  require.
-
-* The string_stripper plugin no longer strips blob columns or values.
-
-* Database#copy_into in both the postgres and jdbc/postgres adapters
-  has been fixed to better handle exceptions.  
-
-* Dataset#hash and Model#hash are now significantly faster.
-
-* Lambda procs with 0 arity can now be used as virtual row blocks
-  on ruby 1.9.  Previously, attempting to use a lambda proc with
-  0 arity as a virtual row block on ruby 1.9 would raise an exception.
-
-* Schema-qualified composite types are now handled correctly in
-  the pg_row extension.
-
-* Database#reset_primary_key_sequence on PostgreSQL now works
-  correctly when a default_schema is set.
-
-* tinyint(1) unsigned columns on MySQL are now parsed as booleans
-  instead of integers on MySQL if converting tinyint to boolean.
-   
-* The jdbc adapter now supports the jdbc-hsqldb gem, so you can
-  now install that instead of having to require the .jar manually.
-
-* Blobs are now casted correctly on DB2 when the use_clob_as_blob
-  setting is false.
-
-* Oracle timestamptz types are now handled correctly in the
-  jdbc/oracle adapter.
-
-* Sequel now defaults to :prefetch_rows = 100 in the oracle
-  adapter, which can significantly improve performance.
-
-* Sequel now defines respond_to_missing? where method_missing? is
-  defined and the object also responds to respond_to?.
-
-* Sequel::BasicObject now responds to instance_exec on ruby 1.8.
-
-= Backwards Compatibility
-
-* The meta_def method that was defined on Database, Dataset, and
-  Model classes and instances has been moved to an extension named
-  meta_def, and is no longer loaded by default.  This method was
-  previously used internally, and it wasn't designed for external
-  use.  If you have code that uses meta_def, you should now load the
-  extension manually:
-
-    Sequel.extension :meta_def
-
-* The private _*_dataset_helper model association methods are no
-  longer defined.  The AssociationReflection#dataset_helper_method
-  public method is also no longer defined.
-
-* Dataset#schema_and_table now always returns strings (or nil).
-  Before, in some cases it would return symbols.
-
-* Using a conditions specifier array with Dataset#get no longer
-  works due to the new multiple values support in Database#get.
-  So code such as:
-
-    DB[:table].get([[:a, 1], [:b, 2]])
-
-  should be changed to:
-
-    DB[:table].get(Sequel.expr([[:a, 1], [:b, 2]]))

data/doc/release_notes/3.44.0.txt

@@ -1,152 +0,0 @@
-= New Features
-
-* Dataset#paged_each has been added, for processing entire datasets
-  without keeping all rows in memory, even if the underlying driver
-  keeps all query results in memory.  This is implemented using
-  limits and offsets, and requires an order (model datasets use a
-  default order by primary key).  It defaults to fetching 1000
-  rows at a time, but that can be changed via the :rows_per_fetch
-  option.
-
-  This method is drop-in compatible for each.  Previously, the
-  pagination extension's each_page method could be used for a
-  similar purpose, but users of each_page are now encouraged to
-  switch to paged_each.
-
-* Sequel now recognizes constraint violation exceptions on most
-  databases, and will raise specific exceptions for different
-  types of constraint violations, instead of the generic
-  Sequel::DatabaseError:
-
-  * Sequel::ConstraintViolation (generic superclass)
-  * Sequel::CheckConstraintViolation
-  * Sequel::NotNullConstraintViolation
-  * Sequel::ForeignKeyConstraintViolation
-  * Sequel::UniqueConstraintViolation
-  * Sequel::Postgres::ExclusionConstraintViolation
-
-* The :dataset association option can now take accept an optional
-  association reflection option.  Instead of doing:
-
-    Album.one_to_many :artists,
-      :dataset=>{Artist...}
-
-  you can now do:
-
-    Album.one_to_many :artists,
-      :dataset=>{|r| r.associated_dataset...}
-
-  This second form will preform better.
-
-* Temporary views are now supported on PostgreSQL and SQLite using
-  the :temp option to create_view.
-
-= Other Improvements
-
-* Row fetching speed in the tinytds adapter has been increased by
-  up to 60%.
-
-* Row fetching speed in the mysql2 adapter when using an identifier
-  output method has been increased by up to 50%.
-
-* On databases where offsets are emulated via the ROW_NUMBER window
-  function (Oracle, DB2, Microsoft SQL Server), using an offset in
-  a subselect is now supported.  For example, the following code
-  previously didn't work correctly with emulated offsets:
-
-    # Second 5 rows ordered by column2 of the second 10 rows ordered
-    # by column 1.
-    DB[:table].order(:column1).limit(10, 10).
-      from_self.order(:column2).limit(5, 5)
-
-  Row processing speed has been increased slightly for all adapters
-  that supported databases where offsets are emulated.
-
-* Association method performance has improved by caching an
-  intermediate dataset.  This can close to triple the performance
-  of the association_dataset method, and increase the performance
-  of the association method by close to 30%.
-
-* Virtual Row performance has increased about 30% in the typical
-  case by using a shared VirtualRow instance.
-
-* Database#create_or_replace_view is now emulated on databases that
-  don't support it directly by dropping the view before attempting
-  to create it.
-
-* The columns_introspection extension can now introspect for simple
-  select * queries from subselects, and it can now use the cached
-  schema information in the database for simple select * queries
-  from tables.
-
-* The identity_map plugin now works correctly with many-to-many
-  right-side composite keys.
-
-* Dataset#last for Model datasets now works even if you don't specify
-  an order explicitly, giving the last entry by primary key.  Note
-  that Dataset#first for model datasets still does not order by
-  default.
-
-* The eager_each plugin no longer uses Object#extend at runtime.
-
-* Database#remove_cached_schema is now thread-safe on non-GVL ruby
-  implementations.
-
-* Connection errors in the jdbc adapter now provide slightly more
-  helpful messages.
-
-* Sequel now uses the standard offset emulation code in the
-  jdbc/as400 adapter, instead of custom offset emulation code
-  specific to that adapter.
-
-* Database#create_view with a dataset now works correctly when using
-  the pg_auto_parameterize extension.
-
-* Database#columns no longer calls the row_proc.
-
-* Dataset#schema_and_table no longer turns a literal string into a
-  non-literal string.
-
-* The oracle adapter now works with a :prefetch_rows=>nil option,
-  which explicitly disables prefetching.
-
-* The mock mssql adapter now sets a server_version so that more
-  parts of it work.
-
-= Backwards Compatibility
-
-* Offset emulation via ROW_NUMBER works by moving the query to a
-  subselect that also selects from the ROW_NUMBER window function,
-  and filtering on the ROW_NUMBER in the main query.  Previously, the
-  ROW_NUMBER was also present in the output columns, and some
-  adapter code was needed to hide that fact.  Now, the outer select
-  selects all of the inner columns in the subselect except for the
-  ROW_NUMBER, reducing the adapter code needed. This has the side
-  effect of potentially requiring a query (or multiple queries for
-  multiple subselects) to determine the columns to use.  The
-  columns_introspection extension may reduce the number of queries
-  needed.
-
-* The correlated_subquery eager limit strategy is no longer supported
-  on Microsoft SQL Server for many_*_many associations.  As the
-  window_function eager limit strategy is supported there, there is
-  no reason to use the correlated_subquery strategy.
-
-* The public AssociationReflection#_dataset_method method has been
-  removed.
-
-* The private _*_dataset methods for associations (e.g.
-  _albums_dataset) have been removed.
-
-* The private Dataset#offset_returns_row_number_column? method has
-  been removed.
-
-* :conditions options for associations are now added to the
-  association dataset before the foreign key filters, instead of
-  after.  This should have no effect unless you were introspecting
-  the dataset's opts or sql and acting on it.
-
-* The added abilities in the columns_introspection plugin to use
-  cached schema for introspection can now cause it to return
-  incorrect results if the table's schema has changed since it was
-  cached by Sequel.

data/doc/release_notes/3.45.0.txt

@@ -1,179 +0,0 @@
-= New Features
-
-* Database#transaction now recognizes a :retry_on option, which
-  should contain an exception class or array of exception classes.
-  If the transaction raises one of the given exceptions, Sequel
-  will automatically retry the transaction block.  It's a bad idea to
-  use this option if the transaction block is not idempotent.
-
-  By default, Sequel only retries the block 5 times by default,
-  to protect against infinite looping.  You can change the number
-  of retries with the :num_retries option.
-
-  Users of the :disconnect=>:retry option are encouraged to switch
-  to :retry_on=>Sequel::DatabaseDisconnectError.
-
-* Dataset#escape_like has been added for escaping LIKE
-  metacharacters.  This is designed for the case where part of
-  the LIKE pattern is based on user input that should not treat the
-  metacharacters specially.
-
-* Serialization failures/deadlocks are now raised as
-  Sequel::SerializationFailure exception instances.  This exception
-  class is a good candidate for the transaction :retry_on option.
-
-* On PostgreSQL, you can now provide the :force_standard_strings
-  and :client_min_messages Database options to override the defaults
-  on a per-instance basis.
-
-* On PostgreSQL, Database#tables and #views now recognizes a
-  :qualify option, which if true will return qualified identifiers
-  instead of plain symbols.
-
-* Transaction isolation levels are now supported on Oracle, DB2,
-  and all jdbc subadapters using the JDBC transaction support.
-
-* Dataset.def_mutation_method now accepts a :module option for
-  the module in which to define the methods (defaulting to self).
-
-* An unlimited_update plugin has been added.  It's sole purpose is to
-  eliminate a MySQL warning in replicated environments, since by
-  default Sequel::Model uses a LIMIT clause when updating on MySQL.
-
-* The named_timezones extension now adds a
-  Sequel.tzinfo_disambiguator accessor to automatically handle
-  TZInfo::AmbiguousTime exceptions.  This should be a callable object
-  that accepts two arguments, a DateTime instance and an array of
-  timezone periods, and returns the timezone period to use.
-
-= Other Improvements
-
-* Sequel now handles JSON securely, specifying the
-  :create_additions=>false option when using JSON.parse.  If you
-  really want to get the old vulnerable behavior back, override
-  Sequel.parse_json.
-
-* The json_serializer and xml_serializer plugins are now secure
-  by default.  Before, the default behavior of these plugins
-  allowed for round tripping, such that:
-
-    Album.from_xml(album.to_xml) == album
-
-  Unfortunately, that requires that the deserialization allow
-  the setting of any column.  Since the plugins also handle
-  associations, you could also set any column in any associated
-  object, even cascading to associated objects of those objects.
-
-  The new default behavior only allows deserialization to set
-  the same columns that mass-assignment would set, and not to
-  handle associated objects at all by default.  The following
-  additional options are supported:
-
-    :fields :: The specific fields to set (this was already supported
-               by the json_serializer plugin).
-    :associations :: The specific associations to handle.
-    :all_columns :: The previous behavior of setting all columns.
-    :all_associations :: The previous behavior of setting all
-                         associations.
-
-  Since JSON parsing no longer deserializes into arbitrary ruby
-  instances, from_json and array_from_json class methods have been
-  added to the json_serializer plugin, for deserializing into model
-  instances.  These mirror the from_xml and array_from_xml class
-  methods in the xml_serializer plugin.
-
-  Note that the :all_columns and :all_associations methods were
-  only added to make backwards compatibility easier.  It is
-  likely they will be removed in Sequel 4, along with the
-  json_create class method.
-
-* Sequel now attempts to use database specific error codes or
-  SQLState codes instead of regexp parsing to determine if a more
-  specific DatabaseError subclass should be used.  This should make
-  error handling faster and more robust.
-
-* Sequel now uses ESCAPE '\' when using LIKE, for similar behavior
-  across databases.  Previously, no ESCAPE clause was used, so
-  behavior differed across databases, with most not using escaping,
-  and PostgreSQL, MySQL, and H2 defaulting to backslash as the escape
-  character.
-
-* The query extension has been reimplemented and now uses a proxy
-  object instead of Object#extend.
-
-* The :pool_timeout Database option now supports fractional seconds.
-
-* Database#quote_identifier is now a public method.
-
-* Metadata parsing (schema, indexes, foreign_key_list) on PostgreSQL
-  now correctly handles the case where an unqualified table name is
-  used and tables with that name exist in multiple schemas.  It now
-  picks the first matching table in the schema_search_path, instead of
-  failing or returning results from all tables.
-
-* Sequel::Model instances no longer attempt to typecast the money
-  type on PostgreSQL, since the previous typecast didn't work
-  correctly, and correct typecasting is locale-dependent.
-
-* Sequel no longer picks up foreign keys for tables in other
-  databases when using Database#foreign_key_list on MySQL.
-
-* A warning when using the mysql2 3.12 beta has been eliminated.
-
-* A warning has been eliminated when using the jdbc/oracle adapter
-  on JRuby 1.7.
-
-* Sequel's ilike emulation should now work by default on databases
-  without specific syntax support.
-
-* Dataset#from_self! no longer creates a self referential dataset.
-
-* Coverage testing now uses simplecov instead of rcov on ruby 1.9+.
-
-= Backwards Compatibility
-
-* The switch to using JSON.parse :create_additions=>false means
-  that if your app expected JSON to deserialize into arbitrary
-  ruby objects, it is probably broken.  You should update your
-  application code to manually convert the deserialized hashes
-  into the ruby objects you want.
-
-  Note that it's not just this new version of Sequel that will
-  cause that, older versions of Sequel will break in the same
-  way if you update your JSON library to a version that is not
-  vulnerable by default.
-
-  This potentially affects the pg_json extension and serialization
-  plugin if you were expecting the JSON stored in the database
-  to be deserialized into arbitrary ruby objects.
-
-  See the json_serializer/xml_serializer changes mentioned in
-  the Other Improvements section.
-
-* The reimplemented query extension is not completely backwards
-  compatible.  For example, inside a query block, self refers to the
-  proxy object instead of a dataset, and calling methods that return
-  rows no longer raises an exception.
-
-* The metadata parsing methods on PostgreSQL no longer work with
-  unqualified tables where the table is not in the schema search
-  path.  This makes metadata parsing consistent with how datasets
-  operate.  For tables outside the schema search path, you must
-  qualify it before use now.
-
-  Additionally, using a nonexistent table name will raise an
-  exception instead of returning empty results in some cases.
-
-* The Dataset#def_mutation_method instance method has been removed.
-  This method added mutation methods directly on the dataset instance,
-  which is generally not desired.  Using the def_mutation_method class
-  method with the :module option is now the recommended approach.
-
-* The switch to using ESCAPE for LIKE characters is backwards
-  incompatible on databases that don't use escaping by default, 
-  when backslash is used in a LIKE pattern as a regular character.
-  Now you have to double the backslash in the pattern.
-
-* Database#database_error_regexps private method now can return any
-  enumerable yielding regexp/exception class pairs, it is no longer
-  specified to return a hash.