sequel 5.20.0 → 5.49.0

data/doc/release_notes/4.8.0.txt

@@ -1,175 +0,0 @@
-= New Features
-
-* A one_through_one association type has been added.  This is similar
-  to the many_to_many association type in that it uses a join table,
-  but it returns a single record instead of an array of records.
-  This is designed for cases where the foreign key in the join table
-  that references the current table has a unique constraint, or where
-  you want to use an order to just pick the first matching record.
-
-  Similarly, the many_through_many plugin now also offers a
-  one_through_many association.
-
-* An association_join method has been added to model datasets, for
-  setting up joins based on associations.  This basically does the
-  same join that eager_graph would do, but does not make the other
-  changes that eager_graph makes.
-
-  Unlike eager_graph (which uses LEFT OUTER JOINs by default),
-  association_join uses INNER JOINs, but there are also
-  association_*_join methods (e.g. association_left_join) for
-  using different join types.
-
-  Similar to eager_graph, you can use cascading of associations or
-  multiple associations.
-
-    Album.association_join(:artist, :tracks)
-    Artist.association_left_join(:albums=>:tracks)
-
-* Dataset#eager_graph_with_options has been added for model
-  datasets.  It currently supports a :join_type option, for
-  overriding the type of join to use on a per-call basis, as well
-  as a :limit_strategy option.  The API is similar to eager_graph,
-  except that the associations to eagerly load are passed in as
-  a single argument, and it takes an options hash.
-
-  The :limit_strategy option works similarly to the
-  :eager_limit_strategy option when eagerly loading.  If set to
-  true and the database supports window functions, it will join
-  the current dataset to a subquery that uses a window function
-  to correctly restrict the join to only those objects that fall
-  within the association's limit/offset.
-
-  The :limit_strategy option is not on by default.  It is possible
-  for it to perform significantly worse than the default strategy
-  (which uses array slicing in ruby).  The :limit_strategy
-  significantly changes the SQL used, and can change the results
-  of the query if any filters/orders related to the association
-  are used.
-
-  It's recommended you only use the :limit_strategy option if you
-  are experiencing a bottleneck and you have benchmarked that it
-  is faster and still produces the desired results.
-
-    Artist.eager_graph_with_options(:first_10_albums,
-      :limit_strategy=>true)
-    # SELECT artists.id, artists.name,
-    #   first_10_albums.id AS first_10_albums_id,
-    #   first_10_albums.name AS first_10_albums_name,
-    #   first_10_albums.artist_id,
-    #   first_10_albums.release_date
-    # FROM artists
-    # LEFT OUTER JOIN (
-    #   SELECT id, name, artist_id, release_date
-    #   FROM (
-    #     SELECT *, row_number() OVER (PARTITION BY tracks.album_id)
-    #       AS x_sequel_row_number_x
-    #     FROM albums
-    #   ) AS t1 WHERE (x_sequel_row_number_x <= 10)
-    # ) AS first_10_albums ON (first_10_albums.artist_id = artists.id)
-
-* Dataset#full_text_search on PostgreSQL now supports :plain and
-  :phrase options.  :plain takes the search terms as a single
-  string, and searches for rows where all terms are used.
-  :phrase is similar to :plain, but also adds a substring search
-  to ensure that the string given appears verbatim in the text.
-
-* A :graph_order association option has been added, for using a
-  different order when using eager_graph.  This is mostly
-  designed for cases where :order should be qualified in other
-  cases, but using a qualification breaks eager_graph because the
-  correct qualifier is not known until runtime.
-
-* SQL::AliasedExpression#alias has been added as an alias for #aliaz.
-
-= Other Improvements
-
-* Sequel will now automatically use an eager limit strategy for
-  *_one associations that use an :order option.  For associations
-  that are truly one-to-one, an :order option is not needed, so it
-  only makes sense to have an :order option if the association
-  could theoretically return multiple results (in which case an
-  eager limit strategy is helpful).
-
-* The queries that Sequel uses to filter by associations when
-  those associations have conditions are now simpler and easier
-  for the database to execute.
-
-* The queries that Sequel uses for dataset associations now handle
-  cases where unqualified identifiers were used in the receiving
-  dataset that would be made ambiguous by a join.
-
-* A limit strategy is now used when filtering by associations if
-  the association has a limit and the database supports window
-  functions.  This allows Sequel to setup a correct filter in
-  such cases.
-
-    Artist.where(:first_10_albums=>Album[1]).all
-    # SELECT *
-    # FROM artists
-    # WHERE (artists.id IN (
-    #   SELECT albums.artist_id
-    #   FROM albums
-    #   WHERE ((albums.artist_id IS NOT NULL) AND (albums.id IN (
-    #     SELECT id FROM (
-    #       SELECT albums.id, row_number() OVER
-    #         (PARTITION BY albums.artist_id ORDER BY release_date)
-    #         AS x_sequel_row_number_x
-    #       FROM albums
-    #     ) AS t1
-    #     WHERE (x_sequel_row_number_x <= 10)
-    #   )) AND (albums.id = 1))))
-
-* A limit strategy is now used in the dataset_associations plugin
-  if the association has a limit and the database supports window
-  functions.  This makes the resulting datasets return correct
-  results.
-
-    Artist.first_10_albums
-    # SELECT *
-    # FROM albums
-    # WHERE ((albums.artist_id IN (
-    #   SELECT artists.id FROM artists)
-    # ) AND (albums.id IN (
-    #   SELECT id FROM (
-    #     SELECT albums.id, row_number() OVER
-    #       (PARTITION BY albums.artist_id ORDER BY release_date)
-    #       AS x_sequel_row_number_x
-    #     FROM albums
-    #   ) AS t1
-    #   WHERE (x_sequel_row_number_x <= 10)
-    # )))
-    # ORDER BY release_date
-
-* You can now pass symbols with embedded qualifiers or aliases,
-  as well as SQL::Identifier, SQL::QualifiedIdentifier, and
-  SQL::AliasedExpression objects as the first argument to
-  Dataset#graph.
-
-* The nested_attributes plugin now automatically handles presence
-  validations on foreign keys when creating associated objects.
-  It now sets the foreign key value (or a placeholder value)
-  before validating such objects.
-
-* Offsets on *_one associations are now respected when using
-  eager_graph.
-
-* eager graphing *_many associations with offsets no longer breaks
-  if there are no associated results.
-
-* Database#register_array_type in the pg_array extension now works
-  correctly if there is no existing scalar conversion proc for
-  the type.
-
-* Unique, foreign key, and not null constraint violations are now
-  recognized correctly on SQLite 3.8.2+.
-
-* The odbc adapter now returns fractional seconds in timestamps.
-
-* The obdc/mssql adapter now inputs timestamps with 3 decimal
-  places.
-
-= Backwards Compatibility
-
-* The private Model.apply_window_function_eager_limit_strategy
-  method has been removed.

data/doc/release_notes/4.9.0.txt

@@ -1,190 +0,0 @@
-= Performance Enhancements
-
-* Dataset::PlaceholderLiteralizer has been added as an optimization
-  framework.  This allows you to record changes to a given dataset
-  using placeholder arguments, and later quickly execute the query
-  providing values for the placeholders.  This is similar in idea
-  to prepared statements, except that the SQL for each query can
-  change depending on the values for the placeholders.
-
-  Using this optimization framework, generating the SQL for query
-  is about 3x faster, and since SQL generation time is a significant
-  portion of total time for simple queries, simple queries can
-  execute up to 50% faster.
-
-  There are two APIs for this optimization framework.  There is a
-  lower level dataset API:
-
-    loader = Sequel::Dataset::PlaceholderLiteralizer.
-     loader(DB[:items]) do |pl, ds|
-      ds.where(:id=>pl.arg).exclude(:name=>pl.arg).limit(1)
-    end
-
-    loader.first(1, "foo")
-    # SELECT * FROM items WHERE ((id = 1) AND (name != 'foo')) LIMIT 1 
-
-    loader.first([1, 2], %w"foo bar")
-    # SELECT * FROM items WHERE ((id IN (1, 2)) AND
-    #   (name NOT IN ('foo', 'bar'))) LIMIT 1
-
-  There is also a higher level model API (Model.finder):
-
-    class Item < Sequel::Model
-      # Given class method that returns a dataset
-      def self.by_id_and_not_name(id, not_name)
-        where(:id=>id).exclude(:name=>not_name)
-      end
-
-      # Create optimized method that returns first value
-      finder :by_id_and_not_name
-    end
-    
-    # Call optimized method
-    Album.first_by_id_and_not_name(1, 'foo')
-    # SELECT * FROM items WHERE ((id = 1) AND (name != 'foo')) LIMIT 1 
-
-  Model.finder defaults to creating a method that returns the first
-  matching row, but using the :type option you can create methods
-  that call each, all, or get.  There is also an option to choose the
-  method name (:name), as well as one to specify the number of
-  arguments to use if the method doesn't take a fixed number
-  (:arity).
-
-  Finally, Model.find, .first, and .first! now automatically use an
-  optimized finder if given a single argument. Model.[] uses an
-  optimized finder if given a single hash, and Model.[], .with_pk,
-  and .with_pk! use an optimized finder if the model has a composite
-  primary key.  In all of these cases, these methods are about 50%
-  faster than before.
-
-* The pure-ruby PostgreSQL array parser that ships with Sequel has
-  been replaced with a strscan-based parser.  This parser avoids
-  O(n^2) performance for arrays with multibyte strings, and in general
-  is much faster.  Parsing an array with a single string with 100,000
-  multibyte characters is about 1000x faster, and now about half the
-  speed of the C implementation in sequel_pg.
-
-* Dataset#paged_each now has a :strategy=>:filter option that
-  dramatically improves performance, especially if the columns
-  being ordered by are indexed.
-
-  Unfortunately, there are enough corner cases to this approach
-  that it cannot be used by default.  At the least, the dataset
-  needs to be selecting the columns it is ordering by, not aliasing
-  the columns it is ordering by in the SELECT clause, not have
-  NULLs in any of the columns being ordered by, and not itself use
-  a limit or offset.
-
-  If you are ordering by expressions that are not simple column
-  values, you can provide a :filter_value option proc that takes the
-  last retrieved row and array of order by expressions, and returns 
-  an array of values in the last retrieved row for those order by
-  expressions.
-
-* In the postgres adapter, Dataset#paged_each now automatically uses
-  a cursor for improved performance.
-
-* In the mysql2 adapter, Dataset#paged_each now automatically uses
-  streaming for improved performance, if streaming is supported.
-
-* Dataset#with_sql_{each,all,first,single_value,insert,update}
-  have been added.  These methods take specific SQL and execute
-  it on the database, returning the appropriate value.  They
-  are significantly faster than the previous approach of
-  with_sql(SQL).{each,all,first,single_value,insert,update},
-  as they don't require cloning the dataset.
-
-= New Features
-
-* Database#create_join_table! and #create_join_table? have been added,
-  for consistency with #create_table! and #create_table?.
-
-* A :hold option has been added to Dataset#use_cursor in the postgres
-  adapter, which uses WITH HOLD in the query, allowing for usage of
-  the cursor outside the enclosing transaction.  When :hold is used,
-  Sequel does not automatically use a transaction around the cursor
-  call.
-
-* Dataset#where_current_of has been added to the postgres adapter,
-  for updating rows based on a cursor's current position.  This can
-  be used to update a large dataset where new values depend on
-  some ruby method, without keeping all rows in memory.
-
-    ds = DB[:huge_table]
-    ds.use_cursor(:rows_per_fetch=>1).each do |row|
-      ds.where_current_of.update(:column=>ruby_method(row))
-    end
-
-* A current_datetime_timestamp extension has been added, for
-  creating Time/DateTime instances that are literalized as
-  CURRENT_TIMESTAMP.  When the dataset uses this extension, models
-  that use the touch and timestamps plugins will use
-  CURRENT_TIMESTAMP for the timestamps.
-
-* The jdbc adapter now supports a :driver option, useful when
-  Sequel doesn't have direct support for the underlying driver, and
-  where java.sql.DriverManager.getConnection does not work
-  correctly due to Java class loading issues.
-
-= Other Improvements
-
-* Multiple corner cases in Dataset#eager_graph have been fixed.
-
-* Calling Dataset#columns when using the eager_each plugin no
-  longer triggers eager loading.
-
-* Database#column_schema_to_ruby_default is now a public method
-  in the schema_dumper extension.
-
-* When validating associated objects for one_to_many and one_to_one
-  associations in the nested_attributes plugin, don't remove column
-  values if the association's foreign key is the associated model's
-  primary key.
-
-* On PostgreSQL, Dataset#disable_insert_returning has been added
-  back.  This disables the automatic use of RETURNING for INSERTs
-  for the dataset.  This is necessary in cases where INSERT
-  RETURNING doesn't work, such as PostgreSQL <8.2 (or PostgreSQL
-  variants that forked before 8.2), or when using partitioning
-  with trigger functions, or conditional rules.
-
-  Note that if you use disable_insert_returning, insert will not
-  return the autoincremented primary key.  You need to call
-  currval or lastval manually using the same connection to get
-  the value, or use nextval to get the value to use before
-  inserting.
-
-* The pg_array extension now uses the correct database type when
-  typecasting values for smallint, oid, real, character, and varchar
-  arrays.  Previously, Sequel did not use the correct database type
-  in some cases (e.g. text[] for a varchar[]), which resulted in
-  errors if the value was used in a filter expression.
-
-* Additional unique constraint violations are now recognized on
-  SQLite.
-
-* Check constraint violations are now recognized on SQLite >=3.8.2.
-
-* Adapters that emulate bitwise operators now do so using an append
-  only design, similar to how all other queries are built in Sequel.
-
-= Backwards Compatibility
-
-* In some cases Sequel no longer adds superfluous parentheses when
-  constructing SQL strings.  If you are testing for specific SQL,
-  this can cause test failures.
-
-* The pg_array extension no longer recognizes the :typecast_method
-  option when registering an array type.  The option allowed reuse
-  of an existing typecast method, but as that results in an incorrect
-  type at the database level, the option was fundementally broken.
-
-* The internals of the PostgreSQL array parser have changed.  If you
-  were relying on them, you'll need to update your code.
-
-* Dataset#complex_expression_arg_pairs private method now returns
-  nested expression objects instead of an already literalized string
-  in some cases.  Custom adapters that call this method will probably
-  need to be changed.  It's recommended that such adapters switch to
-  using the new Dataset#complex_expression_emulate_append method if
-  possible.

data/spec/adapter_spec.rb

@@ -1,4 +0,0 @@
-if !ARGV.empty? && ARGV.first != 'none'
-  require_relative "adapters/#{ARGV.first}_spec"
-end
-Dir['./spec/integration/*_test.rb'].each{|f| require f}

data/spec/adapters/db2_spec.rb

@@ -1,170 +0,0 @@
-SEQUEL_ADAPTER_TEST = :db2
-
-require_relative 'spec_helper'
-
-if DB.table_exists?(:test)
-  DB.drop_table(:test)
-end
-
-describe Sequel::Database do
-  before do
-    @db = DB
-    @db.create_table(:test){String :a}
-    @ds = @db[:test]
-  end
-
-  after do
-    @db.drop_table(:test)
-  end
-  
-  it "should provide disconnect functionality after preparing a connection" do
-    @ds.prepare(:first, :a).call
-    @db.disconnect
-    @db.pool.size.must_equal 0
-  end
-
-  it "should return version correctly" do
-    @db.db2_version.must_match(/DB2 v/i)
-  end
-end
-
-describe "Simple Dataset operations" do
-  before(:all) do
-    DB.use_clob_as_blob = true
-    DB.create_table!(:items) do
-      Integer :id, :primary_key => true
-      Integer :number
-      column  :bin_string, 'varchar(20) for bit data'
-      column  :bin_clob, 'clob'
-    end
-    @ds = DB[:items]
-  end
-  after(:each) do
-    @ds.delete
-  end
-  after(:all) do
-    DB.use_clob_as_blob = false
-    DB.drop_table(:items)
-  end
-
-  it "should insert with a primary key specified" do
-    @ds.insert(:id => 1,   :number => 10)
-    @ds.insert(:id => 100, :number => 20)
-    @ds.select_hash(:id, :number).must_equal(1 => 10, 100 => 20)
-  end
-
-  it "should insert into binary columns" do
-    @ds.insert(:id => 1, :bin_string => Sequel.blob("\1"), :bin_clob => Sequel.blob("\2"))
-    @ds.select(:bin_string, :bin_clob).first.must_equal(:bin_string => "\1", :bin_clob => "\2")
-  end
-end
-
-describe Sequel::Database do
-  before do
-    @db = DB
-  end
-  after do
-    @db.drop_table(:items)
-  end
-
-  it "should parse primary keys from the schema properly" do
-    @db.create_table!(:items){Integer :number}
-    @db.schema(:items).collect{|k,v| k if v[:primary_key]}.compact.must_equal []
-    @db.create_table!(:items){primary_key :number}
-    @db.schema(:items).collect{|k,v| k if v[:primary_key]}.compact.must_equal [:number]
-    @db.create_table!(:items){Integer :number1, :null => false; Integer :number2, :null => false; primary_key [:number1, :number2]}
-    @db.schema(:items).collect{|k,v| k if v[:primary_key]}.compact.must_equal [:number1, :number2]
-  end
-
-  it "should not error on alter_table operations that need REORG" do
-    @db.create_table!(:items) do
-      varchar :a
-    end
-    @db.alter_table(:items) do
-      add_column :b, :varchar, :null => true
-      set_column_allow_null :a, false
-      add_index :a, :unique => true
-    end
-  end
-end
-
-describe "Sequel::IBMDB::Database#convert_smallint_to_bool" do
-  before do
-    @db = DB
-    @db.create_table!(:booltest){column :b, 'smallint'; column :i, 'integer'}
-    @ds = @db[:booltest]
-  end
-  after do
-    @db.convert_smallint_to_bool = true
-    @db.drop_table(:booltest)
-  end
-  
-  it "should consider smallint datatypes as boolean if set, but not larger smallints" do
-    @db.schema(:booltest, :reload=>true).first.last[:type].must_equal :boolean
-    @db.schema(:booltest, :reload=>true).first.last[:db_type].must_match /smallint/i
-    @db.convert_smallint_to_bool = false
-    @db.schema(:booltest, :reload=>true).first.last[:type].must_equal :integer
-    @db.schema(:booltest, :reload=>true).first.last[:db_type].must_match /smallint/i
-  end
-  
-  it "should return smallints as bools and integers as integers when set" do
-    @db.convert_smallint_to_bool = true
-    @ds.delete
-    @ds.insert(:b=>true, :i=>10)
-    @ds.all.must_equal [{:b=>true, :i=>10}]
-    @ds.delete
-    @ds.insert(:b=>false, :i=>0)
-    @ds.all.must_equal [{:b=>false, :i=>0}]
-    @ds.delete
-    @ds.insert(:b=>true, :i=>1)
-    @ds.all.must_equal [{:b=>true, :i=>1}]
-
-    @ds = @ds.with_convert_smallint_to_bool(false)
-    @ds.delete
-    @ds.insert(:b=>true, :i=>10)
-    @ds.all.must_equal [{:b=>1, :i=>10}]
-  end
-
-  it "should return all smallints as integers when unset" do
-    @db.convert_smallint_to_bool = false
-    @ds.delete
-    @ds.insert(:b=>true, :i=>10)
-    @ds.all.must_equal [{:b=>1, :i=>10}]
-    @ds.delete
-    @ds.insert(:b=>false, :i=>0)
-    @ds.all.must_equal [{:b=>0, :i=>0}]
-    
-    @ds.delete
-    @ds.insert(:b=>1, :i=>10)
-    @ds.all.must_equal [{:b=>1, :i=>10}]
-    @ds.delete
-    @ds.insert(:b=>0, :i=>0)
-    @ds.all.must_equal [{:b=>0, :i=>0}]
-
-    @ds = @ds.with_convert_smallint_to_bool(true)
-    @ds.delete
-    @ds.insert(:b=>true, :i=>10)
-    @ds.all.must_equal [{:b=>true, :i=>10}]
-  end
-end if DB.adapter_scheme == :ibmdb
-
-describe "Simple Dataset operations in transactions" do
-  before do
-    DB.create_table!(:items_insert_in_transaction) do
-      Integer :id, :primary_key => true
-      integer :number
-    end
-    @ds = DB[:items_insert_in_transaction]
-  end
-  after do
-    DB.drop_table(:items_insert_in_transaction)
-  end
-
-  it "should insert correctly with a primary key specified inside a transaction" do
-    DB.transaction do
-      @ds.insert(:id=>100, :number=>20)
-      @ds.count.must_equal 1
-      @ds.order(:id).all.must_equal [{:id=>100, :number=>20}]
-    end
-  end
-end