Class: Sequel::Model

Class | Sequel::Model
In: | lib/sequel/model.rb lib/sequel/model/associations.rb lib/sequel/model/base.rb lib/sequel/model/errors.rb lib/sequel/model/plugins.rb
Parent: | Object

Sequel::Model is an object relational mapper built on top of Sequel core. Each model class is backed by a dataset instance, and many dataset methods can be called directly on the class. Model datasets return rows as model instances, which have fairly standard ORM instance behavior.

Sequel::Model is built completely out of plugins, the only method not part of a plugin is the plugin method itself. Plugins can override any class, instance, or dataset method defined by a previous plugin and call super to get the default behavior.

You can set the SEQUEL_NO_ASSOCIATIONS constant or environment variable to make Sequel not load the associations plugin by default.

### Methods

plugin

### Included Modules

Metaprogramming

### Classes and Modules

Module Sequel::Model::Associations
Module Sequel::Model::ClassMethods
Module Sequel::Model::DatasetMethods
Module Sequel::Model::InstanceMethods
Class Sequel::Model::Errors

### Constants

ANONYMOUS_MODEL_CLASSES | = | {} |  | Map that stores model classes created with Sequel::Model(), to allow the reopening of classes when dealing with code reloading.
DATASET_METHODS | = | %w'<< add_graph_aliases all avg count delete distinct each each_page eager eager_graph empty? except exclude filter first from from_self full_outer_join get graph grep group group_and_count group_by having import inner_join insert insert_multiple intersect interval invert join join_table last left_outer_join limit map max min multi_insert naked order order_by order_more paginate print qualify query range reverse reverse_order right_outer_join select select_all select_more server set set_defaults set_graph_aliases set_overrides single_value sum to_csv to_hash truncate unfiltered ungraphed ungrouped union unlimited unordered update where with with_recursive with_sql'.map{|x| x.to_sym} |  | Class methods added to model that call the method of the same name on the dataset
EMPTY_INSTANCE_VARIABLES | = | [:@overridable_methods_module, :@db] |  | Class instance variables to set to nil when a subclass is created, for -w compliance
HOOKS | = | [:after_initialize, :before_create, :after_create, :before_update, :after_update, :before_save, :after_save, :before_destroy, :after_destroy, :before_validation, :after_validation] |  | Empty instance methods to create that the user can override to get hook/callback behavior. Just like any other method defined by Sequel, if you override one of these, you should call super to get the default behavior (while empty by default, they can also be defined by plugins).
INHERITED_INSTANCE_VARIABLES | = | {:@allowed_columns=>:dup, :@dataset_methods=>:dup, :@dataset_method_modules=>:dup, :@primary_key=>nil, :@use_transactions=>nil, :@raise_on_save_failure=>nil, :@restricted_columns=>:dup, :@restrict_primary_key=>nil, :@simple_pk=>nil, :@simple_table=>nil, :@strict_param_setting=>nil, :@typecast_empty_string_to_nil=>nil, :@typecast_on_assignment=>nil, :@raise_on_typecast_failure=>nil, :@plugins=>:dup} |  | Class instance variables that are inherited in subclasses. If the value is :dup, dup is called on the superclass‘s instance variable when creating the instance variable in the subclass. If the value is nil, the superclass‘s instance variable is used directly in the subclass.
NORMAL_METHOD_NAME_REGEXP | = | /\A[A-Za-z_][A-Za-z0-9_]*\z/ |  | Regexp that determines if a method name is normal in the sense that it could be called directly in ruby code without using send. Used to avoid problems when using eval with a string to define methods.
RESTRICTED_SETTER_METHODS | = | %w"== === []= taguri= typecast_empty_string_to_nil= typecast_on_assignment= strict_param_setting= raise_on_save_failure= raise_on_typecast_failure=" |  | The setter methods (methods ending with =) that are never allowed to be called automatically via set/update/new/etc..
SETTER_METHOD_REGEXP | = | /=\z/ |  | Regular expression that determines if the method is a valid setter name (i.e. it ends with =).

### Public Class methods

plugin(plugin, *args, &blk)

Loads a plugin for use with the model class, passing optional arguments to the plugin. If the plugin is a module, load it directly. Otherwise, require the plugin from either sequel/plugins/#{plugin} or sequel_#{plugin}, and then attempt to load the module using a the camelized plugin name under Sequel::Plugins.

[Source]

        # File lib/sequel/model/plugins.rb, line 28
    28:     def self.plugin(plugin, *args, &blk)
    29:       arg = args.first
    30:       block = args.length > 1 ? lambda{args} : lambda{arg}
    31:       m = plugin.is_a?(Module) ? plugin : plugin_module(plugin)
    32:       unless @plugins.include?(m)
    33:         @plugins << m
    34:         m.apply(self, *args, &blk) if m.respond_to?(:apply)
    35:         if m.const_defined?("InstanceMethods")
    36:           define_method("#{plugin}_opts""#{plugin}_opts", &block)
    37:           include(m::InstanceMethods)
    38:         end
    39:         if m.const_defined?("ClassMethods")
    40:           meta_def("#{plugin}_opts""#{plugin}_opts", &block)
    41:           extend(m::ClassMethods)
    42:         end
    43:         if m.const_defined?("DatasetMethods")
    44:           if @dataset
    45:             dataset.meta_def("#{plugin}_opts""#{plugin}_opts", &block)
    46:             dataset.extend(m::DatasetMethods)
    47:           end
    48:           dataset_method_modules << m::DatasetMethods
    49:           meths = m::DatasetMethods.public_instance_methods.reject{|x| NORMAL_METHOD_NAME_REGEXP !~ x.to_s}
    50:           def_dataset_method(*meths) unless meths.empty?
    51:         end
    52:       end
    53:       m.configure(self, *args, &blk) if m.respond_to?(:configure)
    54:     end

[Validate]