sequel 4.26.0 → 5.37.0

data/doc/release_notes/3.8.0.txt

@@ -1,151 +0,0 @@
-New Features
-------------
-
-* Dataset#each_server was added, allowing you to run the same query
-  (most likely insert/update/delete) on all shards.  This is useful
-  if you have a sharded database but have lookup tables that should
-  be identical on all shards.  It works by yielding copies of the
-  current dataset that are tied to each server/shard:
-  
-    DB[:table].filter(:id=>1).each_server do |ds|
-      ds.update(:name=>'foo')
-    end
-
-* Database#each_server was added, allowing you to run schema
-  modification methods on all shards.  It works by yielding a
-  new Sequel::Database object for each shard, that will connect to
-  only that shard:
-  
-    DB.each_server do |db|
-      db.create_table(:t){Integer :num}
-    end
-    
-* You can now add and remove servers/shards from the connection
-  pool while Sequel is running:
-  
-    DB.add_servers(:shard1=>{:host=>'s1'}, :shard2=>{:host=>'s2'})
-    DB.remove_servers(:shard1, :shard2)
-    
-* When you attempt to disconnect from a server that has connections
-  currently in use, Sequel will now schedule those connections to
-  be disconnected when they are returned to the pool.  Previously,
-  Sequel disconnected available connections, but ignored connections
-  currently in use, so it wasn't possible to guarantee complete
-  disconnection from the server.  Even with this new feature, you can
-  only guarantee eventual disconnection, since disconnection of
-  connections in use happens asynchronously.
-  
-* Database#disconnect now accepts a :servers option specifying the
-  server(s) from which to disconnect.  This should be a symbol or
-  array of symbols representing servers/shards.  Only those specified
-  will be disconnected:
-  
-    DB.disconnect(:servers=>[:shard1, :shard2])
-
-* A validates_type validation was added to the validation_helpers
-  plugin.  It allows you to check that a given column contains
-  the correct type.  I can be helpful if you are also using the
-  serialization plugin to store serialized ruby objects, by making
-  sure that the objects are of the correct type (e.g. Hash):
-  
-    def validate
-      validates_type(Hash, :options)
-    end
-
-* Sequel::SQL::Expression#== is now supported for all expressions:
-
-    :column.qualify(:table).cast(:type) == \
-      :column.qualify(:table).cast(:type)
-    # => true
-    :column.qualify(:table).cast(:type) == \
-      :other_column.qualify(:table).cast(:type)
-    # => false
-
-* When using the generic File type to create blob columns on
-  MySQL, you can specify the specific database type by using the
-  :size option (with :tiny, :medium, and :long values recognized):
-  
-    DB.create_table(:docs){File :body, :size=>:long} # longblob
-
-* The mysql adapter will now default to using mysqlplus, falling
-  back to use mysql.  mysqlplus is significantly better for threaded
-  code because queries do not block the entire interpreter.
-
-* The JDBC adapter is now able to detect certain types of disconnect
-  errors.
-  
-* ConnectionPool.servers and Database.servers were added, which
-  return an array of symbols specifying the servers/shards in use.
-
-Other Improvements
-------------------
-
-* The single-threaded connection pool now raises
-  DatabaseConnectionErrors if unable to connect, so it now operates
-  more similarly to the default connection pool.
-
-* The single-threaded connection pool now operates more similar
-  to the default connection pool when given a nonexistent server.
-
-* PGErrors are now correctly converted to DatabaseErrors in the
-  postgres adapter when preparing statements or executing prepared
-  statements.
-  
-* DatabaseDisconnectErrors are now raised correctly in the postgres
-  adapter if the connection status is not OK after a query raises an
-  error.
-
-* In the mysql adapter, multiple statements in a single query should
-  now be handled correctly in the all cases, not just when using
-  Dataset#each.  So you can now submit multiple queries in a single
-  string to Database#run.
-
-* Model object creation on Microsoft SQL Server 2000 once again
-  works correctly.  Previously, an optimization was used that was
-  only supported on 2005+.
-
-* Backslashes are no longer doubled inside string literals when
-  connecting to Microsoft SQL Server.
-  
-* The ORDER clause now correctly comes after the HAVING clause on
-  Microsoft SQL Server.
-  
-* Sequel now checks that there is an active transaction before
-  rolling back transactions on Microsoft SQL Server, since
-  there are cases where Microsoft SQL Server will roll back
-  transactions implicitly.
-  
-* Blobs are now handled correctly when connecting to H2.
-
-* 64-bit integers are now handled correctly in JDBC prepared
-  statements.
-
-* In the boolean_readers plugin, correctly handle columns not in
-  the db_schema, and don't raise an error if the model's columns
-  can't be determined.
-  
-* In the identity_map plugin, remove instances from the cache if they
-  are deleted or destroyed.
-
-Backwards Compatibility
------------------------
-
-* Dataset::FROM_SELF_KEEP_OPTS was merged into
-  Dataset::NON_SQL_OPTIONS.  While used in different places, they
-  were used for the same purpose, and entries missing from one should
-  have been included in the other.
-
-* The connection pool internals changed substantially.  Now,
-  ConnectionPool #allocated and #available_connections will return
-  nil instead of an array or hash if they are called with a
-  nonexistent server.  These are generally only used internally,
-  though they are part of the public API.  #created_count and #size
-  still return the size of the :default server when called with a
-  nonexistent server, though.
-
-* The meta_eval and metaclass private methods were removed from
-  Sequel::MetaProgramming (only the meta_def public method remains).
-  If you want these methods, use the metaid gem.
-
-* The irregular ox->oxen pluralization rule was removed from the
-  default inflections, as it screws up the more common box->boxes.

data/doc/release_notes/3.9.0.txt

@@ -1,233 +0,0 @@
-New Features
-------------
-
-* The ConnectionPool classes were refactored from 2 separate
-  classes to a 5 class hierarchy, with one main class and 4 
-  subclasses, one for each combination of sharding and threading.
-  
-  The primary reason for this refactoring is to make it so that
-  the user doesn't have to pay a performance penalty for sharding
-  if they aren't using it.  A connection pool that supports sharding
-  is automatically used if the :servers option is used when setting
-  up the database connection.
-  
-  In addition, the default connection pool no longer contains
-  the code to schedule future disconnections of currently allocated
-  connections.  The sharded connection pool must be used if that
-  feature is desired.
-  
-  The unsharded connection pools are about 25-30% faster than the
-  sharded versions.
-
-* An optimistic_locking plugin was added to Sequel::Model.  This
-  plugin implements a simple database-independent locking mechanism
-  to ensure that concurrent updates do not override changes:
-
-    class Person < Sequel::Model
-      plugin :optimistic_locking
-    end
-    p1 = Person[1]
-    p2 = Person[1]
-    # works
-    p1.update(:name=>'Jim')
-    # raises Sequel::Plugins::OptimisticLocking::Error
-    p2.update(:name=>'Bob')
-
-  In order for this plugin to work, you need to make sure that the
-  database table has a lock_version column (or other column you name
-  via the lock_column class level accessor) that defaults to 0.
-
-  The optimistic_locking plugin does not work with the
-  class_table_inheritance plugin.
-
-* Dataset#unused_table_alias was added, which takes a symbol and
-  returns either that symbol or a new symbol which can be used as
-  a table alias when joining a table to the dataset.  The symbol
-  returned is guaranteed to not already be used by the dataset:
-
-    DB[:test].unused_table_alias(:blah) # => :blah
-    DB[:test].unused_table_alias(:test) # => :test_0
-    
-  The use case is when you need to join a table to a dataset, where
-  the table may already be used inside the dataset, and you want
-  to generate a unique alias:
-  
-    ds.join(:table.as(ds.unused_table_alias(:table)), ...)
-    
-* The Sequel::ValidationFailed exception now has an errors accessor
-  which returns the Sequel::Model::Errors instance with the
-  validation errors.  This can be helpful in situations where a
-  generalized rescue is done where the model object reference is
-  not available.
-
-* bin/sequel now works without an argument, which is useful for
-  testing SQL generation (and not much else).
-
-* Support SELECT ... INTO in the MSSQL adapter, using Dataset#into,
-  which takes a table argument.
-  
-* You can now provide your own connection pool class via the
-  :pool_class option when instantiating the database.
-
-Other Improvements
-------------------
-
-* IN/NOT IN constructs with an empty array are now handled properly.
-  
-    DB[:table].filter(:id=>[]) # IN
-    DB[:table].exclude(:id=>[]) # NOT IN
-    
-  Before, the IN construct would mostly work, other than some minor
-  differences in NULL semantics.  However, the NOT IN construct
-  would not work.  Sequel now handles the NOT IN case using an
-  expression that evaluates to true.
-  
-* If using an IN/NOT IN construct with multiple columns and a dataset
-  argument, where multiple column IN/NOT IN support is emulated, a
-  separate query is done to get the records, which is then handled
-  like an array of values.  This means that the following type of
-  query now works on all tested databases:
-  
-    DB[:table1].filter([:id1, :id2]=>DB[:table2].select(:id1, :id2))
-
-* Schemas and aliases are now handled correctly when eager graphing.
-
-* Implicitly qualified symbols are now handled correctly in update
-  statements, useful if you are updating a joined dataset and need
-  to reference a column that appears in multiple tables.
-
-* The active_model plugin has been brought up to date with
-  activemodel 3.0 beta (though it doesn't work on edge).
-  Additionally, the active_model plugin now requires active_model
-  in order to use ActiveModel::Naming.
-
-* In the schema_dumper extension, always include the varchar limit,
-  even if it is 255 columns (the default).  This makes it so that
-  PostgreSQL will use a varchar(255) column instead of a text column
-  when restoring a schema dump of a varchar(255) column from another
-  database.
-  
-* You can now load adapters from outside the Sequel lib directory,
-  now they just need to be in a sequel/adapters directory somewhere
-  in the LOAD_PATH.
-
-* You can now load extensions from outside the Sequel lib directory
-  using Sequel.extension.  External extensions need to be in a
-  sequel/extensions directory somewhere in the LOAD_PATH.
-
-* Using bound variables for limit and offset in prepared statements
-  now works correctly.
-
-* Performance of prepared statements was improved in the native
-  SQLite adapter.
-  
-* The schema_dumper extension now passes the options hash from
-  dump_*_migration to Database#tables.
-
-* In the single_table_inheritance plugin, qualify the sti_key column
-  with the table name, so that subclass datasets can safely be joined
-  to other tables having the same column name.
-
-* In the single_table_inheritance plugin, handle case where the
-  sti_key value is nil or '' specially, so that those cases
-  always return an instance of the main model class.  This fixes
-  issues if constantize(nil) returns Object instead of raising
-  an exception.
-  
-* No longer use Date#to_s for literalization, always use ISO8601
-  format for dates.
-  
-* A couple lambdas which were instance_evaled were changed to procs
-  for ruby 1.9.2 compatibility.
-  
-* MSSQL emulated offset support was simplified to only use one
-  subquery, and made to work correctly on ruby 1.9.
-  
-* Emulate multiple column IN/NOT IN on H2, since it doesn't handle
-  all cases correctly.
-  
-* ODBC timestamps are now handled correctly if the database_timezone
-  is nil.
-  
-* ArgumentErrors raised when running queries in the ODBC adapter are
-  now raised as DatabaseErrors.
-  
-* Attempting to use DISTINCT ON on SQLite now raises an error before
-  sending the query to the database.
-  
-* The options hash passed to the database connection method is no
-  longer modified.  However, there may be additional options
-  present in Database#opts that weren't specified by the options
-  hash passed to the database connection method.
-  
-* Make Dataset#add_graph_aliases handle the case where the dataset
-  has not yet been graphed.
-
-* You can now provide an SQL::Identifier as a 4th argument to
-  Dataset#join_table, and unsupported arguments are caught and an
-  exception is raised.
-  
-* The gem specification has been moved out of the Rakefile, so
-  that the gem can now be built without rake, and works well with
-  gem build and bundler.
-  
-* The Rakefile no longer assumes the current directory is in the
-  $LOAD_PATH, so it should work correctly on ruby 1.9.2.
-
-* All internal uses of require are now thread safe.
-
-* Empty query parameter keys in connection strings are now ignored
-  instead of raising an exception.
-  
-* The specs were changed so that you can run them in parallel.
-  Previously there was a race condition in the migration extension
-  specs.
-
-Backwards Compatibility
------------------------
-
-* If you plan on using sharding at any point, you now must pass
-  a :servers option when connecting to the database, even if it is
-  an empty hash.  You can no longer just call Database#add_servers
-  later.
-
-* The connection_proc and disconnection_proc accessors were removed
-  from the connection pools, so you can no longer modify the procs
-  after the connection pool has been instantiated.  You must now
-  provide the connection_proc as the block argument when
-  instantiating the pool, and the disconnection_proc via the
-  :disconnection_proc option.
-
-* In the hash passed to Dataset#update, symbol keys with a double
-  embedded underscore are now considerated as implicit qualifiers,
-  instead of being used verbatim.  If you have a column that includes
-  a double underscore, you now need to wrap it in an SQL::Identifier
-  or use a String instead.
-  
-* The connection pools no longer convert non-StandardError based
-  exceptions to RuntimeErrors.  Previously, all of the common adapters
-  turned this feature off, so there is no change for most users.
-
-* Sequel::ConnectionPool is now considered an abstract class and
-  should not be instantiated directly.  Use ConnectionPool.get_pool
-  to return an instance of the appropriate subclass.
-
-* The Sequel::SingleThreadedPool constant is no longer defined.
-
-* The private Dataset#eager_unique_table_alias method was removed,
-  use the new public Dataset#unused_table_alias method instead, which
-  has a slightly different API.
-
-* The private Dataset#eager_graph_qualify_order method was removed,
-  used Dataset#qualified_expression instead.
-  
-* The private Sequel::Model class methods plugin_gem_location and
-  plugin_gem_location_old have been removed.
-  
-* Gems built with the rake tasks now show up in the root directory
-  instead of the pkg subdirectory, and no tarball package is created.
-
-Other News
-----------
-
-* Sequel now has an official blog at http://sequel.jeremyevans.net/blog.html.

data/doc/release_notes/4.0.0.txt

@@ -1,262 +0,0 @@
-= Backwards Compatibility
-
-* All behavior resulting in deprecation messages in 3.48.0 has been
-  removed or modified.  If you plan on upgrading to Sequel 4.0.0 and
-  have not yet upgraded to 3.48.0, upgrade to 3.48.0 first, fix code
-  that results in deprecation warnings, and then upgrade to 4.0.0.
-
-* The threaded connection pools now default to
-  :connection_handling=>:queue.  You can manually set
-  :connection_handling=>:stack to get the previous behavior.
-
-* Model.raise_on_typecast_failure now defaults to false.  Set this to
-  true to get the previous behavior of raising typecast errors in the
-  setter methods.
-
-* Model#save no longer calls Model#_refresh or Model#set_values
-  internally after an insert.  Manual refreshes are now treated
-  differently than after creation refreshes.
-
-* On SQLite, integer_booleans now defaults to true.  Set this to
-  false to get the previous behavior of 't' for true and 'f' for
-  false.  Sequel will not automatically upgrade your data, users
-  are responsible for doing that if they want to switch the
-  integer_booleans setting.  Note that regardless of the setting,
-  Sequel will return the correct ruby values when retrieving the
-  rows.
-
-  Example Code to Migrate Existing Data:
-
-    DB[:table].where(:column=>'t').update(:column=>1)
-    DB[:table].where(:column=>'f').update(:column=>0)
-
-* On SQLite, use_timestamp_timezones is now false by default.  Set
-  this to true to get the previous behavior with timezone information
-  in timestamps. Sequel will not automatically upgrade your data,
-  users are responsible for doing that if they want to switch the
-  use_timestamp_timezones setting.  Note that regardless of the
-  setting, Sequel will return the correct ruby values when
-  retrieving the rows.
-
-* Using window functions when eagerly loading associations with
-  limits or offsets is now done automatically if the database
-  supports it.  Previously, this had to be enabled manually.  If
-  you would like to disable this optimization and just do the
-  slicing in ruby, set default_eager_limit_strategy = nil.
-
-* The default value for most option hash arguments is now an shared
-  empty frozen hash.  If you are overriding methods and modifying
-  option hashes, fix your code.
-
-* The defaults_setter plugin now works in a lazy manner instead of
-  an eager manner.  So calling the related method returns the
-  default value if there is no value stored, but Sequel does not
-  add the default values to the internal values hash, and will not
-  attempt to insert what it thinks is the default value when
-  saving the new object.
-
-* Model#set_all and #update_all now allow setting the primary key
-  columns.
-
-* The many_to_one_pk_lookup and association_autoreloading plugins
-  are now integrated into the default associations support.
-
-* Plugins now extend the class with ClassMethods before including
-  InstanceMethods in the class.
-
-* Dataset#get, #select_map, and #select_order_map now automatically
-  add aliases for unaliased expressions if given a single expression.
-
-* Database#tables and #views on PostgreSQL now check against
-  the current schemas in the search path.
-
-* Calling ungraphed on an eager_graph dataset will restore the
-  row_proc for that dataset.  This is not backwards compatible if
-  your method chain does:
-
-    dataset.eager_graph.naked.ungraphed
-
-  Switch such code to:
-
-    dataset.eager_graph.ungraphed.naked
-
-* The Model#set_restricted and #update_restricted private methods
-  have a slightly different API now.
-
-* Sequel::SQL::SQLArray alias for ValueList has been removed.
-
-* Sequel::SQL::NoBooleanInputMethods has been removed.
-
-* Sequel::NotImplemented has been removed.  Default implementations
-  of methods that used to raise this exception have been removed.
-
-* Sequel::Model::EMPTY_INSTANCE_VARIABLES has been removed.
-
-* The Sequel::Postgres::DatabaseMethods::EXCLUDE_SCHEMAS and
-  SYSTEM_TABLE_REGEXP constants have been removed.
-
-* Dataset#columns_without_introspection has been removed from the
-  columns_introspection extension.
-
-* Sequel no longer provides a default database for the adapter or
-  integration specs.  Additionally, if you are using spec_config.rb
-  to configure a database to use when adapter/integration testing,
-  you may need to modify it, as Sequel now uses the DB constant for
-  the database being tested.
-
-* The SEQUEL_MSSQL_SPEC_REQUIRE and SEQUEL_DB2_SPEC_REQUIRE
-  environment variables are no longer respected when
-  adapter/integration testing those databases.  Use RUBYOPT with the
-  -r flag.
-
-* In the 3.48.0 release notes, it was announced that
-  Dataset#join_table would default to :qualify=>:deep in 4.0.0.  This
-  change was made but reverted before the release of 4.0.0 as it was
-  determined too likely to break existing code, there was no
-  deprecation warning (since it just changed a setting), and the
-  benefit was minimal. You can make deep qualification the default by
-  by overriding Dataset#default_join_table_qualification.
-
-= New Features
-
-* A pg_array_associations plugin has been added, for creating
-  an association based on a PostgreSQL array column containing
-  foreign keys.  Example:
-
-    # Database schema:
-    #   tags                albums
-    #   :id (int4) <--\    :id
-    #   :name          \-- :tag_ids (int4[])
-    #                      :name
-
-    class Album
-      plugin :pg_array_associations
-      pg_array_to_many :tags
-    end
-    class Tag
-      plugin :pg_array_associations
-      many_to_pg_array :albums
-    end
-
-  This operates similarly to a many_to_many association, but does not
-  require a join table.  All of the usual Sequel association features
-  are supported, such as adding, removing, and clearing associations,
-  eager loading via eager and eager_graph, filtering by associations,
-  and dataset associations.
-
-  Note that until PostgreSQL gains the ability to enforce foreign key
-  constraints in array columns, this plugin is not recommended for
-  production use unless you plan on emulating referential integrity
-  constraints via triggers.
-  
-* Dataset#from now accepts virtual_row blocks, making it easy to use
-  with table returning functions:
-
-    DB.from{table_returning_function(arg)}
-
-* Sequel.deep_qualify has been added, for easily doing a deep
-  qualification of objects:
-
-    Sequel.deep_qualify(:table, Sequel.+(:column, 1))
-    # ("table"."column" + 1)
-    Sequel.deep_qualify(:table, Sequel.like(:a, 'b'))
-    # ("table"."a" LIKE 'b' ESCAPE '\')
-    
-* The prepared_statements_associations plugin now handles one_to_one
-  associations.
-
-* SQL::Subscript objects now handle ruby range arguments, operating as
-  an SQL array slice:
-
-    Sequel.subscript(:a, 1..2) # a[1:2]
-
-* Database#create_view now accepts a :columns option to provide
-  explicit column names for the view.
-
-* Postgres::ArrayOp#[] now returns an ArrayOp if given a range, since
-  a PostgreSQL array slice can be treated as an array.
-
-* Postgres::ArrayOp#hstore has been added for creating hstores from
-  PostgreSQL arrays.
-
-* When creating full text indexes on PostgreSQL, the :index_type=>:gist
-  option can be used to use a gist index instead of the default gin
-  index.  This can be useful if insert/update speed is more important
-  than lookup speed.
-
-* You can now provide the :owner option to Database#create_schema on
-  PostgreSQL to specify the owner of the schema.
-
-* You can now provide the :if_exists option to Database#drop_view
-  on PostgreSQL to not raise an error if the view doesn't exist.
-
-* The pg_json extension now handles non-JSON plain strings, integers
-  and floats in PostgreSQL JSON columns.
-
-= Support for New Features in PostgreSQL 9.3
-
-* A pg_json_ops extension has been added to support the new json
-  operators and functions.
-
-* Postgres::ArrayOp#replace and #remove have been added for using the
-  array_replace and array_remove functions.
-
-* You can now provide the :if_not_exists option when using
-  Database#create_schema on PostgreSQL to not raise an error if the
-  schema already exists.
-
-* Database#create_view now supports a :recursive option on PostgreSQL
-  for creating recursive views.
-
-* Database#create_view and #drop_view now support a :materialized option
-  on PostgreSQL for creating/dropping materialized views.
-
-* Database#refresh_view has been added on PostgreSQL for refreshing
-  materialized views.
-
-= Other Improvements
-
-* Check constraints are now always surrounded by parantheses, since that
-  is required by the SQL standard.  This fixes issues in the cases where
-  parentheses were not used automatically, such as when a function call
-  was used.
-
-* Using an offset without a limit when eager loading now works
-  correctly.
-
-* The prepared_statements_associations plugin now works correctly when
-  the associated class uses a filtered dataset.
-
-* The prepared_statements_associations plugin can now use a prepared
-  statement for cases where the association uses :conditions.
-
-* Boolean prepared statement arguments now work correctly in the sqlite
-  adapter when the integer_booleans setting is true.
-
-* Dataset#inspect on prepared statements now handles anonymous dataset
-  classes correctly.
-
-* When dataset string/blob literalization depends on having a database
-  connection and the dataset has an assigned server, a connection to
-  the assigned server is used.
-
-* More disconnect errors are now handled when using the postgres
-  adapter with the postgres-pr driver, and in the jdbc/oracle adapter.
-
-* Composite primary keys are now parsed correctly on SQLite 3.7.16+.
-
-* Blobs are now hex escaped on MySQL, which can solve some encoding
-  issues when blobs are used as literals in the same SQL query with
-  UTF-8 strings.
-
-* BigDecimals instances are now formatted nicer in the pretty_table
-  extension.
-
-* Sequel now raises an exception when attempting to literalize infinite
-  and NaN floats on MySQL.  In general, this would result in MySQL
-  raising an error, but in extreme cases it could have failed silently.
-
-* You can now use a NO_SEQUEL_PG environment variable to not
-  automatically require sequel_pg in the postgres adapter.
-
-* Dataset#unbind now always uses symbol keys in the bind variable hash.