Class: Sequel::Model

Inherits:

Object

Object
Sequel::Model

show all

Extended by:: Enumerable, Inflections, Metaprogramming, ClassMethods

Defined in:: lib/sequel/model.rb,
lib/sequel/model/base.rb,
lib/sequel/model/errors.rb,
lib/sequel/model/associations.rb,
lib/sequel/model/dataset_module.rb,
lib/sequel/plugins/prepared_statements.rb

Overview

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. Plugins can override any class, instance, or dataset method defined by a previous plugin and call super to get the default behavior. By default, Sequel::Model loads two plugins, Sequel::Model (which is itself a plugin) for the base support, and Sequel::Model::Associations for the associations support.

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

Defined Under Namespace

Modules: Associations, ClassMethods, DatasetMethods, InstanceMethods Classes: DatasetModule, Errors

Constant Summary collapse

OPTS =

Sequel::OPTS

ANONYMOUS_MODEL_CLASSES = Map that stores model classes created with Sequel::Model(), to allow the reopening of classes when dealing with code reloading.

{}

ANONYMOUS_MODEL_CLASSES_MUTEX = Mutex protecting access to ANONYMOUS_MODEL_CLASSES

Mutex.new

DATASET_METHODS = Class methods added to model that call the method of the same name on the dataset

(Dataset::ACTION_METHODS + Dataset::QUERY_METHODS +
[:each_server]) - [:and, :or, :[], :columns, :columns!, :delete, :update, :add_graph_aliases, :first, :first!]

BOOLEAN_SETTINGS = Boolean settings that can be modified at the global, class, or instance level.

[:typecast_empty_string_to_nil, :typecast_on_assignment, :strict_param_setting, \
:raise_on_save_failure, :raise_on_typecast_failure, :require_modification, :use_after_commit_rollback, :use_transactions]

BEFORE_HOOKS = Hooks that are called before an action. Can return false to not do the action. When overriding these, it is recommended to call super as the last line of your method, so later hooks are called before earlier hooks.

[:before_create, :before_update, :before_save, :before_destroy, :before_validation]

AFTER_HOOKS = Hooks that are called after an action. When overriding these, it is recommended to call super on the first line of your method, so later hooks are called after earlier hooks.

[:after_create, :after_update, :after_save, :after_destroy,
:after_validation, :after_commit, :after_rollback, :after_destroy_commit, :after_destroy_rollback]

AROUND_HOOKS = Hooks that are called around an action. If overridden, these methods must call super exactly once if the behavior they wrap is desired. The can be used to rescue exceptions raised by the code they wrap or ensure that some behavior is executed no matter what.

[:around_create, :around_update, :around_save, :around_destroy, :around_validation]

HOOKS = 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). See the “Model Hooks” guide for more detail on hooks.

BEFORE_HOOKS + AFTER_HOOKS

INHERITED_INSTANCE_VARIABLES = 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.

{:@allowed_columns=>:dup,
:@dataset_method_modules=>:dup, :@primary_key=>nil, :@use_transactions=>nil,
:@raise_on_save_failure=>nil, :@require_modification=>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, :@setter_methods=>nil,
:@use_after_commit_rollback=>nil, :@fast_pk_lookup_sql=>nil,
:@fast_instance_delete_sql=>nil, :@finders=>:dup, :@finder_loaders=>:dup,
:@db=>nil, :@default_set_fields_options=>:dup}

NORMAL_METHOD_NAME_REGEXP = Regular expression that determines if a method name is normal in the sense that it could be used literally in ruby code without using send. Used to avoid problems when using eval with a string to define methods.

/\A[A-Za-z_][A-Za-z0-9_]*\z/

SETTER_METHOD_REGEXP = Regular expression that determines if the method is a valid setter name (i.e. it ends with =).

/=\z/

RESTRICTED_SETTER_METHODS = The setter methods (methods ending with =) that are never allowed to be called automatically via set/update/new/etc..

instance_methods.map{|x| x.to_s}.grep(SETTER_METHOD_REGEXP)

Constants included from Inflections

Inflections::CAMELIZE_CONVERT_REGEXP, Inflections::CAMELIZE_MODULE_REGEXP, Inflections::DASH, Inflections::DEMODULIZE_CONVERT_REGEXP, Inflections::EMPTY_STRING, Inflections::SLASH, Inflections::UNDERSCORE, Inflections::UNDERSCORE_CONVERT_REGEXP1, Inflections::UNDERSCORE_CONVERT_REGEXP2, Inflections::UNDERSCORE_CONVERT_REPLACE, Inflections::UNDERSCORE_MODULE_REGEXP, Inflections::VALID_CONSTANT_NAME_REGEXP

Constants included from ClassMethods

ClassMethods::FINDER_TYPES

Instance Attribute Summary

Attributes included from ClassMethods

#allowed_columns, #dataset_method_modules, #default_set_fields_options, #fast_instance_delete_sql, #instance_dataset, #plugins, #primary_key, #raise_on_save_failure, #raise_on_typecast_failure, #require_modification, #simple_pk, #simple_table, #strict_param_setting, #typecast_empty_string_to_nil, #typecast_on_assignment, #use_after_commit_rollback, #use_transactions

Method Summary