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

Instance Method Summary collapse

Instance Attribute Details

#model ⇒ Object

The model class associated with this dataset

Artist.dataset.model # => Artist



2216
2217
2218
 
# File 'lib/sequel/model/base.rb', line 2216

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



2222
2223
2224
2225
2226
2227
2228
 
# File 'lib/sequel/model/base.rb', line 2222

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)
# ...



2239
2240
2241
2242
 
# File 'lib/sequel/model/base.rb', line 2239

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)



2249
2250
2251
2252
2253
2254
2255
 
# File 'lib/sequel/model/base.rb', line 2249

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')



2263
2264
2265
2266
2267
2268
2269
 
# File 'lib/sequel/model/base.rb', line 2263

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)



2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
 
# File 'lib/sequel/model/base.rb', line 2276

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



2293
2294
2295
2296
2297
2298
2299
 
# File 'lib/sequel/model/base.rb', line 2293

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
# ...



2309
2310
2311
2312
2313
2314
2315
 
# File 'lib/sequel/model/base.rb', line 2309

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, ...}>,
#     ...}



2325
2326
2327
2328
2329
2330
2331
2332
 
# File 'lib/sequel/model/base.rb', line 2325

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



2344
2345
2346
 
# File 'lib/sequel/model/base.rb', line 2344

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.



2350
2351
2352
 
# File 'lib/sequel/model/base.rb', line 2350

def with_pk!(pk)
  with_pk(pk) || raise(NoMatchingRow.new(self))
end