sequel 5.6.0 → 5.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG +30 -5099
- data/Rakefile +1 -1
- data/doc/opening_databases.rdoc +0 -2
- data/doc/postgresql.rdoc +31 -0
- data/doc/querying.rdoc +2 -2
- data/doc/release_notes/5.7.0.txt +108 -0
- data/doc/testing.rdoc +1 -0
- data/lib/sequel/adapters/jdbc/derby.rb +1 -1
- data/lib/sequel/adapters/jdbc/oracle.rb +11 -0
- data/lib/sequel/adapters/postgres.rb +1 -0
- data/lib/sequel/adapters/shared/postgres.rb +117 -13
- data/lib/sequel/connection_pool/sharded_threaded.rb +7 -6
- data/lib/sequel/connection_pool/threaded.rb +6 -6
- data/lib/sequel/core.rb +20 -0
- data/lib/sequel/database/logging.rb +3 -2
- data/lib/sequel/database/schema_generator.rb +1 -2
- data/lib/sequel/dataset/actions.rb +15 -5
- data/lib/sequel/extensions/connection_expiration.rb +3 -3
- data/lib/sequel/extensions/connection_validator.rb +3 -3
- data/lib/sequel/extensions/integer64.rb +30 -0
- data/lib/sequel/extensions/migration.rb +2 -3
- data/lib/sequel/plugins/pg_array_associations.rb +5 -3
- data/lib/sequel/plugins/validate_associated.rb +18 -0
- data/lib/sequel/version.rb +1 -1
- data/spec/adapters/mssql_spec.rb +6 -6
- data/spec/adapters/mysql_spec.rb +1 -1
- data/spec/adapters/oracle_spec.rb +15 -1
- data/spec/adapters/postgres_spec.rb +78 -1
- data/spec/adapters/spec_helper.rb +3 -1
- data/spec/bin_spec.rb +1 -0
- data/spec/core/dataset_spec.rb +10 -0
- data/spec/extensions/integer64_spec.rb +22 -0
- data/spec/extensions/pg_array_associations_spec.rb +14 -2
- data/spec/extensions/spec_helper.rb +1 -0
- data/spec/integration/associations_test.rb +4 -4
- data/spec/integration/dataset_test.rb +2 -0
- data/spec/integration/spec_helper.rb +5 -11
- data/spec/model/spec_helper.rb +1 -0
- metadata +35 -165
- data/doc/release_notes/1.0.txt +0 -38
- data/doc/release_notes/1.1.txt +0 -143
- data/doc/release_notes/1.3.txt +0 -101
- data/doc/release_notes/1.4.0.txt +0 -53
- data/doc/release_notes/1.5.0.txt +0 -155
- data/doc/release_notes/2.0.0.txt +0 -298
- data/doc/release_notes/2.1.0.txt +0 -271
- data/doc/release_notes/2.10.0.txt +0 -328
- data/doc/release_notes/2.11.0.txt +0 -215
- data/doc/release_notes/2.12.0.txt +0 -534
- data/doc/release_notes/2.2.0.txt +0 -253
- data/doc/release_notes/2.3.0.txt +0 -88
- data/doc/release_notes/2.4.0.txt +0 -106
- data/doc/release_notes/2.5.0.txt +0 -137
- data/doc/release_notes/2.6.0.txt +0 -157
- data/doc/release_notes/2.7.0.txt +0 -166
- data/doc/release_notes/2.8.0.txt +0 -171
- data/doc/release_notes/2.9.0.txt +0 -97
- data/doc/release_notes/3.0.0.txt +0 -221
- data/doc/release_notes/3.1.0.txt +0 -406
- data/doc/release_notes/3.10.0.txt +0 -286
- data/doc/release_notes/3.11.0.txt +0 -254
- data/doc/release_notes/3.12.0.txt +0 -304
- data/doc/release_notes/3.13.0.txt +0 -210
- data/doc/release_notes/3.14.0.txt +0 -118
- data/doc/release_notes/3.15.0.txt +0 -78
- data/doc/release_notes/3.16.0.txt +0 -45
- data/doc/release_notes/3.17.0.txt +0 -58
- data/doc/release_notes/3.18.0.txt +0 -120
- data/doc/release_notes/3.19.0.txt +0 -67
- data/doc/release_notes/3.2.0.txt +0 -268
- data/doc/release_notes/3.20.0.txt +0 -41
- data/doc/release_notes/3.21.0.txt +0 -87
- data/doc/release_notes/3.22.0.txt +0 -39
- data/doc/release_notes/3.23.0.txt +0 -172
- data/doc/release_notes/3.24.0.txt +0 -420
- data/doc/release_notes/3.25.0.txt +0 -88
- data/doc/release_notes/3.26.0.txt +0 -88
- data/doc/release_notes/3.27.0.txt +0 -82
- data/doc/release_notes/3.28.0.txt +0 -304
- data/doc/release_notes/3.29.0.txt +0 -459
- data/doc/release_notes/3.3.0.txt +0 -192
- data/doc/release_notes/3.30.0.txt +0 -135
- data/doc/release_notes/3.31.0.txt +0 -146
- data/doc/release_notes/3.32.0.txt +0 -202
- data/doc/release_notes/3.33.0.txt +0 -157
- data/doc/release_notes/3.34.0.txt +0 -671
- data/doc/release_notes/3.35.0.txt +0 -144
- data/doc/release_notes/3.36.0.txt +0 -245
- data/doc/release_notes/3.37.0.txt +0 -338
- data/doc/release_notes/3.38.0.txt +0 -234
- data/doc/release_notes/3.39.0.txt +0 -237
- data/doc/release_notes/3.4.0.txt +0 -325
- data/doc/release_notes/3.40.0.txt +0 -73
- data/doc/release_notes/3.41.0.txt +0 -155
- data/doc/release_notes/3.42.0.txt +0 -74
- data/doc/release_notes/3.43.0.txt +0 -105
- data/doc/release_notes/3.44.0.txt +0 -152
- data/doc/release_notes/3.45.0.txt +0 -179
- data/doc/release_notes/3.46.0.txt +0 -122
- data/doc/release_notes/3.47.0.txt +0 -270
- data/doc/release_notes/3.48.0.txt +0 -477
- data/doc/release_notes/3.5.0.txt +0 -510
- data/doc/release_notes/3.6.0.txt +0 -366
- data/doc/release_notes/3.7.0.txt +0 -179
- data/doc/release_notes/3.8.0.txt +0 -151
- data/doc/release_notes/3.9.0.txt +0 -233
data/doc/release_notes/2.9.0.txt
DELETED
@@ -1,97 +0,0 @@
|
|
1
|
-
New Features
|
2
|
-
------------
|
3
|
-
|
4
|
-
* Compound SQL statement (i.e. UNION, EXCEPT, and INTERSECT) support
|
5
|
-
is much improved. Chaining compound statement calls now longer
|
6
|
-
wipes out previous compound statements calls of the same type.
|
7
|
-
Also, the ordering of the compound statements is no longer fixed
|
8
|
-
per adapter, it now reflects the order they were called on the
|
9
|
-
object. For example, the following now work as expected:
|
10
|
-
|
11
|
-
ds1.union(ds2).union(ds3)
|
12
|
-
ds1.except(ds2).except(ds3)
|
13
|
-
ds1.intersect(ds2).intersect(ds3)
|
14
|
-
ds1.union(ds2).except(ds3)
|
15
|
-
ds1.except(ds2).intersect(ds3)
|
16
|
-
ds1.intersect(ds2).union(ds3)
|
17
|
-
|
18
|
-
* Exception classes ValidationFailure and BeforeHookFailure were
|
19
|
-
added so it is eaiser to catch a failed validation. These are
|
20
|
-
both subclasses of Sequel::Error, so there shouldn't be any
|
21
|
-
backwards compatibility issues. Error messages are also improved,
|
22
|
-
as the ValidationFailure message is a string containing all
|
23
|
-
validation failures and the BeforeHookFailure message contains
|
24
|
-
which hook type caused the failure (i.e. before_save,
|
25
|
-
before_create, or before_validate).
|
26
|
-
|
27
|
-
* The sequel command line tool now has a -L option to load
|
28
|
-
all files in the given directory. This is mainly useful for
|
29
|
-
loading a directory of model files. The files are loaded
|
30
|
-
after the database connection is set up.
|
31
|
-
|
32
|
-
* Methods to create and drop database functions, triggers, and
|
33
|
-
procedural languages were added to the PostgreSQL adapter.
|
34
|
-
|
35
|
-
Other Improvements
|
36
|
-
------------------
|
37
|
-
|
38
|
-
* Database#schema now raises an error if you pass a table that
|
39
|
-
doesn't exist. Before, some adapters would return an empty schema.
|
40
|
-
The bigger problem with this is that it made table_exists? return
|
41
|
-
the wrong value, since it looks at the Database's schema.
|
42
|
-
Generally, this bug would show up in the following code:
|
43
|
-
|
44
|
-
class Blah < Sequel::Model
|
45
|
-
end
|
46
|
-
Blah.table_exists? # True even if blahs is not a table
|
47
|
-
|
48
|
-
* AlterTableGenerator#add_foreign_key now works for MySQL.
|
49
|
-
|
50
|
-
* Error messages in model association methods that add/remove an
|
51
|
-
associated object are now more descriptive.
|
52
|
-
|
53
|
-
* Dataset#destroy for model datasets now works with databases that
|
54
|
-
can't handle nested queries. However, it now loads all model
|
55
|
-
objects being destroyed before attempting to destroy any of them.
|
56
|
-
|
57
|
-
* Dataset#count now works correctly for compound SQL statements
|
58
|
-
(i.e. UNION, EXCEPT, and INTERSECT).
|
59
|
-
|
60
|
-
* BigDecimal NaN and (+/-)Infinity values are now literalized
|
61
|
-
correctly. Database support for this is hit or miss. Sqlite will
|
62
|
-
work correctly, PostgreSQL raises an error if you try to store an
|
63
|
-
infinite value in a numeric column (though it works for float
|
64
|
-
columns), and MySQL converts all three to 0.
|
65
|
-
|
66
|
-
* The SQLite adapter no longer loses primary key information when
|
67
|
-
dropping columns.
|
68
|
-
|
69
|
-
* The SQLite adapter now supports dropping indicies.
|
70
|
-
|
71
|
-
* A bug in the MSSQL adapter's literalization of LiteralStrings has
|
72
|
-
been fixed.
|
73
|
-
|
74
|
-
* The literalization of blobs on PostgreSQL (bytea columns) has been
|
75
|
-
fixed.
|
76
|
-
|
77
|
-
* Sequel now raises an error if you attempt to subclass Sequel::Model
|
78
|
-
before setting up a database connection.
|
79
|
-
|
80
|
-
* The native postgresql adapter has been changed to only log client
|
81
|
-
messages of level WARNING by default. You can modify this via:
|
82
|
-
|
83
|
-
Sequel::Postgres.client_min_messages = nil # Use Server Default
|
84
|
-
Sequel::Postgres.client_min_messages = :notice # Use NOTICE level
|
85
|
-
|
86
|
-
* Model#inspect now calls Model#inspect_values for easier
|
87
|
-
overloading.
|
88
|
-
|
89
|
-
Backwards Compatibilty
|
90
|
-
----------------------
|
91
|
-
|
92
|
-
* The API to Model#save_failure (a private method) was changed to
|
93
|
-
remove the second argument.
|
94
|
-
|
95
|
-
* SQLite columns with type numeric, decimal, or money are now
|
96
|
-
returned as BigDecimal values. Before, they were probably returned
|
97
|
-
as strings.
|
data/doc/release_notes/3.0.0.txt
DELETED
@@ -1,221 +0,0 @@
|
|
1
|
-
Deprecated Methods/Features Removed
|
2
|
-
-----------------------------------
|
3
|
-
|
4
|
-
Methods and features that were deprecated in 2.12.0 have been removed
|
5
|
-
in 3.0.0. Many features were moved into plugins or extensions, so in
|
6
|
-
many cases you just need to require an extension or use Model.plugin
|
7
|
-
and not make any changes to your code. See the 2.12.0 release notes
|
8
|
-
for the list of methods/features deprecated in 2.12.0.
|
9
|
-
|
10
|
-
If you are upgrading from a previous 2.x release, please upgrade to
|
11
|
-
2.12.0 first, fix your code to remove all deprecation warnings, and
|
12
|
-
then upgrade to 3.0.0.
|
13
|
-
|
14
|
-
New Adapter
|
15
|
-
-----------
|
16
|
-
|
17
|
-
* Sequel now has an Amalgalite adapter. Amalgalite is a ruby
|
18
|
-
extension that embeds SQLite without requiring a separate SQLite
|
19
|
-
installation. The adapter is functionality complete but
|
20
|
-
significantly slower than the native SQLite adapter.
|
21
|
-
|
22
|
-
New Features
|
23
|
-
------------
|
24
|
-
|
25
|
-
* The JDBC, PostgreSQL, MySQL, and SQLite adapters all now have a
|
26
|
-
Database#indexes method that returns indexes for a given table:
|
27
|
-
|
28
|
-
DB.indexes(:songs)
|
29
|
-
=> {:songs_name_index=>{:unique=>true, :columns=>[:name]},
|
30
|
-
:songs_lyricid_index=>{:unique=>false, :columns=>[:lyricid]}}
|
31
|
-
|
32
|
-
* A schema_dumper extension was added to Sequel. It supports dumping
|
33
|
-
the schema of a table (including indexes) as a string that can be
|
34
|
-
evaluated in the context of a Database object to create the table.
|
35
|
-
It also supports dumping all tables in the database as a string
|
36
|
-
containing a Migration subclass that will rebuild the database.
|
37
|
-
|
38
|
-
require 'sequel/extensions/schema_dumper'
|
39
|
-
DB.dump_table_schema(:table)
|
40
|
-
DB.dump_schema_migration
|
41
|
-
DB.dump_schema_migration(:same_db=>true)
|
42
|
-
DB.dump_schema_migration(:indexes=>false)
|
43
|
-
DB.dump_indexes_migration
|
44
|
-
|
45
|
-
The :same_db option causes Sequel to not translate column types
|
46
|
-
to generic column types. By default, the migration created will
|
47
|
-
use generic types so it will run on other databases. However, if
|
48
|
-
you only want to support a single database, using the :same_db
|
49
|
-
option will make the migration use the exact database type parsed
|
50
|
-
from the database.
|
51
|
-
|
52
|
-
The :indexes=>false option causes indexes not be included in the
|
53
|
-
migration. The dump_indexes_migration can be used to create a
|
54
|
-
separate migration with the indexes. This can be useful if you
|
55
|
-
plan on loading a lot of data right after creating the tables,
|
56
|
-
since it is faster to add indexes after the data has been added.
|
57
|
-
|
58
|
-
* Using options with the generic database types is now supported to
|
59
|
-
a limited extent. For example, the following code now works:
|
60
|
-
|
61
|
-
DB.create_table(:table) do
|
62
|
-
String :a, :size=>50 # varchar(50)
|
63
|
-
String :b, :text=>true # text
|
64
|
-
String :c, :fixed=>true, :size=>30 # char(30)
|
65
|
-
Time :ts # timestamp
|
66
|
-
Time :t, :only_time=>true # time
|
67
|
-
end
|
68
|
-
|
69
|
-
* Using Dataset#filter and related methods with multiple arguments
|
70
|
-
now works much more intuitively:
|
71
|
-
|
72
|
-
# 2.12.0
|
73
|
-
dataset.filter(:a, :b=>1) # a IS NULL AND (b = 1) IS NULL
|
74
|
-
# 3.0.0
|
75
|
-
dataset.filter(:a, :b=>1) # a AND b = 1
|
76
|
-
|
77
|
-
* You can now create temporary tables by passing the :temp=>true
|
78
|
-
option to Database#create_table.
|
79
|
-
|
80
|
-
* The Oracle shared adapter now supports emulation of
|
81
|
-
autoincrementing primary keys by creating a sequence and a trigger,
|
82
|
-
similar to how the Firebird adapter works.
|
83
|
-
|
84
|
-
* The Database#database_type method was added that returns a symbol
|
85
|
-
specifying the database type being used. This can be different
|
86
|
-
than Database.adapter_scheme if you are using an adapter like
|
87
|
-
JDBC that allows connecting to multiple different types of
|
88
|
-
databases.
|
89
|
-
|
90
|
-
* Database#drop_index and related methods now support an options
|
91
|
-
hash that respects the :name option, so they can now be used to
|
92
|
-
drop an index that doesn't use the default index name.
|
93
|
-
|
94
|
-
* The PostgreSQL shared adapter now supports a
|
95
|
-
Database#reset_primary_key_sequence method to reset the
|
96
|
-
primary key sequence for a given table, based on code from
|
97
|
-
ActiveRecord.
|
98
|
-
|
99
|
-
* SQL::QualifiedIdentifiers can now be qualified, allowing you to do:
|
100
|
-
|
101
|
-
:column.qualify(:table).qualify(:schema)
|
102
|
-
|
103
|
-
* Using the :db_type=>'mssql' option with the DBI adapter will now
|
104
|
-
load the MSSQL support.
|
105
|
-
|
106
|
-
* The MySQL shared adapter now supports Dataset#full_text_sql, which
|
107
|
-
you can use in queries like the following:
|
108
|
-
|
109
|
-
ds.select(:table.*, ds.full_text_sql(:column, 'value').as(:ft))
|
110
|
-
|
111
|
-
Other Improvements
|
112
|
-
------------------
|
113
|
-
|
114
|
-
* Sequel will now release connections from the connection pool
|
115
|
-
automatically if they are held by a dead thread. This can happen
|
116
|
-
if you are using MRI 1.8 and you are heavily multithreaded or
|
117
|
-
you call Thread#exit! or similar method explicitly. Those methods
|
118
|
-
skip the execution of ensure blocks which normally release the
|
119
|
-
connections when the threads exit.
|
120
|
-
|
121
|
-
* Model#save will now always use the same server when refreshing data
|
122
|
-
after an insert. This fixes an issue when Sequel's master/slave
|
123
|
-
database support is used with models.
|
124
|
-
|
125
|
-
* SQL Array references are now quoted correctly, so code like this
|
126
|
-
now works:
|
127
|
-
|
128
|
-
:table__column.sql_subscript(1)
|
129
|
-
|
130
|
-
* The PostgreSQL shared adapter now handles sequences that need to be
|
131
|
-
quoted correctly (previously these were quoted twice).
|
132
|
-
|
133
|
-
* String quoting on Oracle no longer doubles backslashes.
|
134
|
-
|
135
|
-
* Database#count now works correctly when used on MSSQL when using
|
136
|
-
an adapter that doesn't handle unnamed columns.
|
137
|
-
|
138
|
-
* Full text searching in the MySQL adapter now works correctly when
|
139
|
-
multiple search terms are used.
|
140
|
-
|
141
|
-
* Altering a column's name, type, default, or NULL/NOT NULL status
|
142
|
-
on MySQL now keeps other relevent column information. For example,
|
143
|
-
if you alter a column's type, it'll keep an existing default. This
|
144
|
-
functionality isn't complete, there may be other column information
|
145
|
-
that is lost.
|
146
|
-
|
147
|
-
* Fix creation of an index with a given type on MySQL, since MySQL's
|
148
|
-
documentation lies.
|
149
|
-
|
150
|
-
* The schema parser now handles decimal types with size specifiers,
|
151
|
-
fixing use on MySQL.
|
152
|
-
|
153
|
-
* Dataset#quote_identifier now works correctly when given an
|
154
|
-
SQL::Identifier. This allows you to do:
|
155
|
-
|
156
|
-
dataset.select{sum(hours).as(hours)}
|
157
|
-
|
158
|
-
Backwards Compatibility
|
159
|
-
-----------------------
|
160
|
-
|
161
|
-
* Sequel will now use instance_eval on all virtual row blocks without
|
162
|
-
an argument. This can lead to much nicer code:
|
163
|
-
|
164
|
-
dataset.filter{(number > 10) & (name > 'M')}
|
165
|
-
# WHERE number > 10 AND name > 'M'
|
166
|
-
|
167
|
-
2.12.0 raised a deprecation warning if you used a virtual row block
|
168
|
-
without an argument and you hadn't set
|
169
|
-
Sequel.virtual_row_instance_eval = true.
|
170
|
-
|
171
|
-
* Dataset#exclude now inverts the given argument, instead of negating
|
172
|
-
it. This only changes its behavior if it is called with a hash or
|
173
|
-
array of all two pairs that have more than one element.
|
174
|
-
|
175
|
-
# 2.12.0
|
176
|
-
dataset.exclude(:a=>1, :b=>1) # a != 1 AND b != 1
|
177
|
-
# 3.0.0
|
178
|
-
dataset.exclude(:a=>1, :b=>1) # a != 1 OR b != 1
|
179
|
-
|
180
|
-
This was done for consistency, since exclude would only negate a
|
181
|
-
hash if it was given an argument, it would invert the same hash
|
182
|
-
if you used a block:
|
183
|
-
|
184
|
-
# 2.12.0
|
185
|
-
dataset.exclude{{:a=>1, :b=>1}} # a != 1 OR b != 1
|
186
|
-
|
187
|
-
If you want the previous behavior,
|
188
|
-
change the code to the following:
|
189
|
-
|
190
|
-
dataset.filter({:a=>1, :b=>1}.sql_negate)
|
191
|
-
|
192
|
-
* As noted above, the methods/features deprecated in 2.12.0 were
|
193
|
-
removed.
|
194
|
-
|
195
|
-
* The private Dataset#select_*_sql methods now only take a single
|
196
|
-
argument, the SQL string being built.
|
197
|
-
|
198
|
-
* Dataset#from when called without arguments would previously cause an
|
199
|
-
error to be raised when the SQL string is generated. Now it causes
|
200
|
-
no FROM clause to be used, similar to how Dataset#select with no
|
201
|
-
arguments causes SELECT * to be used.
|
202
|
-
|
203
|
-
* The internals of the generic type support and the schema generators
|
204
|
-
were changed significantly, which could have some fallout in terms
|
205
|
-
of old migrations breaking if they used the generic types and were
|
206
|
-
relying on some undocumented behavior (such as using Integer as a
|
207
|
-
type with the :unsigned option).
|
208
|
-
|
209
|
-
* The Firebird adapter no longer translates the text database
|
210
|
-
specific type. Use the following instead:
|
211
|
-
|
212
|
-
String :column, :text=>true
|
213
|
-
|
214
|
-
* The MySQL shared adapter used to use the timestamp type for Time,
|
215
|
-
now it uses datetime. This is because the timestamp type cannot
|
216
|
-
represent everything that the ruby Time class can represent.
|
217
|
-
|
218
|
-
* Metaprogramming#metaattr_accessor and #metaattr_reader methods were
|
219
|
-
removed.
|
220
|
-
|
221
|
-
* Dataset#irregular_function_sql was removed.
|
data/doc/release_notes/3.1.0.txt
DELETED
@@ -1,406 +0,0 @@
|
|
1
|
-
New Plugins
|
2
|
-
-----------
|
3
|
-
|
4
|
-
3 new plugins were added that implement features supported by
|
5
|
-
DataMapper: identity_map, tactical_eager_loading, and
|
6
|
-
lazy_attributes. These plugins don't add any real new features,
|
7
|
-
since you can do most of what they allow before simply by being
|
8
|
-
a little more explicit in your Sequel code. However, some people
|
9
|
-
prefer a less explicit approach that uses a bit more magic, and
|
10
|
-
now Sequel can accomodate them.
|
11
|
-
|
12
|
-
* The identity_map plugin allows you to create a 1-1
|
13
|
-
correspondence of model objects to database rows via a temporary
|
14
|
-
thread-local identity map. It makes the following statment true:
|
15
|
-
|
16
|
-
Sequel::Model.with_identity_map do
|
17
|
-
Album.filter{(id > 0) & (id < 2)}.first.object_id == \
|
18
|
-
Album.first(:id=>1).object_id
|
19
|
-
end
|
20
|
-
|
21
|
-
As the code above implies, you need to use the with_identity_map
|
22
|
-
method with a block to use the identity mapping feature.
|
23
|
-
|
24
|
-
By itself, identity maps don't offer much, but Sequel uses them
|
25
|
-
as a cache when looking up objects by primary key or looking up
|
26
|
-
many_to_one associated objects. Basically, it can be used as a
|
27
|
-
performance enhancer, and it also allows the support of the
|
28
|
-
lazy_attributes plugin.
|
29
|
-
|
30
|
-
The identity_map plugin is expected to be most useful in web
|
31
|
-
applications. With that in mind, here's a Rack middleware that
|
32
|
-
wraps each request in a with_identity_map call, so the
|
33
|
-
identity_map features are available inside the web app:
|
34
|
-
|
35
|
-
Sequel::Model.plugin :identity_map
|
36
|
-
class SequelIdentityMap
|
37
|
-
def initialize(app)
|
38
|
-
@app = app
|
39
|
-
end
|
40
|
-
def call(env)
|
41
|
-
Sequel::Model.with_identity_map{@app.call(env)}
|
42
|
-
end
|
43
|
-
end
|
44
|
-
|
45
|
-
* The tactical_eager_loading plugin allows you to eagerly load an
|
46
|
-
association for all models retrieved in the same group whenever
|
47
|
-
one of the models accesses the association:
|
48
|
-
|
49
|
-
# 2 queries total
|
50
|
-
Album.filter{id<100}.all do |a|
|
51
|
-
a.artists
|
52
|
-
end
|
53
|
-
|
54
|
-
In order for this correctly, you must use Dataset#all to load the
|
55
|
-
records, you cannot iterate over them via Dataset#each. This is
|
56
|
-
because eager loading requires that you have all records in
|
57
|
-
advance, and when using Dataset#each you cannot know about later
|
58
|
-
records in the dataset.
|
59
|
-
|
60
|
-
Before, you could just be explicit about the associations you
|
61
|
-
needed and make sure to eagerly load them using eager before
|
62
|
-
calling Dataset#all.
|
63
|
-
|
64
|
-
* The lazy_attributes plugin builds on the identity_map and
|
65
|
-
tactical_eager_loading plugins and allows you to create
|
66
|
-
attributes that are lazily loaded from the database:
|
67
|
-
|
68
|
-
Album.plugin :lazy_attributes, :review
|
69
|
-
|
70
|
-
This will remove the :review attribute from being selected by
|
71
|
-
default. If you try to access the attribute after it is selected,
|
72
|
-
it'll retrieve the value from the database. If the object was
|
73
|
-
retrieved with a group of other objects and an identity map is in
|
74
|
-
use, it'll retrieve the lazy attribute for the entire group of
|
75
|
-
objects at once, similar to the tatical_eager_loading plugin:
|
76
|
-
|
77
|
-
# 2 queries total
|
78
|
-
Sequel::Model.with_identity_map do
|
79
|
-
Album.filter{id<100}.all do |a|
|
80
|
-
a.review
|
81
|
-
end
|
82
|
-
end
|
83
|
-
|
84
|
-
Before, you could just set the default selected columns for a model
|
85
|
-
to not include the lazy attributes, and just use select_more to
|
86
|
-
add them to any query where the resulting model objects will
|
87
|
-
need the attributes.
|
88
|
-
|
89
|
-
* A many_through_many plugin was also added. This very powerful
|
90
|
-
plugin allows you to create associations to multiple objects through
|
91
|
-
multiple join tables. Here are some examples:
|
92
|
-
|
93
|
-
# Assume the following many to many associations:
|
94
|
-
Artist.many_to_many :albums
|
95
|
-
Album.many_to_many :tags
|
96
|
-
|
97
|
-
# Same as Artist.many_to_many :albums
|
98
|
-
Artist.many_through_many :albums,
|
99
|
-
[[:albums_artists, :artist_id, :album_id]]
|
100
|
-
|
101
|
-
# All tags associated to any album this artist is associated to
|
102
|
-
Artist.many_through_many :tags,
|
103
|
-
[[:albums_artists, :artist_id, :album_id],
|
104
|
-
[:albums, :id, :id],
|
105
|
-
[:albums_tags, :album_id, :tag_id]]
|
106
|
-
|
107
|
-
# All artists associated to any album this artist is associated to
|
108
|
-
Artist.many_through_many :artists,
|
109
|
-
[[:albums_artists, :artist_id, :album_id],
|
110
|
-
[:albums, :id, :id],
|
111
|
-
[:albums_artists, :album_id, :artist_id]]
|
112
|
-
|
113
|
-
# All albums by artists that are associated to any album this
|
114
|
-
# artist is associated to
|
115
|
-
Artist.many_through_many :artist_albums,
|
116
|
-
[[:albums_artists, :artist_id, :album_id],
|
117
|
-
[:albums, :id, :id],
|
118
|
-
[:albums_artists, :album_id, :artist_id],
|
119
|
-
[:artists, :id, :id],
|
120
|
-
[:albums_artists, :artist_id, :album_id]]
|
121
|
-
|
122
|
-
Basically, for each join table between this model and the
|
123
|
-
associated model, you use an array with a join table name, left key
|
124
|
-
name (key closer to this model), and right key name (key closer to
|
125
|
-
the associated model).
|
126
|
-
|
127
|
-
In usual Sequel fashion, this association type works not just
|
128
|
-
for single objects, but it can also be eagerly loaded via eager or
|
129
|
-
eager_graph. There are numerous additional configuration options,
|
130
|
-
please see the RDoc for details.
|
131
|
-
|
132
|
-
New bin/sequel Features
|
133
|
-
-----------------------
|
134
|
-
|
135
|
-
The bin/sequel command line tool now supports the following options:
|
136
|
-
|
137
|
-
* -C: Copies one database to another. You must specify two database
|
138
|
-
arguments. Works similar to Taps, copying the table schema, then
|
139
|
-
the table data, then creating the indexes.
|
140
|
-
|
141
|
-
* -d: Dump the schema of the database in the database-independent
|
142
|
-
migration format.
|
143
|
-
|
144
|
-
* -D: Dump the schema of the database in the database-specific
|
145
|
-
migration format.
|
146
|
-
|
147
|
-
* -h: Display the help
|
148
|
-
|
149
|
-
* -t: Output the full backtrace if an exception is raised
|
150
|
-
|
151
|
-
The bin/sequel tool is now better about checking which options can
|
152
|
-
be used together. It also now supports using the -L option multiple
|
153
|
-
times and having it load model files from multiple directory trees.
|
154
|
-
|
155
|
-
New Features
|
156
|
-
------------
|
157
|
-
|
158
|
-
* Dataset#qualify_to and #qualify_to_first_source were added. They
|
159
|
-
allow you to qualify unqualified columns in the current dataset
|
160
|
-
to the given table or the first source. This can be used to join
|
161
|
-
a dataset that has unqualified columns to a new table which has
|
162
|
-
columns with the same name.
|
163
|
-
|
164
|
-
For example, take this dataset:
|
165
|
-
|
166
|
-
ds = DB[:albums].select(:name).order(:name).filter(:id=>1)
|
167
|
-
# SELECT name FROM albums WHERE (id = 1) ORDER BY name
|
168
|
-
|
169
|
-
Let's say you want to join it to the artists table:
|
170
|
-
|
171
|
-
ds2 = ds.join(:artists, :id=>:artist_id)
|
172
|
-
# SELECT name FROM albums
|
173
|
-
# INNER JOIN artists ON (artists.id = albums.artist_id)
|
174
|
-
# WHERE (id = 1) ORDER BY name
|
175
|
-
|
176
|
-
That's going to give you an error, as the artists table already has
|
177
|
-
columns named id and name. This new feature allows you to do the
|
178
|
-
following:
|
179
|
-
|
180
|
-
ds2 = ds.qualify_to_first_source.join(:artists, :id=>:artist_id)
|
181
|
-
# SELECT albums.name FROM albums
|
182
|
-
# INNER JOIN artists ON (artists.id = albums.artist_id)
|
183
|
-
# WHERE (albums.id = 1) ORDER BY albums.name
|
184
|
-
|
185
|
-
By doing this, all unqualified columns are qualified, so you get
|
186
|
-
a usable query. This is expected to be most useful for users that
|
187
|
-
have a default order or filter on their models and want to join
|
188
|
-
the model to another table. Before you had to replace the filters,
|
189
|
-
selection, etc. manually, or use qualified columns by default even
|
190
|
-
though the weren't needed in most cases.
|
191
|
-
|
192
|
-
* Savepoints are now supported using SQLite and MySQL, assuming you
|
193
|
-
are using a database version that supports them. You need to
|
194
|
-
pass the :savepoint option to Database#transaction to use a
|
195
|
-
savepoint.
|
196
|
-
|
197
|
-
* Model plugins can now depend on other plugins, simply by calling
|
198
|
-
the Model.plugin method inside the plugin's apply method:
|
199
|
-
|
200
|
-
module LazyAttributes
|
201
|
-
def self.apply(model)
|
202
|
-
model.plugin :tactical_eager_loading
|
203
|
-
end
|
204
|
-
|
205
|
-
* Model.plugin now takes a block with is passed to the plugin's
|
206
|
-
apply and configure method (see Backwards Compatibility section for
|
207
|
-
more information on the configure method).
|
208
|
-
|
209
|
-
* You can see which plugins are loaded for a model by using
|
210
|
-
Model.plugins.
|
211
|
-
|
212
|
-
* You can use Sequel.extension method to load extensions:
|
213
|
-
|
214
|
-
Sequel.extension :pagination, :query
|
215
|
-
|
216
|
-
This will only load extensions that ship with Sequel, unlike the
|
217
|
-
Model.plugin method which will also load external plugins.
|
218
|
-
|
219
|
-
* You can now use Database#create_table? to create the table if it
|
220
|
-
doesn't already exist (a very common need, it seems). The schema
|
221
|
-
plugin now supports Model.create_table? as well.
|
222
|
-
|
223
|
-
* #sql_subscript is now an allowed method on most SQL expression
|
224
|
-
objects that Sequel generates. Also, arguments to #sql_subscript
|
225
|
-
can now be other expressions instead of just integers.
|
226
|
-
|
227
|
-
* Associations can now take a :cartesian_product_number option, which
|
228
|
-
can be used to tell Sequel whether to turn on duplicate object
|
229
|
-
detection when eagerly loading objects through eager_graph. This
|
230
|
-
number should be 0 if the association can never create multiple
|
231
|
-
rows for each row in the current table, 1 if it can create multiple
|
232
|
-
rows in the each row in the current table, and 2 if the association
|
233
|
-
itself causes a cartesian product.
|
234
|
-
|
235
|
-
* On MySQL, Dataset#insert_ignore now affects #insert as well as
|
236
|
-
multi_insert and import.
|
237
|
-
|
238
|
-
* Database#create_table now supports an :ignore_index_errors option,
|
239
|
-
and Database#add_index now supports an :ignore_errors option.
|
240
|
-
These are used by the schema_dumper when dumping an database
|
241
|
-
schema to be restored on another database type, since indexes
|
242
|
-
aren't usually required for proper operation and some indexes
|
243
|
-
can't be transferred.
|
244
|
-
|
245
|
-
* The ADO adapter now takes a :provider option, which can be used
|
246
|
-
to set the provider.
|
247
|
-
|
248
|
-
* The ADO adapter now takes a :command_timeout option, which tells
|
249
|
-
the connection how long to wait before giving up and raising an
|
250
|
-
exception.
|
251
|
-
|
252
|
-
* The Sequel.amalgalite adapter method was added. Like the
|
253
|
-
Sequel.sqlite method, you can call it with no arguments to get
|
254
|
-
an in memory database.
|
255
|
-
|
256
|
-
Other Improvements
|
257
|
-
------------------
|
258
|
-
|
259
|
-
* MySQL "commands out of sync" errors should no longer occur unless
|
260
|
-
you are nesting queries (calling Dataset#each inside Dataset#each).
|
261
|
-
A bug dating at least to 2007 and possibly since the initial
|
262
|
-
creation of the Sequel MySQL adapter was the cause. Before, SQL
|
263
|
-
that caused a result set that was sent using a method where Sequel
|
264
|
-
doesn't yield a result set would cause the "commands out of sync"
|
265
|
-
error on the following query. For example, the following code
|
266
|
-
would cause the error:
|
267
|
-
|
268
|
-
DB << "SHOW DATABASES"
|
269
|
-
|
270
|
-
If for some reason a "commands out of sync" error does occur,
|
271
|
-
Sequel will disconnect the connection from the connection pool,
|
272
|
-
so it won't continually stay in the pool and raise errors every
|
273
|
-
time it is used.
|
274
|
-
|
275
|
-
* The schema_dumper extension is much better about parsing defaults
|
276
|
-
from the database. It can now correctly parse most defaults on
|
277
|
-
MySQL, SQLite, and PostgreSQL databases. It no longer includes
|
278
|
-
defaults that it can't parse to a ruby object unless a database-
|
279
|
-
specific dump is requested.
|
280
|
-
|
281
|
-
* The schema_dumper extension now dumps tables in alphabetical order.
|
282
|
-
|
283
|
-
* Ordered and limited datasets are now handled correctly when using
|
284
|
-
union, intersect, and except. Also, union, intersect, and except
|
285
|
-
now always return a from_self dataset, so further limiting,
|
286
|
-
filtering, and ordering of them now works as expected.
|
287
|
-
|
288
|
-
* Dataset#graph now works correctly with a complex dataset without
|
289
|
-
having to use from_self. Before, code like the following didn't
|
290
|
-
do what was expected:
|
291
|
-
|
292
|
-
DB[:albums].
|
293
|
-
graph(DB[:artists].filter{name > 'M'}, :id=>:artist_id)
|
294
|
-
|
295
|
-
Before, the filter on DB[:artists] would be dropped. Now, Sequel
|
296
|
-
correctly uses a subselect.
|
297
|
-
|
298
|
-
* You can now specify serialization formats per column in the
|
299
|
-
serialization plugin, either by calling the plugin multiple
|
300
|
-
times or by using the new serialize_attributes method:
|
301
|
-
|
302
|
-
Album.plugin :serialization
|
303
|
-
Album.serialize_attributes :marshal, :review
|
304
|
-
Album.serialize_attributes :yaml, :name
|
305
|
-
Album.serialization_map #{:name=>:yaml, :review=>:marshal}
|
306
|
-
|
307
|
-
The public API for the serialization plugin is still backwards
|
308
|
-
compatible, but the internals have changed slightly to support
|
309
|
-
this new feature.
|
310
|
-
|
311
|
-
* You can now use eager_graph to eagerly load associations for models
|
312
|
-
that lack primary keys.
|
313
|
-
|
314
|
-
* The :eager_graph association option now works when lazily-loading
|
315
|
-
many_to_many associations.
|
316
|
-
|
317
|
-
* Dataset#add_graph_aliases now works correctly even if
|
318
|
-
set_graph_aliases hasn't been used.
|
319
|
-
|
320
|
-
* The PostgreSQL Database#tables method now assumes the public schema
|
321
|
-
if a schema is not given and there is no default_schema.
|
322
|
-
|
323
|
-
* The PostgreSQL Database#indexes method no longer returns partial
|
324
|
-
indexes or functional indexes.
|
325
|
-
|
326
|
-
* The MySQL Database#indexes method no longer returns indexes on
|
327
|
-
partial columns (prefix indexes).
|
328
|
-
|
329
|
-
* Default values for String :text=>true and File columns on MySQL
|
330
|
-
are ignored, since MySQL doesn't support them. They are not
|
331
|
-
ignored if you use text and blob, since then you are using the
|
332
|
-
database-specific syntax and Sequel doesn't do translation when
|
333
|
-
the database-specific syntax is used.
|
334
|
-
|
335
|
-
* On PostgreSQL, attempting the reset the primary key sequence for a
|
336
|
-
table without a primary key no longer causes an error.
|
337
|
-
|
338
|
-
* Using a placeholder string in an association's :condition option
|
339
|
-
now works correctly (e.g. :conditions=>['n = ?', 1])
|
340
|
-
|
341
|
-
* An error is no longer raised if you attempt to load a plugin that
|
342
|
-
has a DatasetMethods module but no public dataset methods.
|
343
|
-
|
344
|
-
* The check for dataset[n] where n is an integer was fixed. It now
|
345
|
-
raises an error inside of returning a limited dataset.
|
346
|
-
|
347
|
-
* On PostgreSQL, Dataset#insert with static SQL now works correctly.
|
348
|
-
|
349
|
-
* A reflection.rdoc file was added giving an overview of Sequel's
|
350
|
-
reflection support.
|
351
|
-
|
352
|
-
* The Migrator now works correctly with file names like
|
353
|
-
001_12312412_file_name.rb.
|
354
|
-
|
355
|
-
* The association code now requires the classes match when looking
|
356
|
-
for a reciprocal association.
|
357
|
-
|
358
|
-
* An unlikely threading bug (race condition) was possible when using
|
359
|
-
the validation_class_methods plugin. The plugin was refactored and
|
360
|
-
now uses a mutex to avoid the issue. One of the refactoring changes
|
361
|
-
makes it so that you can no longer use a class level vaildation
|
362
|
-
inside a Class.new block (since inherited isn't called until the
|
363
|
-
block finishes).
|
364
|
-
|
365
|
-
* The exception messages when Sequel.string_to_* fail have been fixed.
|
366
|
-
|
367
|
-
* The String :text=>true generic database type has been fixed when
|
368
|
-
using the Firebird adapter.
|
369
|
-
|
370
|
-
Backwards Compatibility
|
371
|
-
-----------------------
|
372
|
-
|
373
|
-
* A plugin's apply method is now only called the first time a plugin
|
374
|
-
is loaded. Plugins can now have a configure method that is called
|
375
|
-
every time the plugin is loaded, and is always called after the
|
376
|
-
instance methods, class methods, and dataset method submodules have
|
377
|
-
been added to the model. This is different from apply, which is
|
378
|
-
called before the submodules are loaded.
|
379
|
-
|
380
|
-
If you are a plugin author, please check your implementation to
|
381
|
-
make sure this doesn't cause problems for you. If you have
|
382
|
-
questions, please post on the Sequel mailing list.
|
383
|
-
|
384
|
-
This new plugin feature will make certain things a lot easier, and
|
385
|
-
it should be mostly backwards compatible. However, if a plugin
|
386
|
-
was previously expected to be loaded multiple times with the apply
|
387
|
-
method called each time, it will no longer work correctly.
|
388
|
-
|
389
|
-
* The plugin_opts methods defined now include multiple args in an
|
390
|
-
array if multiple args are given. Before, the plugin_opts methods
|
391
|
-
just returned the first argument.
|
392
|
-
|
393
|
-
* Database#table_exists? no longer checks the cached schema
|
394
|
-
information. By default, it will always do a database query
|
395
|
-
(unless overridden in an adapter). This shouldn't affect the
|
396
|
-
results, but if were using the method a lot and expecting it to
|
397
|
-
use cached information, it doesn't have the same performance
|
398
|
-
characteristics.
|
399
|
-
|
400
|
-
* The internal storage of the :select option for datasets have
|
401
|
-
changed. You can no longer use a hash as a way of aliasing
|
402
|
-
columns. Dataset#select now does the translation from the hash to
|
403
|
-
SQL::AliasedExpression instances. Basically, if you were using
|
404
|
-
Dataset#clone directly with a :select option with hashes for
|
405
|
-
aliasing, you should switch to using Dataset#select or changing
|
406
|
-
the hashes to AliasedExpressions yourself.
|