sequel 4.36.0 → 5.61.0

data/doc/release_notes/3.39.0.txt

@@ -1,237 +0,0 @@
-= New Features
-
-* A constraint_validations extension and plugin have been added,
-  which allow you to define validations when creating tables,
-  which are enforced by database constraints, and have those
-  validations be automatically discovered and used by your
-  Sequel::Model classes.
-
-  The extension is designed to be used in your migrations/schema
-  modification code:
-
-    DB.extension(:constraint_validations)
-    DB.create_constraint_validations_table
-    DB.create_table(:foos) do
-      primary_key :id
-      String :name
-
-      validate do
-        min_length 5, :name
-      end
-    end
-
-  This creates a database CHECK constraint that ensures that the
-  minimum length for the column is 5 characters.  It also adds
-  metadata about the validation to the
-  sequel_constraint_validations table.
-
-  To have the model class automatically create validations, just
-  include the plugin in the model:
-
-    class Foo < Sequel::Model
-      plugin :constraint_validations
-    end
-
-  Note that MySQL does not enforce CHECK constraints (it parses
-  but ignores them), so using the extension on MySQL does not
-  actually enforce constraints at the database level, though it
-  still does support the automatic model validations if the plugin
-  is used.
-
-* Dataset#count now takes an argument or a virtual row block,
-  allowing you to do:
-
-    DB[:table].count(:column_name)
-    DB[:table].count{function_name(column1, column2)}
-
-  When count is given an argument, instead of returning the total
-  number of rows, it returns the number of rows where the
-  argument has a non-NULL value.
-
-* Database#copy_into has been added to the postgres adapter when
-  the pg driver is being used, and can be used for very fast
-  inserts into tables if you already have the input preformatted
-  in PostgreSQL text or CSV format.
-
-* set_table_not_null has been added to the alter table generator,
-  for a nicer API:
-
-    alter_table(:t){set_column_not_null :col}
-    # instead of
-    alter_table(:t){set_column_allow_null :col, false}
-
-  Additionally, set_column_allow_null now defaults the second
-  argument to true for a nicer API:
-
-    alter_table(:t){set_column_allow_null :col}
-    # instead of
-    alter_table(:t){set_column_allow_null :col, true}
-
-* Database#supports_regexp? has been added for checking if the
-  database supports Regexp in filters.  Currently, only MySQL and
-  PostgreSQL support Regexps.
-
-  Attempting to use a Regexp on a database that doesn't support it
-  now raises an error when attempting to generate the SQL, instead
-  of sending invalid SQL to the database.
-
-* Sequel.char_length has been added for a cross platform
-  char_length function (emulated when char_length is not supported
-  natively by the database).
-
-* Sequel.trim has been added for a cross platform trim function
-  (emulated when trim is not supported natively by the database).
-
-* ValidationFailed and HookFailed exceptions now have a model method
-  that returns the model instance related to the exception.  This
-  makes it possible to use Model.create inside a begin/rescue block
-  and get access to the underlying instance if there is a validation
-  or before/around hook error.
-
-* The subclasses plugin now accepts a block, which is called with
-  each model class created.  This is useful if you want to apply
-  changes to classes created in the future instead of just existing
-  classes.
-
-* The validates_unique validation in the validation_helpers plugin
-  now accepts a :where option for a custom uniqueness filter.  Among
-  other things this makes it easy to implement a case insensitive
-  uniqueness validation on a case sensitive column.
-
-* The threaded connection pools now support a
-  :connection_handling=>:disconnect option, which makes them disconnect
-  connections after use instead of returning them to the pool.  This
-  makes it possible to completely control connection lifetime using
-  Database#synchronize.
-
-* The pg_row_op extension now has support for PGRowOp#*, for referencing
-  the members of the composite type as separate columns.
-
-* MySQL's set type and default value are now recognized.
-
-* bin/sequel now accepts a -c argument for running an arbitrary
-  code string instead of using an IRB prompt.
-
-= Other Improvements
-
-* Sequel now parses current date/timestamp column defaults when
-  parsing the schema for a table.  The values will be returned
-  as Sequel::CURRENT_DATE for date columns and
-  Sequel::CURRENT_TIMESTAMP for timestamp columns.
-
-  The schema_dumper extension will work with these defaults, so
-  if you dump the schema for a table with a column that uses
-  a current timestamp default, the dumped schema will include
-  the default.
-
-  The defaults setter plugin also works with these changes, so
-  that when new model objects are instantiated, they get the
-  current Date/Time/DateTime values set.
-
-* On MySQL and PostgreSQL, Sequel will now by default attempt
-  to combine multiple alter_table operations into a single
-  query where it believes it can do so correctly.  This can
-  potentially improve performance ~N times, where N is the number
-  of alter table operations.
-
-  This can change the SQL used for old migrations (though it
-  shouldn't change the result), and is a potentially risky
-  change.  This may be disabled by default in future versions
-  if it causes problems.
-
-* The defaults_setter plugin now correctly sets false default
-  values.
-
-* The schema_dumper plugin now preserves fractional seconds
-  in timestamp column defaults when dumping.
-
-* Time->DateTime and DateTime->Time typecasts now retain
-  fractional seconds on ruby 1.8.
-
-* Array arguments passed to most PGArrayOp methods are now
-  automatically wrapped in a PGArray.  If you want to use this
-  support, you need to make sure to load both the pg_array
-  and pg_array_op extensions.
-
-* Sequel now does a better job of finding the sequence for a
-  given table on PostgreSQL, handling more corner cases.  A small
-  side effect of this is sometimes sequence names will be quoted.
-
-* Some potential thread-safety issues when using Sequel with
-  PostgreSQL on a non-GVL ruby implementation have been fixed.
-
-* Sequel now correctly caches the server version query on MySQL.
-
-* Sets of alter_table operations on MySQL and Microsoft SQL Server
-  that require parsing the current database schema, where later
-  alter_table operations depend on earlier ones, should now work
-  correctly.
-
-* You can now drop check constraints on tables on SQLite, though
-  doing so drops all check constraints on the table, not only the
-  specific check constraint given.
-
-* The identity_map plugin no longer breaks if used with a model
-  without a primary key.
-
-* Sequel::SQL::NegativeBooleanConstant now inherits from Constant
-  instead of BooleanConstant.  This means that
-
-    Sequel::NULL == Sequel::NOTNULL
-
-  is now false instead of true.
-
-* You can now override the convert_tinyint_to_bool settings on a
-  per-Dataset basis in the mysql and mysql2 adapters, though
-  the overriding is different depending on the adapter.  Check the
-  commit log for details.
-
-* timestamp(N) types are now recognized as datetime, which should
-  fix certain cases on Oracle.
-
-* Dataset#insert now handles a single model instance argument
-  as a single value if the model uses the pg_row plugin.
-
-* When joining a model dataset using a model class as the table
-  argument, a subselect is used unless the model is a simple select
-  from the underlying table.
-
-* The specs now cleanup after themselves, dropping the tables that
-  they create for testing.
-
-= Backwards Compatibility
-
-* The defaults_setter plugin's behavior changed due to the 
-  current date/timestamp support.  Previously, it would not set
-  a value for the column, since the default wasn't recognized.
-  Therefore, the database would use the default value on insert,
-  which would be the database's current timestamp.
-
-  Now, the value is set to the current Date/Time/DateTime on
-  model object instantiation, so the database wouldn't use the
-  column default.  Instead of the database's current timestamp
-  on insert, the column value will be the application's
-  current timestamp on model instantiation.
-
-  Users who don't want this behavior can remove the default values
-  in the model:
-
-    Model.default_values.delete(:column_name)
-
-* Plain (non-model) datasets no longer allow insert to accept
-  a single model instance argument.  Also, they no longer call
-  values on a single argument if the object responds to it.
-
-* Plain (non-model) datasets no longer accept model classes as
-  tables in the join/graph methods.  Also, they no longer call
-  table_name on the argument if the object responds to it.
-
-* The schema_dumper extension now requires the eval_inspect
-  extension, which changes inspect output for
-  Sequel::SQL::Expression objects.
-
-* Custom adapters that override Database#alter_table_sql_list now
-  need to make sure it returns an already flattened array.
-
-* The identity_map_key method in the identity_map plugin now returns
-  nil instead of a random string if the given pk is nil.

data/doc/release_notes/3.4.0.txt

@@ -1,325 +0,0 @@
-New Plugins
------------
-
-* A nested_attributes plugin was added allowing you to modify
-  associated objects directly through a model object, similar to
-  ActiveRecord's Nested Attributes.
-  
-    Artist.plugin :nested_attributes
-    Artist.one_to_many :albums
-    Artist.nested_attributes :albums
-    a = Artist.new(:name=>'YJM',
-     :albums_attributes=>[{:name=>'RF'}, {:name=>'MO'}])
-    # No database activity yet
-
-    a.save # Saves artist and both albums
-    a.albums.map{|x| x.name} # ['RF', 'MO']
-  
-  It takes most of the same options as ActiveRecord, as well as a
-  a few additional options:
-  
-  * :destroy - Allow destruction of nested records.
-  * :limit - For *_to_many associations, a limit on the number of
-    records that will be processed, to prevent denial of service
-    attacks.
-  * :remove - Allow disassociation of nested records (can remove the
-    associated object from the parent object, but not destroy the
-    associated object).
-  * :strict - Set to false to not raise an error message if a primary
-    key is provided in a record, but it doesn't match an existing
-    associated object.
-    
-  If a block is provided, it is passed each nested attribute hash.
-  If the hash should be ignored, the block should return anything
-  except false or nil.
-
-* A timestamps plugin was added for automatically adding
-  before_create and before_update hooks for setting values on
-  timestamp columns.  There are a couple of existing external
-  plugins that handle timestamps, but the implementations are
-  suboptimal.  The new built-in plugin supports the following
-  options (with the default in parentheses):
-  
-  * :create - The field to hold the create timestamp (:created_at)
-  * :force - Whether to overwrite an existing create timestamp
-    (false)
-  * :update - The field to hold the update timestamp (:updated_at)
-  * :update_on_create - Whether to set the update timestamp to the
-    create timestamp when creating (false)
-      
-* An instance_hooks plugin was added for adding hooks to specific
-  w
-  model instances:
-  
-    obj = Model.new
-    obj.after_save_hook{do_something}
-    obj.save # calls do_something after the obj has been saved
-
-  All of the standard hooks are supported, except for
-  after_initialize.  Instance level before hooks are executed in
-  reverse order of addition before calling super.  Instance level
-  after hooks are executed in order of addition after calling super.
-  If any of the instance level before hook blocks return false, no
-  more instance level before hooks are called and false is returned.
-
-  Instance level hooks are cleared when the object is saved
-  successfully.
-  
-* A boolean_readers plugin was added for creating attribute? methods
-  for boolean columns.  This can provide a nicer API:
-  
-    obj = Model[1]
-    obj.active  # Sequel default column reader
-    obj.active? # Using the boolean_readers plugin
-    
-  You can provide a block when loading the plugin to change the
-  criteria used to determine if the column is boolean:
-  
-    Sequel::Model.plugin(:boolean_readers) do |c|
-      db_schema[c][:db_type] =~ /\Atinyint/
-    end
-    
-  This may be useful if you are using MySQL and have some tinyint
-  columns that represent booleans and others that represent integers.
-  You can turn the convert_tinyint_to_bool setting off and use the
-  attribute methods for the integer value and the attribute? methods
-  for the boolean value.
-
-Other New Features
-------------------
-
-* Sequel now has support for converting Time/DateTime to local or UTC
-  time upon storage, retrieval, or typecasting.
-  
-  There are three different timezone settings:
-
-  * Sequel.database_timezone - The timezone that timestamps use in
-    the database.  If the database returns a time without an offset,
-    it is assumed to be in this timezone.
-
-  * Sequel.typecast_timezone - Similar to database_timezone, but used
-    for typecasting data from a source other than the database.  This
-    is currently only used by the model typecasting code.
-
-  * Sequel.application_timezone - The timezone that the application
-    wants to deal with.  All Time/DateTime objects are converted into
-    this timezone upon retrieval from the database.
-
-  Unlike most things in Sequel, these are only global settings, you
-  cannot change them per database.  There are only three valid
-  timezone settings:
-
-  * nil (the default) - Don't do any timezone conversion.  This is
-    the historical behavior.
-
-  * :local - Convert to local time/Consider time to be in local time.
-
-  * :utc - Convert to UTC/Consider time to be in UTC.
-
-  So if you want to store times in the database as UTC, but deal with
-  them in local time in the application:
-
-    Sequel.application_timezone = :local
-    Sequel.database_timezone = :utc
-
-  If you want to set all three timezones to the same value:
-
-    Sequel.default_timezone = :utc
-
-  There are three conversion methods that are called:
-
-  * Sequel.database_to_application_timestamp - Called on time objects
-    coming out of the database.  If the object coming out of the
-    database (usually a string) does not have an offset, assume it is
-    already in the database_timezone.  Return a Time/DateTime object
-    (depending on Sequel.datetime_class), in the application_timzone.
-
-  * Sequel.application_to_database_timestamp - Used when literalizing
-    Time/DateTime objects into an SQL string.  Converts the object to
-    the database_timezone before literalizing them.
-
-  * Sequel.typecast_to_application_timestamp - Called when
-    typecasting objects for model datetime columns.  If the object
-    being typecasted does not already have an offset, assume it is
-    already in the typecast_timezone.  Return a Time/DateTime object
-    (depending on Sequel.datetime_class), in the
-    application_timezone.
-
-  Sequel does not yet support named timezones or per thread
-  modification of the timezone (for showing all timestamps in the
-  current user's timezone).  Extensions to support both features are
-  planned for a future version.
-
-* Dataset#truncate was added for truncating tables.  Truncate allows
-  for fast removal of all rows in a table.
-  
-* Sequel now supports typecasting a hash to date, time, and datetime
-  types.  This allows easy usage of Sequel with forms that split
-  the entry of these database types into separate from fields.
-  With this code, you can just have field names like:
-
-    date[year]
-    date[month]
-    date[day]
-
-  Rack will parse that into:
-
-    {'date'=>{'year'=>?, 'month'=>?, 'day'=>?}}
-
-  So then you can do:
-
-    obj.date = params['date']
-    # or
-    obj.set(params)
-  
-* validates_unique now takes a block that can be used to scope the
-  uniqueness constraint. This allows you to easily set up uniqueness
-  validations that are only necessary in a given scope.  For example,
-  a validation on username, but only for active users (as inactive
-  users are soft deleted but remain in the table).  You just pass a
-  block to validates_unique:
-
-    validates_unique(:name){|ds| ds.filter(:active)}
-    
-* The serialization plugin now supports json.
-    
-* Sequel now supports generic concepts of
-  CURRENT_{DATE,TIME,TIMESTAMP}.  Most databases support these SQL
-  concepts, but not all, and some implementations act differently.
-
-  The Sequel::SQL::Constants module holds the three constants,
-  which are instances of SQL::Constant, an SQL::GenericExpression
-  subclass.  This module is included in Sequel, so you can reference
-  the constants more easily (e.g. Sequel::CURRENT_TIMESTAMP).
-  It's separated out into a separate module so that you can just
-  include that module in the top level scope, allowing you to
-  reference the constants directly (e.g. CURRENT_TIMESTAMP).
-  
-    DB[:events].filter{date < ::Sequel::CURRENT_DATE}
-    # or:
-    include Sequel::SQL::Constants
-    DB[:events].filter{date < ::CURRENT_DATE}
-
-* Database#run was added for executing arbitrary SQL on a database.
-  It's an alias for Database#<<, but it allows for a nicer API inside
-  migrations, since you can now do:
-  
-    run 'SQL'
-    
-  instead of:
-  
-    self << 'SQL'
-    
-  You can also provide a :server option to run the SQL on the
-  given server/shard:
-  
-    run 'SQL', :server=>:shard1
-
-* Sequel::Model() can now take a database argument in addition to
-  a symbol or dataset argument.  If a database is given, it'll create
-  an anonymous subclass attached to the given database.  Other changes
-  were made to allow the following code to work:
-  
-    class Item < Sequel::Model(DB2)
-    end
-    
-  That will work correctly assuming a table named items in DB2.
-
-* Dataset#ungrouped was added for removing a grouping from an
-  existing dataset.  Also, Dataset#group when called with no arguments
-  or with a nil argument also removes any existing grouping instead
-  of resulting in invalid SQL.
-
-* Model#modified? was added, letting you know if the model has been
-  modified.  If the model hasn't been modified, calling
-  Model#save_changes will do nothing.
-
-* SQL::OrderedExpression now supports #asc, #desc, and #invert.
-
-Other Improvements
-------------------
-
-* The serialization and lazy_attribute plugins now add accessor
-  methods to a module included in the class, instead of to the
-  model class itself.  This allows the methods to be overridden
-  in the class and work well with super, as well for the plugins
-  to work together on the same column.  Make sure the
-  lazy_attributes accessor is setup before the serialization
-  accessor if you want to have a lazy serialized column.
-  
-* Calling the add_* method for many_to_many association now saves the
-  record if the record is new.  This makes it operate more similarly
-  to one_to_many associations.  Previously, it raised an Error.
-
-* Dataset#import now works correctly when called with a dataset.
-  Previously, it generated incorrect SQL.
-
-* The JDBC adapter now converts byte arrays to/from SQL::Blob.
-
-* The JDBC adapter now attempts to bind unknown types using
-  setObject instead of raising, so it can work with native Java
-  objects.  It also binds boolean parameters correctly.
-
-* Using multiple emulated ALTER TABLE statements (such as
-  drop_column) in a single alter_table block now works correctly
-  on SQLite.
-  
-* Database#indexes now works on JDBC for tables in a non-default
-  schema.  It also now properly detects unique indexes on MSSQL.
-
-* Database#schema on JDBC now accepts a :schema option.  Also,
-  returned schema hashes now include a :column_size entry specifying
-  the maximum length/precision for the column, since the
-  :db_type entry doesn't have contain the information on JDBC.
-
-* Datasets without tables now work correctly on Oracle, so things
-  like DB.get(...) now work.
-  
-* A descriptive error message is given if you attempt to use
-  Sequel with the mysql.rb driver (which Sequel doesn't support).
-  
-* The postgres adapter now works correctly with a modified
-  postgres-pr that raises PGErrors instead of RuntimeErrors
-  (e.g. http://github.com/jeremyevans/postgres-pr).
-  
-* You now get a Sequel::InvalidOperation instead of a NoMethodError
-  if you attempt to update a dataset without a table.
-  
-* The inflection support has been modified to reduce code
-  duplication.
-
-Backwards Compatibility
------------------------
-
-* Sequel now includes fractional seconds in timestamps for all
-  adapters except MySQL.  It's possible that this may break
-  timestamp columns for databases that are not regularly tested.
-  
-* Sequel now includes timezone values in timestamps on Microsoft
-  SQL Server, Oracle, PostgreSQL and SQLite.  The modification for
-  SQLite is probably the biggest cause for concern, since SQLite
-  stores times as text.  If you have an SQLite database that uses
-  timestamps and is accessed by something other than Sequel, you
-  should make sure that it works with the timestamp format that
-  Sequel now uses.
-  
-* The default timestamp format used by Sequel now uses a space
-  instead of 'T' between the date and time parts, which could
-  possibly affect some databases that are not regularly tested.
-
-* Attempting to insert into a grouped dataset or a dataset that
-  selects from multiple tables will now raise an Error.  Previously,
-  it would ignore any GROUP or JOIN settings and generate bad SQL if
-  there were multiple FROM tables.
-  
-* Database#<< now always returns nil.  Before, the return value was
-  adapter dependent.
-
-* ODBC::Time and ODBC::DateTime values are now converted to the
-  Sequel.datetime_class.  Before, ODBC::Time used Time and
-  ODBC::DateTime used DateTime regardless of the
-  Sequel.datetime_class setting.
-  
-* The default inflections were modified, fixing some obvious errors
-  and possibly changing some existing inflections.  Further changes
-  to the default inflections are unlikely.

data/doc/release_notes/3.40.0.txt

@@ -1,73 +0,0 @@
-= New Features
-
-* Sequel now has vastly improved support for Microsoft Access.
-
-* Sequel now supports the CUBRID database, with a cubrid adapter
-  that uses the cubrid gem, and a jdbc/cubrid adapter for accessing
-  CUBRID via JDBC on JRuby.
-
-* The association_pks plugin now supports composite keys.
-
-* Database#transaction now accepts a :disconnect=>:retry option,
-  in which case it will automatically retry the block if it
-  detects a disconnection.  This is potentially dangerous, and
-  should only be used if the entire block is idempotent.  There
-  is also no checking against an infinite retry loop.
-
-* SQL::CaseExpression#with_merged_expression has been added, for
-  converting a CaseExpression with an associated expression to
-  one without an associated expression, by merging the expression
-  into each condition.
-
-= Other Improvements
-
-* Sequel now quotes arguments/columns in common table expressions.
-
-* Sequel now handles nil values correctly in the pg_row extension.
-
-* Sequel::Postgres::HStore instances can now be marshalled.
-
-* Sequel now uses clob for String :text=>true types on databases that
-  don't support a text type.
-
-* On PostgreSQL, Sequel now quotes channel identifier names when using
-  LISTEN/NOTIFY.
-
-* On PostgreSQL, Sequel now correctly handles the case where named
-  type conversion procs have been added before the Database object is
-  instantiated.
-
-* On DB2, Sequel now explicitly sets NOT NULL for unique constraint
-  columns instead of foreign key columns.  DB2 does not allow columns
-  in unique constraints to be NULL, but does allow foreign key columns
-  to be NULL.
-
-* In the oracle adapter, clob values are now returned as ruby strings
-  upon retrieval.
-
-* Sequel now detects more types of disconnections in the postgres,
-  mysql, and mysql2 adapters.
-
-* If a database provides a default column value that isn't a ruby
-  string, it is used directly as the ruby default, instead of causing
-  the schema parsing to fail.
-
-= Backwards Compatibility
-
-* Code using Sequel's oracle adapter that expected clob values to be
-  returned as OCI8::CLOB instances needs to be modified to work with
-  ruby strings.
-
-* Because Sequel now quotes column names in common table expressions,
-  those names are now case sensitive, which could break certain poorly
-  coded queries.  Similar issues exist with the quoting of channel
-  identifier names in LISTEN/NOTIFY on PostgreSQL.
-
-* The private Database#requires_return_generated_keys? method
-  has been removed from the jdbc adapter.  Custom jdbc subadapters
-  relying on this method should override the private
-  Database#execute_statement_insert method instead to ensure that
-  RETURN_GENERATED_KEYS is used for insert statements.
-
-* The private Dataset#argument_list and #argument_list_append methods
-  have been removed.