Module | Sequel::Model::ClassMethods |
In: |
lib/sequel/model/base.rb
lib/sequel/model/deprecated.rb lib/sequel/model/plugins.rb |
Class methods for Sequel::Model that implement basic model functionality.
allowed_columns | [R] | Which columns should be the only columns allowed in a call to set (default: not set, so all columns not otherwise restricted). |
dataset_method_modules | [R] | Array of modules that extend this model‘s dataset. Stored so that if the model‘s dataset is changed, it will be extended with all of these modules. |
dataset_methods | [R] | Hash of dataset methods with method name keys and proc values that are stored so when the dataset changes, methods defined with def_dataset_method will be applied to the new dataset. |
primary_key | [R] | The primary key for the class. Sequel can determine this automatically for many databases, but not all, so you may need to set it manually. If not determined automatically, the default is :id. |
raise_on_save_failure | [RW] | Whether to raise an error instead of returning nil on a failure to save/create/save_changes/etc due to a validation failure or a before_* hook returning false. |
raise_on_typecast_failure | [RW] | Whether to raise an error when unable to typecast data for a column (default: true). This should be set to false if you want to use validations to display nice error messages to the user (e.g. most web applications). You can use the validates_not_string validations (from either the validation_helpers or validation_class_methods standard plugins) in connection with option to check for typecast failures for columns that aren‘t blobs or strings. |
restricted_columns | [R] | Which columns are specifically restricted in a call to set/update/new/etc. (default: not set). Some columns are restricted regardless of this setting, such as the primary key column and columns in Model::RESTRICTED_SETTER_METHODS. |
simple_pk | [R] | Should be the literal primary key column name if this Model‘s table has a simple primary key, or nil if the model has a compound primary key or no primary key. |
simple_table | [R] | Should be the literal table name if this Model‘s dataset is a simple table (no select, order, join, etc.), or nil otherwise. This and simple_pk are used for an optimization in Model.[]. |
strict_param_setting | [RW] | Whether new/set/update and their variants should raise an error if an invalid key is used. A key is invalid if no setter method exists for that key or the access to the setter method is restricted (e.g. due to it being a primary key field). If set to false, silently skip any key where the setter method doesn‘t exist or access to it is restricted. |
typecast_empty_string_to_nil | [RW] | Whether to typecast the empty string (’’) to nil for columns that are not string or blob. In most cases the empty string would be the way to specify a NULL SQL value in string form (nil.to_s == ’’), and an empty string would not usually be typecast correctly for other types, so the default is true. |
typecast_on_assignment | [RW] | Whether to typecast attribute values on assignment (default: true). If set to false, no typecasting is done, so it will be left up to the database to typecast the value correctly. |
use_transactions | [RW] | Whether to use a transaction by default when saving/deleting records (default: true). If you are sending database queries in before_* or after_* hooks, you shouldn‘t change the default setting without a good reason. |
Returns the first record from the database matching the conditions. If a hash is given, it is used as the conditions. If another object is given, it finds the first record whose primary key(s) match the given argument(s).
# File lib/sequel/model/base.rb, line 87 87: def [](*args) 88: args = args.first if (args.size == 1) 89: return dataset[args] if args.is_a?(Hash) 90: if t = simple_table and p = simple_pk 91: with_sql("SELECT * FROM #{t} WHERE #{p} = #{dataset.literal(args)}").first 92: else 93: dataset[primary_key_hash(args)] 94: end 95: end
Returns the columns in the result set in their original order. Generally, this will use the columns determined via the database schema, but in certain cases (e.g. models that are based on a joined dataset) it will use Dataset#columns to find the columns, which may be empty if the Dataset has no records.
# File lib/sequel/model/base.rb, line 102 102: def columns 103: @columns || set_columns(dataset.naked.columns) 104: end
Creates instance using new with the given values and block, and saves it.
# File lib/sequel/model/base.rb, line 107 107: def create(values = {}, &block) 108: new(values, &block).save 109: end
Creates table, using the column information from set_schema.
# File lib/sequel/model/deprecated.rb, line 64 64: def create_table 65: Deprecation.deprecate('Sequel::Model.create_table', 'Use Model.plugin(:schema) first') 66: db.create_table(table_name, :generator=>@schema) 67: @db_schema = get_db_schema(true) 68: columns 69: end
Drops the table if it exists and then runs create_table. Should probably not be used except in testing.
# File lib/sequel/model/deprecated.rb, line 73 73: def create_table! 74: Deprecation.deprecate('Sequel::Model.create_table!', 'Use Model.plugin(:schema) first') 75: drop_table rescue nil 76: create_table 77: end
Returns the database associated with the Model class. If this model doesn‘t have a database associated with it, assumes the superclass‘s database, or the first object in Sequel::DATABASES. If no Sequel::Database object has been created, raises an error.
# File lib/sequel/model/base.rb, line 122 122: def db 123: return @db if @db 124: @db = self == Model ? DATABASES.first : superclass.db 125: raise(Error, "No database associated with #{self}") unless @db 126: @db 127: end
Sets the database associated with the Model class. If the model has an associated dataset, sets the model‘s dataset to a dataset on the new database with the same options used by the current dataset.
# File lib/sequel/model/base.rb, line 133 133: def db=(db) 134: @db = db 135: set_dataset(db.dataset(@dataset.opts)) if @dataset 136: end
If a block is given, define a method on the dataset (if the model has an associated dataset) with the given argument name using the given block as well as a method on the model that calls the dataset method. Stores the method name and block so that it can be reapplied if the model‘s dataset changes.
If a block is not given, define a method on the model for each argument that calls the dataset method of the same argument name.
# File lib/sequel/model/base.rb, line 151 151: def def_dataset_method(*args, &block) 152: raise(Error, "No arguments given") if args.empty? 153: if block_given? 154: raise(Error, "Defining a dataset method using a block requires only one argument") if args.length > 1 155: meth = args.first 156: @dataset_methods[meth] = block 157: dataset.meta_def(meth, &block) if @dataset 158: end 159: args.each{|arg| instance_eval("def #{arg}(*args, &block); dataset.#{arg}(*args, &block) end", __FILE__, __LINE__) unless respond_to?(arg)} 160: end
# File lib/sequel/model/deprecated.rb, line 23 23: def delete_all 24: Deprecation.deprecate('Sequel::Model.delete_all', 'Use Sequel::Model.delete') 25: dataset.delete 26: end
# File lib/sequel/model/deprecated.rb, line 28 28: def destroy_all 29: Deprecation.deprecate('Sequel::Model.destroy_all', 'Use Sequel::Model.destroy') 30: dataset.destroy 31: end
Drops table.
# File lib/sequel/model/deprecated.rb, line 80 80: def drop_table 81: Deprecation.deprecate('Sequel::Model.drop_table', 'Use Model.plugin(:schema) first') 82: db.drop_table(table_name) 83: end
Finds a single record according to the supplied filter, e.g.:
Ticket.find :author => 'Sharon' # => record
You are encouraged to use Model.[] or Model.first instead of this method.
# File lib/sequel/model/base.rb, line 167 167: def find(*args, &block) 168: filter(*args, &block).first 169: end
Returns the implicit table name for the model class.
# File lib/sequel/model/base.rb, line 204 204: def implicit_table_name 205: pluralize(underscore(demodulize(name))).to_sym 206: end
If possible, set the dataset for the model subclass as soon as it is created. Also, make sure the inherited class instance variables are copied into the subclass.
# File lib/sequel/model/base.rb, line 180 180: def inherited(subclass) 181: ivs = subclass.instance_variables.collect{|x| x.to_s} 182: EMPTY_INSTANCE_VARIABLES.each{|iv| subclass.instance_variable_set(iv, nil) unless ivs.include?(iv.to_s)} 183: INHERITED_INSTANCE_VARIABLES.each do |iv, dup| 184: next if ivs.include?(iv.to_s) 185: sup_class_value = instance_variable_get(iv) 186: sup_class_value = sup_class_value.dup if dup == :dup && sup_class_value 187: subclass.instance_variable_set(iv, sup_class_value) 188: end 189: unless ivs.include?("@dataset") 190: db 191: begin 192: if self == Model 193: subclass.set_dataset(subclass.implicit_table_name) unless subclass.name.empty? 194: elsif ds = instance_variable_get(:@dataset) 195: subclass.set_dataset(ds.clone, :inherited=>true) 196: end 197: rescue 198: nil 199: end 200: end 201: end
# File lib/sequel/model/deprecated.rb, line 13 13: def is(*args, &block) 14: Deprecation.deprecate('Sequel::Model.is', 'Use Sequel::Model.plugin') 15: plugin(*args, &block) 16: end
# File lib/sequel/model/deprecated.rb, line 18 18: def is_a(*args, &block) 19: Deprecation.deprecate('Sequel::Model.is_a', 'Use Sequel::Model.plugin') 20: plugin(*args, &block) 21: end
Initializes a model instance as an existing record. This constructor is used by Sequel to initialize model instances when fetching records. load requires that values be a hash where all keys are symbols. It probably should not be used by external code.
# File lib/sequel/model/base.rb, line 212 212: def load(values) 213: new(values, true) 214: end
Returns primary key attribute hash. If using a composite primary key value such be an array with values for each primary key in the correct order. For a standard primary key, value should be an object with a compatible type for the key. If the model does not have a primary key, raises an Error.
# File lib/sequel/model/base.rb, line 227 227: def primary_key_hash(value) 228: raise(Error, "#{self} does not have a primary key") unless key = @primary_key 229: case key 230: when Array 231: hash = {} 232: key.each_with_index{|k,i| hash[k] = value[i]} 233: hash 234: else 235: {key => value} 236: end 237: end
Restrict the setting of the primary key(s) inside new/set/update. Because this is the default, this only make sense to use in a subclass where the parent class has used unrestrict_primary_key.
# File lib/sequel/model/base.rb, line 242 242: def restrict_primary_key 243: @restrict_primary_key = true 244: end
Returns table schema created with set_schema for direct descendant of Model. Does not retreive schema information from the database, see db_schema if you want that.
# File lib/sequel/model/deprecated.rb, line 88 88: def schema 89: Deprecation.deprecate('Sequel::Model.schema', 'Use Model.plugin(:schema) first') 90: @schema || (superclass.schema unless superclass == Model) 91: end
# File lib/sequel/model/deprecated.rb, line 115 115: def serialize(*columns) 116: Deprecation.deprecate('Sequel::Model.serialize', 'A implementation that doesn\'t use dataset transforms can be added via plugin(:serialization, (:marshal||:yaml), column1, column2)') 117: format = extract_options!(columns)[:format] || :yaml 118: @transform = columns.inject({}) do |m, c| 119: m[c] = format 120: m 121: end 122: @dataset.transform(@transform) if @dataset 123: end
# File lib/sequel/model/deprecated.rb, line 125 125: def serialized?(column) 126: @transform ? @transform.include?(column) : false 127: end
Set the columns to allow in new/set/update. Using this means that any columns not listed here will not be modified. If you have any virtual setter methods (methods that end in =) that you want to be used in new/set/update, they need to be listed here as well (without the =).
It may be better to use (set|update)_only instead of this in places where only certain columns may be allowed.
# File lib/sequel/model/base.rb, line 259 259: def set_allowed_columns(*cols) 260: @allowed_columns = cols 261: end
# File lib/sequel/model/deprecated.rb, line 58 58: def set_cache(store, opts = {}) 59: Deprecation.deprecate('Sequel::Model.set_cache', 'Use Model.plugin(:caching, store, opts)') 60: plugin :caching, store, opts 61: end
# File lib/sequel/model/deprecated.rb, line 53 53: def set_cache_ttl(ttl) 54: Deprecation.deprecate('Sequel::Model.set_cache_ttl', 'Use Model.plugin(:caching, store, opts) first') 55: @cache_ttl = ttl 56: end
Sets the dataset associated with the Model class. ds can be a Symbol (specifying a table name in the current database), or a Dataset. If a dataset is used, the model‘s database is changed to the given dataset. If a symbol is used, a dataset is created from the current database with the table name given. Other arguments raise an Error.
This changes the row_proc of the given dataset to return model objects, extends the dataset with the dataset_method_modules, and defines methods on the dataset using the dataset_methods. It also attempts to determine the database schema for the model, based on the given dataset.
# File lib/sequel/model/base.rb, line 274 274: def set_dataset(ds, opts={}) 275: inherited = opts[:inherited] 276: @dataset = case ds 277: when Symbol 278: @simple_table = db.literal(ds) 279: db[ds] 280: when Dataset 281: @simple_table = nil 282: @db = ds.db 283: ds 284: else 285: raise(Error, "Model.set_dataset takes a Symbol or a Sequel::Dataset") 286: end 287: @dataset.row_proc = Proc.new{|r| load(r)} 288: @dataset.transform(@transform) if @transform 289: if inherited 290: @simple_table = superclass.simple_table 291: @columns = @dataset.columns rescue nil 292: else 293: @dataset_method_modules.each{|m| @dataset.extend(m)} if @dataset_method_modules 294: @dataset_methods.each{|meth, block| @dataset.meta_def(meth, &block)} if @dataset_methods 295: end 296: @dataset.model = self if @dataset.respond_to?(:model=) 297: @db_schema = (inherited ? superclass.db_schema : get_db_schema) rescue nil 298: self 299: end
Sets the primary key for this model. You can use either a regular or a composite primary key.
Example:
class Tagging < Sequel::Model # composite key set_primary_key :taggable_id, :tag_id end class Person < Sequel::Model # regular key set_primary_key :person_id end
You can set it to nil to not have a primary key, but that cause certain things not to work, see no_primary_key.
# File lib/sequel/model/base.rb, line 318 318: def set_primary_key(*key) 319: @simple_pk = key.length == 1 ? db.literal(key.first) : nil 320: @primary_key = (key.length == 1) ? key[0] : key.flatten 321: end
Set the columns to restrict in new/set/update. Using this means that attempts to call setter methods for the columns listed here will cause an exception or be silently skipped (based on the strict_param_setting setting. If you have any virtual # setter methods (methods that end in =) that you want not to be used in new/set/update, they need to be listed here as well (without the =).
It may be better to use (set|update)_except instead of this in places where only certain columns may be allowed.
# File lib/sequel/model/base.rb, line 331 331: def set_restricted_columns(*cols) 332: @restricted_columns = cols 333: end
Defines a table schema (see Schema::Generator for more information).
This is only needed if you want to use the create_table/create_table! methods. Will also set the dataset if you provide a name, as well as setting the primary key if you defined one in the passed block.
In general, it is a better idea to use migrations for production code, as migrations allow changes to existing schema. set_schema is mostly useful for test code or simple examples.
# File lib/sequel/model/deprecated.rb, line 102 102: def set_schema(name = nil, &block) 103: Deprecation.deprecate('Sequel::Model.set_schema', 'Use Model.plugin(:schema) first') 104: set_dataset(db[name]) if name 105: @schema = Sequel::Schema::Generator.new(db, &block) 106: set_primary_key(@schema.primary_key_name) if @schema.primary_key_name 107: end
# File lib/sequel/model/deprecated.rb, line 38 38: def set_sti_key(key) 39: Deprecation.deprecate('Sequel::Model.set_sti_key', 'Use Model.plugin(:single_table_inheritance, key)') 40: plugin :single_table_inheritance, key 41: end
# File lib/sequel/model/deprecated.rb, line 48 48: def sti_dataset 49: Deprecation.deprecate('Sequel::Model.sti_dataset', 'Use Model.plugin(:single_table_inheritance, key) first') 50: @sti_dataset 51: end
# File lib/sequel/model/deprecated.rb, line 43 43: def sti_key 44: Deprecation.deprecate('Sequel::Model.sti_key', 'Use Model.plugin(:single_table_inheritance, key) first') 45: @sti_key 46: end
# File lib/sequel/model/deprecated.rb, line 33 33: def str_columns 34: Deprecation.deprecate('Sequel::Model.str_columns', 'Use model.columns.map{|x| x.to_s}') 35: @str_columns ||= columns.map{|c| c.to_s.freeze} 36: end
Defines a method that returns a filtered dataset. Subsets create dataset methods, so they can be chained for scoping. For example:
Topic.subset(:joes, :username.like('%joe%')) Topic.subset(:popular){|o| o.num_posts > 100} Topic.subset(:recent){|o| o.created_on > Date.today - 7}
Allows you to do:
Topic.joes.recent.popular
to get topics with a username that includes joe that have more than 100 posts and were created less than 7 days ago.
Both the args given and the block are passed to Dataset#filter.
# File lib/sequel/model/base.rb, line 352 352: def subset(name, *args, &block) 353: def_dataset_method(name){filter(*args, &block)} 354: end
Returns true if table exists, false otherwise.
# File lib/sequel/model/deprecated.rb, line 110 110: def table_exists? 111: Deprecation.deprecate('Sequel::Model.table_exists?', 'Use Model.plugin(:schema) first') 112: db.table_exists?(table_name) 113: end