Module: Sequel::Model::DatasetMethods
- Defined in:
- lib/sequel/model/base.rb
Overview
Dataset methods are methods that the model class extends its dataset with in the call to set_dataset.
Instance Attribute Summary collapse
-
#model ⇒ Object
The model class associated with this dataset.
Instance Method Summary collapse
-
#[](*args) ⇒ Object
Assume if a single integer is given that it is a lookup by primary key, and call with_pk with the argument.
-
#destroy ⇒ Object
Destroy each row in the dataset by instantiating it and then calling destroy on the resulting model object.
-
#graph(table, *args, &block) ⇒ Object
Allow Sequel::Model classes to be used as dataset arguments when graphing:.
-
#insert_sql(*values) ⇒ Object
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.
-
#join_table(type, table, *args, &block) ⇒ Object
Allow Sequel::Model classes to be used as table name arguments in dataset join methods:.
-
#last(*a, &block) ⇒ Object
If there is no order already defined on this dataset, order it by the primary key and call last.
-
#paged_each(*a, &block) ⇒ Object
If there is no order already defined on this dataset, order it by the primary key and call paged_each.
-
#to_hash(key_column = nil, value_column = nil) ⇒ Object
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. -
#with_pk(pk) ⇒ Object
Given a primary key value, return the first record in the dataset with that primary key value.
-
#with_pk!(pk) ⇒ Object
Same as with_pk, but raises NoMatchingRow instead of returning nil if no row matches.
Instance Attribute Details
#model ⇒ Object
The model class associated with this dataset
Artist.dataset.model # => Artist
2239 2240 2241 |
# File 'lib/sequel/model/base.rb', line 2239 def model @model end |
Instance Method Details
#[](*args) ⇒ Object
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
2245 2246 2247 2248 2249 2250 2251 |
# File 'lib/sequel/model/base.rb', line 2245 def [](*args) if args.length == 1 && (i = args.at(0)) && i.is_a?(Integer) with_pk(i) else super end end |
#destroy ⇒ Object
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)
# ...
2262 2263 2264 2265 |
# File 'lib/sequel/model/base.rb', line 2262 def destroy pr = proc{all(&:destroy).length} model.use_transactions ? @db.transaction(:server=>opts[:server], &pr) : pr.call end |
#graph(table, *args, &block) ⇒ Object
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)
2272 2273 2274 2275 2276 2277 2278 |
# File 'lib/sequel/model/base.rb', line 2272 def graph(table, *args, &block) if table.is_a?(Class) && table < Sequel::Model super(table.dataset, *args, &block) else super end end |
#insert_sql(*values) ⇒ Object
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')
2286 2287 2288 2289 2290 2291 2292 |
# File 'lib/sequel/model/base.rb', line 2286 def insert_sql(*values) if values.size == 1 && (v = values.at(0)).is_a?(Sequel::Model) && !v.respond_to?(:sql_literal_append) super(v.to_hash) else super end end |
#join_table(type, table, *args, &block) ⇒ Object
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)
2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 |
# File 'lib/sequel/model/base.rb', line 2299 def join_table(type, table, *args, &block) if table.is_a?(Class) && table < Sequel::Model if table.dataset.simple_select_all? super(type, table.table_name, *args, &block) else super(type, table.dataset, *args, &block) end else super end end |
#last(*a, &block) ⇒ Object
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
2316 2317 2318 2319 2320 2321 2322 |
# File 'lib/sequel/model/base.rb', line 2316 def last(*a, &block) if opts[:order].nil? && model && (pk = model.primary_key) order(*pk).last(*a, &block) else super end end |
#paged_each(*a, &block) ⇒ Object
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
# ...
2332 2333 2334 2335 2336 2337 2338 |
# File 'lib/sequel/model/base.rb', line 2332 def paged_each(*a, &block) if opts[:order].nil? && model && (pk = model.primary_key) order(*pk).paged_each(*a, &block) else super end end |
#to_hash(key_column = nil, value_column = nil) ⇒ Object
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, ...}>,
# ...}
2348 2349 2350 2351 2352 2353 2354 2355 |
# File 'lib/sequel/model/base.rb', line 2348 def to_hash(key_column=nil, value_column=nil) if key_column super else raise(Sequel::Error, "No primary key for model") unless model && (pk = model.primary_key) super(pk, value_column) end end |
#with_pk(pk) ⇒ Object
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
2367 2368 2369 |
# File 'lib/sequel/model/base.rb', line 2367 def with_pk(pk) first(model.qualified_primary_key_hash(pk)) end |
#with_pk!(pk) ⇒ Object
Same as with_pk, but raises NoMatchingRow instead of returning nil if no row matches.
2373 2374 2375 |
# File 'lib/sequel/model/base.rb', line 2373 def with_pk!(pk) with_pk(pk) || raise(NoMatchingRow.new(self)) end |