sequel 5.6.0 → 5.7.0

data/doc/release_notes/3.3.0.txt

@@ -1,192 +0,0 @@
-New Features
-------------
-
-* An association_proxies plugin has been added.  This is not a
-  full-blown proxy implementation, but it allows you to write code
-  such as:
-  
-    artist.albums.filter{num_tracks > 10}
-    
-  Without the plugin, you have to call filter specifically on the
-  association's dataset:
-  
-    artist.albums_dataset.filter{num_tracks > 10}
-
-  The plugin works by proxying array methods to the array of
-  associated objects, and all other methods to the association's
-  dataset.  This results in the following behavior:
-  
-    # Will load the associated objects (unless they are already
-    # cached), and return the length of the array
-    artist.albums.length
-    
-    # Will issue an SQL query with COUNT (even if the association
-    # is already cached), and return the result
-    artist.albums.count
-
-* The add_*/remove_*/remove_all_* association methods now take
-  additional arguments that are passed down to the
-  _add_*/_remove_*/_remove_all_* methods.  One of the things this
-  allows you to do is update additional columns in join tables for
-  many_to_many associations:
-
-    class Album
-      many_to_many :artists
-      def _add_artist(artist, values={})
-        DB[:albums_artists].
-          insert(values.merge(:album_id=>id,
-                              :artist_id=>artist.id))
-      end
-    end
-    
-    album = Album[1]
-    artist1 = Artist[2]
-    artist2 = Artist[3]
-    album.add_artist(artist1, :relationship=>'composer')
-    album.add_artist(artist2, :relationship=>'arranger')
-
-* The JDBC adapter now accepts a :convert_types option to turn off
-  Java type conversion.  The option is true by default for
-  backwards compatibility and correctness, but can be set to false
-  to double performance.  The option can be set at the database
-  and dataset levels:
-
-    DB = Sequel.jdbc('jdbc:postgresql://host/database',
-                     :convert_types=>false)
-    DB.convert_types = true
-    ds = DB[:table]
-    ds.convert_types = false
-
-* Dataset#from_self now takes an option hash and respects an
-  :alias option, giving the table alias to use.
-
-* Dataset#unlimited was added, similar to unfiltered and unordered.
-
-* SQL::WindowFunction is now a subclass of SQL::GenericExpression,
-  so you can alias it and treat it like any other SQL::Function.
-
-Other Improvements
-------------------
-
-* Microsoft SQL Server support is much, much better in Sequel 3.3.0
-  than in previous versions.  Support is pretty good with the ODBC,
-  ADO, and JDBC adapters, close to the level of support for
-  PostreSQL, MySQL, SQLite, and H2.  Improvements are too numerous
-  to list, but here are some highlights:
-  
-  * Dataset#insert now returns the primary key (identity field), so
-    it can be used easier with models.
-    
-  * Transactions can now use savepoints (except on ADO).
-  
-  * Offsets are supported when using SQL Server 2005 or 2008, using
-    a ROW_NUMBER window function.  However, you must specify an
-    order for your dataset (which you probably are already doing if
-    you are using offsets).
-
-  * Schema parsing has been implemented, though it doesn't support
-    primary key parsing (except on JDBC, since the JDBC support is
-    used there).
-  
-  * The SQL syntax Sequel uses is now much more compatible, and
-    most schema modification methods and database types now work
-    correctly.
-
-* The ADO and ODBC adapters both work much better now.  The ADO
-  adapter no longer attempts to use transactions, since I've found
-  that ADO does not give a stable native connection (and hence
-  transactions weren't possible).  I strongly recommend against
-  using the ADO adapter in production.
-
-* The H2 JDBC subadapter now supports rename_column, set_column_null,
-  set_column_type, and add_foreign_key.
-
-* Altering a columns type, null status, or default is now supported
-  on SQLite.  You can also add primary keys and unique columns.
-
-* Both the ADO and ODBC adapters now catch the native exception
-  classes and raise Sequel::DatabaseErrors.
-
-* Model classes now default to associating to other classes in the
-  same scope.  This makes it easier to use namespaced models.
-
-* The schema parser and schema dumper now support the following
-  types: nchar, nvarchar, ntext, smalldatetime, smallmoney, binary,
-  and varbinary.
-
-* You can now specify the null status for a column using :allow_null
-  in addition to :null.  This is to make it easier to use the
-  table creation methods with the results of the schema parser.
-
-* Renaming a NOT NULL column without a default now works on MySQL.
-
-* Model class initialization now raises an exception if there is a
-  problem connecting to the database.
-  
-* Connection pool performance has been increased slightly.
-
-* The literal_time method in the ODBC adapter has been fixed.
-
-* An unlikely but potential bug in the MySQL adapter has been fixed.
-
-Backwards Compatibility
------------------------
-
-* The convert_tinyint_to_bool setting moved from the main Sequel
-  module to the Sequel::MySQL module.  The native MySQL adapter is
-  the only adapter that converted tinyint columns to booleans when
-  the rows are returned, so you can only use the setting with the
-  native MySQL adapter.
-  
-  Additionally, the setting's behavior has changed.  When parsing
-  the schema, now only tinyint(1) columns are now considered as
-  boolean, instead of all tinyint columns. This allows you to use
-  tinyint(4) columns for storing small integers and tinyint(1)
-  columns as booleans, and not have the schema parsing support
-  consider the tinyint(4) columns as booleans.  Unfortunately,
-  due to limitations in the native MySQL driver, all tinyint
-  column values are converted to booleans upon retrieval, not just
-  tinyint(1) column values.
-  
-  Unfortunately, the previous Sequel behavior was to use the
-  default tinyint size (tinyint(4)) when creating boolean columns
-  (using the TrueClass or FalseClass generic types).  If you were
-  using the generic type support to create the columns, you should
-  modify your database to change the column type from tinyint(4) to
-  tinyint(1).
-  
-  If you use MySQL with tinyint columns, these changes have the
-  potential to break applications.  Care should be taken when
-  upgrading if these changes apply to you.
-
-* Model classes now default to associating to other classes in the
-  same scope.  It's highly unlikely anyone was relying on the
-  previous behavior, but if you have a model inside a module that
-  you are associating to a model outside of a module, you now need
-  to specify the associated class using the :class option. 
-  
-* Model#save no longer includes the primary key fields in the SET
-  clause of the UPDATE query, only in the WHERE clause.  I'm not
-  sure if this affects backwards compatibility of production code,
-  but it can break tests that expect specific SQL.
-
-* Behavior to handle empty identifiers has now been standardized.
-  If any database adapter returns an empty identifier, Sequel will
-  use 'untitled' as the identifier.  This can break backwards
-  compatibility if the adapter previously used another default and
-  you were relying on that default.  This was necessary to fix any
-  possible "interning empty string" exceptions.
-
-* On MSSQL, Sequel now uses the datetime type instead of the
-  timestamp type for generic DateTimes.  It now uses bit for the
-  TrueClass and FalseClass generic types, and image for the File
-  generic type.
-
-* Sequel now unescapes URL parts:
-
-    Sequel.connect(ado:///db?host=server%5cinstance)
-
-  However, this can break backward compatibility if you previously
-  expected it not to be unescaped.
-
-* The columns_for private SQLite Database method has been removed.

data/doc/release_notes/3.30.0.txt

@@ -1,135 +0,0 @@
-= Dataset Literalization Refactoring
-
-* As warned about in the 3.29.0 release notes, dataset literalization
-  has been completely refactored.  It now uses an append-only design
-  which is faster in all cases, about twice as fast for large objects
-  and deeply nested structures, and over two orders of magnitude
-  faster in some pathological cases.
-
-  This change should not affect applications, but may affect custom
-  extensions or adapters that dealt with literalization of objects.
-  Most literalization methods now have a method with an _append
-  suffix that does the actual literalization, which takes the sql
-  string to append to as the first argument.  If you were overriding
-  a literalization method, you now probably need to override the
-  _append version instead.  If you have this literalization method:
-
-    def foo_sql(bar)
-      "BAR #{literal(bar.baz)}"
-    end
-
-   You need to change the code to:
-
-    def foo_sql_append(sql, bar)
-      sql << "BAR "
-      literal_append(sql, bar.baz)
-    end
-
-    def foo_sql(bar)
-      sql = ""
-      foo_sql_append(sql, bar)
-      sql
-    end
-
-  If you have questions about modifying your custom adapter or
-  extension, please ask on the Google Group or the IRC channel.
-
-= New Features
-
-* Model#set_server has been added to the base support (it was
-  previously only in the sharding plugin), which allows you to
-  set the shard on which to save/delete the model instance:
-
-    foo1.set_server(:server_a).save
-    foo2.set_server(:server_a).destroy
-
-* Model#save now accepts a :server option that uses set_server
-  to set the shard to use.  Unlike most other #save options, this
-  option persists past the end of the save.  Previously, the
-  :server option only affected the transaction code, it now
-  affects the INSERT/UPDATE statement as well.
-
-* When initiating a new dataset graph, any existing selected
-  columns is assumed to be the columns to select for the graph from
-  the current/master table.  Before, there was not a way to specify
-  the columns to select from the current/master table.
-
-* A :graph_alias_base association option has been added, which is
-  used to set the base alias name to use when eager graphing.  This
-  is mostly useful when cascading eager graphs to dependent
-  associations, where multiple associations with the same name in
-  different models are being graphed simultaneously.
-
-* You can now specify nanoseconds and a timezone offset
-  when converting a hash or array to a timestamp.  The nanoseconds
-  and offset are the 7th and 8th entries in the array, and the :nanos
-  and :offset entry in the hash.
-
-* The postgres adapter now respects a :connect_timeout option if you
-  are using the pg driver.
-
-= Other Improvements
-
-* Type conversion of Java to Ruby types in the JDBC adapter has been
-  made much faster, as conversion method lookup is now
-  O(number of columns) instead of
-  O(number of columns*number of rows).
-
-* Sequel::SQL::Blob literalization is now much faster on adapters that
-  use hex encoding, by switching to String#unpack('H*').
-
-* Database#after_commit and after_rollback now respect the :server
-  option to set the server/shard to use.
-
-* Symbol splitting (e.g. for table__column) is now slightly faster.
-
-* All adapters now pass the dataset :limit/:offset value through
-  Dataset#literal instead of using it verbatim.  Note that
-  Dataset#limit already called to_i on input strings, so this isn't
-  a security issue.  However, the previous code broke if you
-  provided a Sequel-specific object (e.g. Sequel::SQL::Function) as
-  the :limit/:offset value.
-
-* Calling graph and eager_graph on an already graphed dataset no
-  longer modifies the receiver.
-
-* Model#set_server now correctly handles the case where @this is
-  already loaded.
-
-* Dataset#destroy for model datasets now uses the dataset's shard
-  for transactions.
-
-* When emulating offset support using ROW_NUMBER (on Microsoft SQL
-  Server, DB2, and Oracle), explicitly order by the ROW_NUMBER
-  result, as otherwise the results are not guaranteed to be ordered.
-
-* Explicitly force a case insensitive collation when emulating ILIKE
-  on Microsoft SQL Server.  Previously, ILIKE could be case sensitive
-  on Microsoft SQL Server if case sensitive collation was the
-  database default.
-
-* Using on_duplicate_key_update with prepared statements on MySQL now
-  works correctly.
-
-* The tinytds adapter now works correctly if the
-  identifier_output_method is nil.
-
-* The plugin/extension specs were cleaned up using the mock adapter.
-
-= Backwards Compatibility
-
-* In addition to the previously mentioned dataset literalization
-  changes, any custom adapters that overrode *_clause_methods
-  methods need to be modified to add a method that adds the
-  SELECT/UPDATE/INSERT/DELETE.  Previously, this was done by default,
-  but due to common table expressions and the dataset literalization
-  changes, a separate method is now needed.
-
-* Dataset#on_duplicate_key_update_sql has been removed from the shared
-  mysql adapter.
-
-* The :columns dataset option used when inserting is no longer
-  literalized in advance.
-
-* Dataset#as_sql no longer takes an expression, it just takes the
-  alias, and only adds the alias part.

data/doc/release_notes/3.31.0.txt

@@ -1,146 +0,0 @@
-= New Features
-
-* The serialization plugin can now support custom serialization
-  formats, by supplying a serializer/deserializer pair of
-  callable objects.  You can also register custom deserializers
-  via Sequel::Plugins::Serialization.register_format, so that
-  they can be referenced by name.  Example:
-  
-    Sequel::Plugins::Serialization.register_format(:reverse,
-      lambda{|v| v.reverse},
-      lambda{|v| v.reverse})
-    class User < Sequel::Model
-      serialize_attributes :reverse, :password
-    end
-
-* Dataset#import and #multi_insert now support a
-  :return=>:primary_key option.  When this option is used, the
-  methods return an array of primary key values, one for each
-  inserted row.  Usage of this option on MySQL requires that a
-  separate query be issued per row (instead of the single
-  query for all rows that MySQL would usually use).
-  
-* PostgreSQL can now use Dataset#returning in conjunction with
-  import/multi_insert to set a custom column to return.
-  
-* Microsoft SQL Server can now use Dataset#output in conjection with
-  import/multi_insert to set a custom column to return.
-  
-* Dataset#import and #multi_insert now respect a :server option to
-  set the server/shard on which to execute the queries.
-  Additionally, options given to this method are also passed to
-  Dataset#transaction.
-
-* Dataset#insert_multiple now returns an array of inserted primary
-  keys.
-
-* Model.def_column_alias has been added to make it easy to create
-  alias methods for columns.  This is useful if you have a legacy
-  database and want to create friendly method names for the
-  underlying columns.  Note that this alias only affects the setter
-  and getter methods.  This does not affect the dataset level, so you
-  still need to use the actual column names in dataset filters.
-
-* many_to_one associations can now have the same name as the related
-  foreign key column, using the :key_column option.  Use of this
-  feature is not recommended, as it is much better to either rename
-  the column or rename the association.  Here's an example of usage:
-  
-    # Example schema:
-    #  albums           artists
-    #   :id        /-->  :id
-    #   :artist --/      :name
-    #   :name
-    class Album < Sequel::Model
-      def_column_alias(:artist_id, :artist)
-      many_to_one :artist, :key_column=>:artist
-    end
-
-* The mock adapter can now mock out database types, by providing a
-  shared adapter name as the host (e.g. mock://postgres).  This
-  emulation is not perfect, but in most cases it allows you to see
-  what SQL Sequel would generate on a given database without needing
-  to install the required database driver.
-
-* Sequel now supports creating full text indexes on Microsoft SQL
-  Server.  Before using it, you must have previously setup a default
-  full text search catalog, and you need to provide a :key_index
-  option with an index name symbol.
-  
-* Dataset#group_rollup and #group_cube methods have been added for
-  GROUP BY ROLLUP and GROUP BY CUBE support.  These features are in
-  a recent SQL standard, and they are supported to various degrees on
-  Microsoft SQL Server, DB2, Oracle, MySQL, and Derby.
-
-* Dataset#full_text_search on Microsoft SQL Server now supports
-  multiple search terms.
-  
-* The jdbc adapter now supports a :login_timeout option, giving the
-  timeout in seconds.
-
-= Other Improvements
-
-* Dataset#exists can now be used with prepared statement
-  placeholders.
-
-* Dataset#full_text_search can now be used with prepared statement
-  placeholders on PostgreSQL, MySQL, and Microsoft SQL Server.
-  
-* If tables from two separate schema are detected when parsing the
-  schema for a table on PostgreSQL, an error is now raised.
-  Previously, no error was raised, which led to weird errors later,
-  such as duplicate columns in a model's primary_key.
-
-* RETURNING is now supported with UPDATE/DELETE on PostgreSQL 8.2+.
-  Previously, Sequel only supported it on 9.1+, but PostgreSQL
-  introduced support for it in 8.2.
-
-* The shared postgres adapter now correctly handles the return value
-  for Dataset#insert if you provide a separate column array and value
-  array on PostgreSQL < 8.2.
-  
-* Handle case in the PostgreSQL adapter where the server version
-  cannot be determined via a query.
-  
-* H2 clob types are now treated as string instead of as blob.
-  Treating clob as blob breaks on H2, as it doesn't automatically
-  hex-unescape the input for clobs as it does for blobs.
-  
-* Dataset#empty? now works correctly when the dataset has an offset
-  and offset support is being emulated.
-
-* The mock adapter no longer defaults to downcasing identifiers on
-  output.
-
-= Backwards Compatibility
-
-* Dataset#exists now returns a PlaceholderLiteralString instead of a
-  LiteralString, which could potentially break some code.  If you
-  would like a String returned, you can pass the returned object to
-  Dataset#literal:
-  
-    dataset.literal(dataset.exists)
-
-* Dataset#from no longer handles :a__b__c___d as "a.b.c AS d".  This
-  was not the intended behavior, and nowhere else in Sequel is a
-  symbol treated that way.  Now, Dataset#from is consistent with the
-  rest of Sequel, using "a.b__c AS d".  This should only affect
-  people in very rare cases, as most databases don't use three level
-  qualified tables.  One exception is Microsoft SQL Server, which can
-  use three level qualified tables for cross-database access.
-  
-* Previously, Dataset#insert_multiple returned an array of hashes, now
-  it returns an array of primary key values.
-
-* Dataset#EXRACT_CLOSE in the shared sqlite adapter has been renamed to
-  Dataset#EXTRACT_CLOSE.
-  
-* Dataset::StoredProcedureMethods::SQL_QUERY_TYPE and
-  Dataset::ArgumentMapper::SQL_QUERY_TYPE constants have been removed,
-  as have related sql_query_type private methods.
-
-* The serialization plugin was significantly refactored.
-  Model.serialization_map now contains a callable object instead of a
-  Symbol, and Model.serialization_format has been removed.
-  Model.define_serialized_attribute_accessors private method now takes
-  two callable objects before the columns, instead of a single symbol.