sequel 5.6.0 → 5.7.0

data/doc/release_notes/3.10.0.txt

@@ -1,286 +0,0 @@
-New Features
-------------
-
-* A real one_to_one association was added to Sequel, replacing the
-  previous :one_to_one option of the one_to_many association.
-  
-  This is a fully backwards incompatible change, any code that uses
-  the :one_to_one option of one_to_many will be broken in Sequel
-  3.10.0, as that option now raises an exception.  Keeping backwards
-  compatibility was not possible, as even the name of the association
-  needs to be changed.  Here are the code changes you need to make:
-  
-  * The association definition needs to change from one_to_many to
-    one_to_one, with no :one_to_one option, and with the association
-    name changed from the plural form to the singular form:
-    
-      # Before
-      Lyric.one_to_many :songs, :one_to_one=>true
-      # After
-      Lyric.one_to_one :song
-      
-  * All usage of the association when eager loading or when getting
-    reflections need to use the new singular association name:
-    
-      # Before
-      Lyric.eager(:songs).all
-      Lyric.eager_graph(:songs).all
-      Lyric.association_reflection(:songs)
-      # After
-      Lyric.eager(:song).all
-      Lyric.eager_graph(:song).all
-      Lyric.association_reflection(:song)
-      
-  Any Sequel plugins or extensions that deal with the internals of
-  associations need to be made aware of the one_to_one association,
-  and how it is different than one_to_many's previous :one_to_one
-  option.  Here are some internal changes that may affect you:
-  
-  * one_to_one associations are now cached like many_to_one
-    associations instead of like one_to_many associations.  So the
-    cache includes the associated object or nil, instead of an array.
-    Note that this change means that all custom :eager_loader options
-    for one_to_one associations need to change to use this new
-    caching scheme.
-    
-  * The one_to_one association setter method is now handled similarly
-    to the many_to_one setter method, instead of using the internal
-    one_to_many association add method.
-    
-  * Instead of raising an error when multiple rows are returned,
-    one_to_one associations now use limit(1) to only return a single
-    row.
-    
-  There were some other fixes made during these changes:
-  
-  * The one_to_one setter now accepts nil to disassociate the record.
-    Previously, this raised an error.
-    
-  * If the one_to_one association already had a separate object
-    associated, and you assigned a different object in the setter
-    method, Sequel now disassociates the old object before
-    associating the new object, fixing some potential issues if there
-    is a UNIQUE constraint on the foreign key column.
-    
-  * Using the many_to_one association setter where the reciprocal
-    association is a one_to_one association with a currently
-    different cached associated object no longer raises an exception.
-  
-  * The nested_attributes and association_dependencies plugins
-    both now correctly handle one_to_one associations.
-
-  If you need any help migrating, please post on the Sequel Google
-  Group or ask in the #sequel IRC channel.
-
-* Both many_to_one and one_to_one associations now use before_set
-  and after_set callbacks instead of trying to make the one_to_many
-  and many_to_many associations' (before|after)_(add|remove)
-  callbacks work.
-  
-  This change makes the code simpler, makes writing callbacks easier,
-  and no longer requires Sequel to send a query to the database to
-  get the currently associated object in the many_to_one association
-  setter method (you can still do so manually in a before_set
-  callback if you want to).
-  
-* Dataset#for_update was added as a default dataset method.
-  Previously, it was only supported on PostgreSQL.  It has been
-  tested to work on PostgreSQL, MySQL, SQLite (where it is ignored),
-  H2, and MSSQL.
-  
-* Dataset#lock_style was added as a backbone for Dataset#for_update,
-  but allowing you to specify custom lock styles.  These can either
-  be symbols recognized by the adapters, or strings which are treated
-  as literal SQL.
-
-* Model#lock! was added, which uses Dataset#for_update to lock model
-  rows for specific instances.  Combined with the Dataset#for_update,
-  Sequel now has an equivalent to ActiveRecord's pessimistic locking
-  support.
-
-* A composition plugin was added, given similar functionality as
-  ActiveRecord's composed_of.
-  
-  The composition plugin allows you to easily define getter and
-  setter instance methods for a class where the backing data is
-  composed of other getters and decomposed to other setters.
-
-  A simple example of this is when you have a database table with
-  separate columns for year, month, and day, but where you want to
-  deal with Date objects in your ruby code.  This can be handled
-  with:
-
-    Model.composition :date, :mapping=>[:year, :month, :day]
-
-  The :mapping option is optional, but if not used, you need define
-  custom composition and decomposition procs via the :composer and
-  :decomposer options.
-
-  Note that when using the composition object, you should not modify
-  the underlying columns if you are also instantiating the
-  composition, as otherwise the composition object values will
-  override any underlying columns when the object is saved.
-
-* An rcte_tree plugin was added, which uses recursive common table
-  expressions to load all ancestors and descendants in a single
-  query.  If your database supports recursive common table
-  expressions (PostgreSQL 8.4+, MSSQL 2005+, newer versions of
-  Firebird), using recursive common table expressions to load
-  all ancestors and descendants is significantly faster than storing
-  trees as nested sets and using nested set queries.  Usage:
-  
-    Model.plugin :rcte_tree
-   
-    # Lazy loading
-    model = Model.first
-    model.parent
-    model.children
-    model.ancestors # Populates :parent association as well
-    model.descendants # Populates :children association as well
-   
-    # Eager loading - also populates the :parent and children 
-    # associations for all ancestors and descendants
-    Model.filter(:id=>[1, 2]).eager(:ancestors, :descendants).all
-   
-    # Eager loading children and grandchildren
-    Model.filter(:id=>[1, 2]).eager(:descendants=>2).all
-    # Eager loading children, grandchildren, and great grandchildren
-    Model.filter(:id=>[1, 2]).eager(:descendants=>3).all
-
-* Dataset#first_source_table was added, giving you the unaliased
-  version of the table for the first source.
-
-* Add Sequel::BasicObject.remove_methods!, useful on ruby 1.8 if you
-  require other libraries after Sequel that add methods to Object.
-  For example, if YAML is required after sequel, then the following
-  will raise an error:
-  
-    DB[:a].filter{x > y}
-    
-  because YAML adds the y method to all objects.  Now, you can call
-  Sequel::BasicObject.remove_methods!, which will remove those
-  methods from Sequel::BasicObject, allowing them to be used as
-  intended in the above DSL.
-
-* Sequel associations now accept an :eager_loader_key option, which
-  can be useful for associations to specify the column to use for the
-  key_hash for custom :eager_loaders.
-
-* A JDBC subadapter for the AS400 database was added.
-
-Other Improvements
-------------------
-
-* The one_to_one setter method and the one_to_many and many_to_many
-  remove_all methods now apply the association options (such as
-  filters) on the appropriate dataset:
-  
-    Artist.one_to_many :good_albums, :class=>:Album,
-     :conditions=>{:good=>true}
-    a = Artist[10]
-    a.remove_all_good_albums
-    # Before: WHERE artist_id = 10
-    # After:  WHERE artist_id = 10 AND good IS TRUE
-
-* Plugin loading now works correctly when the plugin module name
-  is the same name as an already defined top level constant.  This
-  means that the active_model plugin should now work correctly if
-  you require active_model before loading the Sequel plugin.
-
-* The nested_attributes plugin now preserves nested attributes for
-  *_to_one associations on validation failures.
-
-* Transactions now work correctly on Oracle when using the JDBC
-  adapter.
-  
-* Dataset#limit once again works correctly on MSSQL 2000.  It was
-  broken in Sequel 3.9.0.
-
-* many_to_one associations now use limit(1) to ensure only one
-  record is returned.  If you don't want this (because maybe you
-  are using the :eager_graph association option), you need to
-  set the :key option to nil and use a custom :dataset option.
-  
-* many_to_one and one_to_many associations now work correctly
-  with the association :eager option to eagerly load associations
-  specified by :eager when lazy loading the association.
-
-* The typecast_on_load plugin now correctly handles
-  reloading/refreshing the object, both explicitly and implicitly
-  on object creation.
-
-* The schema parser and dumper now return tinyint columns as
-  booleans when connecting to mysql using the do adapter, since
-  DataObjects now returns the columns as booleans.
-  
-* The schema dumper now deals better with unusual or database
-  specific primary key types when using the :same_db option.
-
-* On ruby 1.8, Sequel::BasicObject now undefs private methods in
-  addition to public and protected methods.  So the following
-  code now works as expected:
-  
-    DB[:a].filter{x > p} # WHERE x > p
-    
-* Sequel.connect with a block now returns the value of the block:
-
-    max_price = Sequel.connect('sqlite://items.db') do |db|
-      db[:items].max(:price)
-    end
-    
-* MSSQL emulated offset support now works correctly when Sequel's
-  core extensions are not loaded.
-  
-* Sequel::BasicObject now works correctly on rubinius, and almost
-  all Sequel specs now pass on rubinius.
-  
-* The nested_attributes plugin now uses a better exception message
-  no matching associated object is found.
-  
-* Sequel now raises a more informative error if you attempt to use
-  the native sqlite adapter with the sqlite3 gem instead of the
-  sqlite3-ruby gem.
-  
-* Multiple complex expressions with the same operator are now
-  combined for simpler SQL:
-  
-    DB[:a].filter(:a=>1, :b=>2).filter(:c=>3)
-    # Before: (((a = 1) AND (b = 2)) AND (c = 3))
-    # After:  ((a = 1) AND (b = 2) AND (c = 3))
-  
-* The Sequel::Model dataset methods (class methods proxied to the
-  model's dataset) and the Sequel::Dataset mutation methods
-  (methods that have a ! counterpart to modify the object in place)
-  have both been updated to use new dataset methods added in recent
-  versions.
-
-Backwards Compatibility
------------------------
-
-* The :one_to_one option of the one_to_many associations now raises
-  an exception.  Please see the section above about the new real
-  one_to_one association.
-
-* The change to apply the association options to the one_to_many and
-  many_to_many remove_all methods has the potential to break some
-  code that uses the remove_all method on associations that use
-  association options. This is especially true for many_to_many
-  associations, as filters in many_to_many associations will often
-  reference columns in the associated table, while the dataset
-  used in the remove_all method only contains the join table.  Such
-  cases should be handled by manually overriding the _remove_all
-  association instance method in the class.  It was determined that
-  it was better to issue possibly invalid queries than to issue
-  queries that make unexpected modifications.
-
-* Dataset#group_and_count now longer orders the dataset by the count.
-  Since it returns a modified dataset, if you want to order the
-  dataset, just call order on the returned dataset.
-
-* many_to_one associations now require a working :class option.
-  Previously, if you provided a custom :dataset option, a working
-  :class option was not required in some cases.
-
-* The MSSQL shared adapter dataset methods switched from using
-  the :table_options internal option key to using the :lock internal
-  option key.

data/doc/release_notes/3.11.0.txt

@@ -1,254 +0,0 @@
-= New Features
-
-* A few new features were added to query logging.  Sequel now
-  includes execution time when logging queries.  Queries that
-  raise exceptions are now logged at ERROR level.  You can now
-  set the log_warn_duration attribute on the Database instance
-  and queries that take longer than that will be logged at WARN 
-  level.  By using different log levels, you can now only log
-  queries that raise errors, or only log queries that take a long
-  time.
-
-    # The default - Log all successful queries at INFO level
-    DB.log_warn_duration = nil
-
-    # Log all successful queries at WARN level
-    DB.log_warn_duration = 0
-
-    # Log successful queries that take the database more than half a
-    # second at WARN level, other successful queries at INFO level
-    DB.log_warn_duration = 0.5
-
-  All adapters included with Sequel have been modified to support
-  the new logging API.  The previous API is still available, so
-  any external adapters should still work, though switching to the
-  new logging API is encouraged.
-  
-* Sequel::Model now has a require_modification flag.  If not set
-  explicitly, it is enabled by default if the dataset provides an
-  accurate number of rows matched by an update or delete statement.  
-  When this setting is enabled, Sequel will raise an exception if
-  you attempt to update or delete a model object and it doesn't end
-  up affecting exactly one row.  For example:
-
-    DB.create_table(:as){primary_key :id}
-    class A < Sequel::Model; end
-    a = A.create
-
-    # delete object from database
-    a.delete
-
-    a.require_modification = false
-    a.save # no error!
-    a.delete # no error!
-
-    a.require_modification = true
-    a.save # Sequel::NoExistingObject exception raised
-    a.delete # Sequel::NoExistingObject exception raised
-
-  Like many other Sequel::Model settings, this can be set on a
-  global, per class, and per instance level:
-
-    Sequel::Model.require_modification = false # global
-    Album.require_modification = true # class
-    album.require_modification = false # instance
-
-* An instance_filters plugin was added to the list of built in
-  plugins, allowing you to add arbitrary filters when updating or
-  destroying an instance.  This allows you to continue using models
-  when previously you would have had to drop down to using datasets
-  to get the desired behavior:
-
-    class Item < Sequel::Model
-      plugin :instance_filters
-    end
-    
-    # These are two separate objects that represent the same
-    # database row. 
-    i1 = Item.first(:id=>1, :delete_allowed=>false)
-    i2 = Item.first(:id=>1, :delete_allowed=>false)
-    
-    # Add an instance filter to the object. This filter is in effect
-    # until the object is successfully updated or deleted.
-    i1.instance_filter(:delete_allowed=>true)
-    
-    # Attempting to delete the object where the filter doesn't
-    # match any rows raises an error.
-    i1.delete # raises Sequel::Error
-    
-    # The other object that represents the same row has no
-    # instance filters, and can be updated normally.
-    i2.update(:delete_allowed=>true)
-    
-    # Even though the filter is now still in effect, since the
-    # database row has been updated to allow deleting,
-    # delete now works.
-    i1.delete
-
-* An :after_connect database option is now supported.  If provided,
-  the option value should be a proc that takes a single argument.
-  It will be called with the underlying connection object before
-  connection object is added to the connection pool, allowing you
-  to set per connection options in a thread-safe manner.
-
-  This is useful for customizations you want set on every connection
-  that Sequel doesn't already support.  For example, on PostgreSQL
-  if you wanted to set the schema search_path on every connection:
-                  
-    DB = Sequel.postgres('dbname', :after_connect=>(proc do |conn|
-      conn.execute('SET search_path TO schema1,schema2')
-    end))
-
-* A :test database option is now supported.  If set to true, it
-  automatically calls test_connection to make sure a connection can
-  be made before returning a Database instance.  For backwards
-  compatibility reasons, this is not set to true by default, but it
-  is possible that the default will change in a future version of
-  Sequel.
-
-* The Dataset#select_append method was added, which always appends
-  to the existing selected columns.  It operates identically to
-  select_more, except in the case that no columns are currently
-  selected:
-
-    ds = DB[:a]
-    # SELECT * FROM items
-    ds.select_more({:id=>DB[:b].select(:a_id)}.as(:in_b))
-    # SELECT id IN (SELECT a_id FROM b) AS in_b FROM a
-    ds.select_append({:id=>DB[:b].select(:a_id)}.as(:in_b))
-    # SELECT *, id IN (SELECT a_id FROM b) AS in_b FROM a
-
-* The Dataset#provides_accurate_rows_matched? method was added which
-  allows you to see if the dataset will return the actual number of
-  rows matched/affected by an update or delete call.
-
-* Sequel will now emulate DISTINCT ON support using GROUP BY on
-  MySQL.  On MySQL, GROUP BY is similar to DISTINCT ON, except that
-  the order of returned rows is not deterministic.
-
-* Support for connecting to Microsoft SQL Server using the JTDS JDBC
-  driver was added to the jdbc adapter.
-
-* JDNI connection strings are now supported in the JDBC adapter.
-
-* The JDBC adapter should now work in situations where driver
-  auto-loading has problems, just as when using Tomcat or Trinidad.
-
-* Sequel's JDBC adapter schema parsing now supports a :scale option,
-  useful for numeric/decimal columns.
-
-* Sequel's schema parsing on Microsoft SQL Server now supports
-  :column_size and :scale options.
-
-* When connecting to SQLite, a Database#sqlite_version method is
-  available that gives you the SQLite version as an integer (e.g.
-  30613 for 3.6.13).
-
-= Other Improvements
-
-* Sequel no longer raises an error if you give Dataset#filter or
-  related method an empty argument such as {}, [], or ''. This allows
-  code such as the following to work:
-
-    h = {}
-    h[:name] = name if name
-    h[:number] = number if number
-    ds = ds.filter(h)
-    
-  Before, this would raise an error if both name and number were
-  nil. 
-
-* Numeric and decimal columns with a 0 scale are now treated as
-  integer columns by the model typecasting code, since such columns
-  cannot store non-integer values.
-
-* Calling Database#disconnect when using the single threaded
-  connection pool no longer raises an error if there is no current
-  connection.
-
-* When using the :ignore_index_errors options to
-  Database#create_table, correctly swallow errors raised by Sequel
-  due to the adapter not supporting the given index type.
-  
-* The JDBC adapter no longer leaks ResultSets when retrieving
-  metadata.
-
-* You can now connect to PostgreSQL when using ruby 1.9 with the
-  -Ku switch.
-
-* When using the native MySQL adapter, only tinyint(1) columns are
-  now returned as booleans when using the convert_tinyint_to_bool
-  setting (the default).  Previously, all tinyint columns would
-  be converted to booleans if the setting was enabled.
-
-* Correctly handle inserts returning the autogenerated keys when
-  using MySQL JDBC Driver version 5.1.12 with the jdbc adapter.
-
-* The native MySQL adapter now supports :config_default_group and
-  :config_local_infile options.
-
-* When connecting to SQLite, you can provide the :auto_vacuum,
-  :foreign_keys, :synchronous, and :temp_store options for
-  making the appropriate PRAGMA setting on the database in a
-  thread-safe manner.  The previous thread-unsafe PRAGMA setting
-  methods are available, but their use is discouraged.
-
-* Sequel will not enable savepoints when connecting to SQLite
-  unless the version is 3.6.8 or greater.
-
-* Using limit with distinct now works correctly on Microsoft SQL
-  Server.
-  
-* Database#rename_table now works correctly on Microsoft SQL Server.
-
-* If you specify an explicit :provider when using the ADO adapter,
-  transactions will now work correctly.  The default :provider uses
-  a new native connection for each query, so it cannot work with
-  transactions, or things like temporary tables.
-
-* If you specify an explicit :provider when connecting to Microsoft
-  SQL Server using the ADO adapter (e.g. SQLNCLI10 or SQLNCLI),
-  Sequel is now able to provide an accurate number of rows modified
-  and deleted.
-
-* Using set_column_allow_null with a decimal column with a precision
-  and scale now works correctly when connecting to Microsoft SQL
-  Server.
-
-* You can now connect to Microsoft SQL Server using the dbi adapter.
-
-* Sequel now recognizes the NUMBER database type as a synonym for
-  NUMERIC and DECIMAL, which may help some Oracle users.
-
-* Transactions can now be rolled back correctly when connecting to
-  Oracle via JDBC.
-
-* The active_model plugin now supports ActiveModel 3.0.0beta2.
-
-* Many documentation improvements were made, including the addition
-  of a dataset basics guide, an association basics guide, an expanded
-  virtual row guide, and the separation of the Sequel::Dataset RDoc
-  page into sections.  Additional, the RDoc class/method
-  documentation now contains links to the appropriate guides.
-
-= Backwards Compatibility
-
-* When connecting to SQLite, Sequel now automatically sets the
-  foreign_keys PRAGMA to true, which will make SQLite 3.6.19+ use
-  database enforced foreign key constraints.  If you do not want
-  the database to enforce the foreign key constraints, you should
-  use the :foreign_keys=>false option when connecting to the
-  database.
-
-* Sequel no longer creates #{plugin_name}_opts class, instance, and
-  dataset methods for each plugin loaded.  No built-in plugin used
-  them, and I couldn't find an external plugin that did either.
-
-* The Model#associations method is no longer available if the 
-  default Associations plugin is not loaded due to the 
-  SEQUEL_NO_ASSOCIATIONS constant or environment variable being set.
-
-* DISTINCT ON support is turned off by default, and only enabled when
-  using PostgreSQL, since that appears to be the only database that
-  supports it.  Previously, it was enabled by default and most common
-  adapters turned it off.