Module | Sequel::Model::DatasetMethods |
In: |
lib/sequel/model/base.rb
|
Dataset methods are methods that the model class extends its dataset with in the call to set_dataset.
model | [RW] |
The model class associated with this dataset
Artist.dataset.model # => Artist |
Assume if a single integer is given that it is a lookup by primary key, and call with_pk with the argument.
Artist.dataset[1] # SELECT * FROM artists WHERE (id = 1) LIMIT 1
# File lib/sequel/model/base.rb, line 2224 2224: def [](*args) 2225: if args.length == 1 && (i = args.at(0)) && i.is_a?(Integer) 2226: with_pk(i) 2227: else 2228: super 2229: end 2230: end
Destroy each row in the dataset by instantiating it and then calling destroy on the resulting model object. This isn‘t as fast as deleting the dataset, which does a single SQL call, but this runs any destroy hooks on each object in the dataset.
Artist.dataset.destroy # DELETE FROM artists WHERE (id = 1) # DELETE FROM artists WHERE (id = 2) # ...
# File lib/sequel/model/base.rb, line 2241 2241: def destroy 2242: pr = proc{all{|r| r.destroy}.length} 2243: model.use_transactions ? @db.transaction(:server=>opts[:server], &pr) : pr.call 2244: end
Allow Sequel::Model classes to be used as dataset arguments when graphing:
Artist.graph(Album, :artist_id=>id) # SELECT artists.id, artists.name, albums.id AS albums_id, albums.artist_id, albums.name AS albums_name # FROM artists LEFT OUTER JOIN albums ON (albums.artist_id = artists.id)
# File lib/sequel/model/base.rb, line 2251 2251: def graph(table, *args, &block) 2252: if table.is_a?(Class) && table < Sequel::Model 2253: super(table.dataset, *args, &block) 2254: else 2255: super 2256: end 2257: end
Handle Sequel::Model instances when inserting, using the model instance‘s values for the insert, unless the model instance can be used directly in SQL.
Album.insert(Album.load(:name=>'A')) # INSERT INTO albums (name) VALUES ('A')
# File lib/sequel/model/base.rb, line 2265 2265: def insert_sql(*values) 2266: if values.size == 1 && (v = values.at(0)).is_a?(Sequel::Model) && !v.respond_to?(:sql_literal_append) 2267: super(v.to_hash) 2268: else 2269: super 2270: end 2271: end
Allow Sequel::Model classes to be used as table name arguments in dataset join methods:
Artist.join(Album, :artist_id=>id) # SELECT * FROM artists INNER JOIN albums ON (albums.artist_id = artists.id)
# File lib/sequel/model/base.rb, line 2278 2278: def join_table(type, table, *args, &block) 2279: if table.is_a?(Class) && table < Sequel::Model 2280: if table.dataset.simple_select_all? 2281: super(type, table.table_name, *args, &block) 2282: else 2283: super(type, table.dataset, *args, &block) 2284: end 2285: else 2286: super 2287: end 2288: end
If there is no order already defined on this dataset, order it by the primary key and call last.
Album.last # SELECT * FROM albums ORDER BY id DESC LIMIT 1
# File lib/sequel/model/base.rb, line 2295 2295: def last(*a, &block) 2296: if opts[:order].nil? && model && (pk = model.primary_key) 2297: order(*pk).last(*a, &block) 2298: else 2299: super 2300: end 2301: end
If there is no order already defined on this dataset, order it by the primary key and call paged_each.
Album.paged_each{|row| } # SELECT * FROM albums ORDER BY id LIMIT 1000 OFFSET 0 # SELECT * FROM albums ORDER BY id LIMIT 1000 OFFSET 1000 # SELECT * FROM albums ORDER BY id LIMIT 1000 OFFSET 2000 # ...
# File lib/sequel/model/base.rb, line 2311 2311: def paged_each(*a, &block) 2312: if opts[:order].nil? && model && (pk = model.primary_key) 2313: order(*pk).paged_each(*a, &block) 2314: else 2315: super 2316: end 2317: end
This allows you to call to_hash without any arguments, which will result in a hash with the primary key value being the key and the model object being the value.
Artist.dataset.to_hash # SELECT * FROM artists # => {1=>#<Artist {:id=>1, ...}>, # 2=>#<Artist {:id=>2, ...}>, # ...}
# File lib/sequel/model/base.rb, line 2327 2327: def to_hash(key_column=nil, value_column=nil) 2328: if key_column 2329: super 2330: else 2331: raise(Sequel::Error, "No primary key for model") unless model && (pk = model.primary_key) 2332: super(pk, value_column) 2333: end 2334: end
Given a primary key value, return the first record in the dataset with that primary key value. If no records matches, returns nil.
# Single primary key Artist.dataset.with_pk(1) # SELECT * FROM artists WHERE (artists.id = 1) LIMIT 1 # Composite primary key Artist.dataset.with_pk([1, 2]) # SELECT * FROM artists WHERE ((artists.id1 = 1) AND (artists.id2 = 2)) LIMIT 1
# File lib/sequel/model/base.rb, line 2346 2346: def with_pk(pk) 2347: first(model.qualified_primary_key_hash(pk)) 2348: end
Same as with_pk, but raises NoMatchingRow instead of returning nil if no row matches.
# File lib/sequel/model/base.rb, line 2352 2352: def with_pk!(pk) 2353: with_pk(pk) || raise(NoMatchingRow) 2354: end