sequel 3.21.0 → 3.41.0

data/doc/release_notes/3.39.0.txt

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

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

data/doc/release_notes/3.41.0.txt

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