sequel 1.4.0 → 1.5.0

data/CHANGELOG

@@ -1,3 +1,59 @@
+=== HEAD
+
+* Make the validation errors API compatible with Merb (Inviz)
+
+* Add validates_uniqueness_of, for protecting against duplicate entries in the database (neaf, jeremyevans)
+
+* Alias Model#dataset= to Model#set_dataset (tmm1)
+
+* Make some Model class methods private: def_hook_method, hooks, add_hook, plugin_module, plugin_gem (jeremyevans)
+
+* Add the eager! and eager_graph! mutation methods to model datasets (jeremyevans)
+
+* Remove Model.database_opened (jeremyevans)
+
+* Remove Model.super_dataset (jeremyevans)
+
+* Deprecate .create_with_params, .create_with, #set, #update, #update_with, and #new_record from Sequel::Model (jeremyevans)
+
+* Add Model.def_dataset_method, for defining methods on the model that reference methods on the dataset (jeremyevans)
+
+* Deprecate Model.method_missing, add dataset methods to Model via metaprogramming (jeremyevans)
+
+* Remove Model.join, so it is the same as Dataset#join (jeremyevans)
+
+* Use reciprocal associations for all types of associations in the getter/setter/add_/remove_ methods (jeremyevans)
+
+* Fix many_to_one associations to cache negative lookups (jeremyevans)
+
+* Change Model#=== to always be false if the primary key is nil (jeremyevans)
+
+* Add Model#hash, which should be unique for a given class and primary key (or values if primary key is nil) (jeremyevans)
+
+* Add Model#eql? as a alias to Model#== (jeremyevans)
+
+* Make Model#reload clear any cached associations (jeremyevans)
+
+* No longer depend on the assistance gem, merge the Inflector and Validations code (jeremyevans)
+
+* Add Model#set_with_params, which is Model#update_with_params without the save (jeremyevans)
+
+* Fix Model#destroy so that it returns self, not the result of after_destroy (jeremyevans)
+
+* Define Model column accessors in set_dataset, so they should always be avaiable, deprecate Model#method_missing (jeremyevans)
+
+* Add eager loading of associations via new sequel_core object graphing feature (jeremyevans)
+
+* Fix many_to_many associations with classes inside modules without an explicit join table (jeremyevans)
+
+* Allow creation of new records that don't have primary keys when the cache is on (jeremyevans) (#213)
+
+* Make Model#initialize, Model#set, and Model#update_with_params invulnerable to memory exhaustion (jeremyevans) (#210)
+
+* Add Model.str_columns, which gives a list of columns as frozen strings (jeremyevans)
+
+* Remove pretty_table.rb from sequel, since it is in sequel_core (jeremyevans)
+
 === 1.4.0 (2008-04-08)
 
 * Don't mark a column as changed unless the new value is different from the current value (tamas.denes, jeremyevans) (#203).

data/README

@@ -1,10 +1,31 @@
-== Sequel: The Database Toolkit for Ruby
+== Sequel Models
 
-Sequel is a database access toolkit for Ruby. Sequel provides thread safety, connection pooling, and a concise DSL for constructing queries and table schemas.
+Models in Sequel are based on the Active Record pattern described by Martin Fowler (http://www.martinfowler.com/eaaCatalog/activeRecord.html). A model class corresponds to a table or a dataset, and an instance of that class wraps a single record in the model's underlying dataset.
 
-Sequel makes it easy to deal with multiple records without having to break your teeth on SQL.
+Model classes are defined as regular Ruby classes:
 
-== Resources
+  DB = Sequel.connect('sqlite:/blog.db')
+  class Post < Sequel::Model
+  end
+
+Just like in DataMapper or ActiveRecord, Sequel model classes assume that the table name is a plural of the class name:
+
+  Post.table_name #=> :posts
+
+You can, however, explicitly set the table name or even the dataset used:
+
+  class Post < Sequel::Model(:my_posts)
+  end
+
+  # or:
+
+  Post.set_dataset :my_posts
+
+  # or:
+
+  Post.set_dataset DB[:my_posts].where(:category => 'ruby')
+
+=== Resources
 
 * {Project page}[http://code.google.com/p/ruby-sequel/]
 * {Source code}[http://github.com/jeremyevans/sequel]
@@ -14,239 +35,321 @@ Sequel makes it easy to deal with multiple records without having to break your
 * {API RDoc}[http://sequel.rubyforge.org]
 
 To check out the source code:
-  
+
   git clone git://github.com/jeremyevans/sequel.git
-  
+
 === Contact
 
 If you have any comments or suggestions please post to the Google group.
 
-== Installation
+=== Installation
 
   sudo gem install sequel
-  
-== Supported Databases
 
-Sequel currently supports:
+=== Model instances
 
-* ADO (on Windows)
-* DBI
-* Informix
-* MySQL
-* ODBC
-* Oracle
-* PostgreSQL
-* SQLite 3
+Model instance are identified by a primary key. By default, Sequel assumes the primary key column to be :id. The Model#[] method can be used to fetch records by their primary key:
 
-There are also experimental adapters for DB2, OpenBase and JDBC (on JRuby).
+  post = Post[123]
 
-== The Sequel Console
+The Model#pk method is used to retrieve the record's primary key value:
 
-Sequel includes an IRB console for quick'n'dirty access to databases. You can use it like this:
+  post.pk #=> 123
 
-  sequel sqlite:///test.db
+Sequel models allow you to use any column as a primary key, and even composite keys made from multiple columns:
 
-You get an IRB session with the database object stored in DB.
+  class Post < Sequel::Model
+    set_primary_key [:category, :title]
+  end
 
-== An Introduction
+  post = Post['ruby', 'hello world']
+  post.pk #=> ['ruby', 'hello world']
 
-Sequel is designed to take the hassle away from connecting to databases and manipulating them. Sequel deals with all the boring stuff like maintaining connections, formatting SQL correctly and fetching records so you can concentrate on your application.
+You can also define a model class that does not have a primary key, but then you lose the ability to update records.
 
-Sequel uses the concept of datasets to retrieve data. A Dataset object encapsulates an SQL query and supports chainability, letting you fetch data using a convenient Ruby DSL that is both concise and infinitely flexible.
+A model instance can also be fetched by specifying a condition:
 
-For example, the following one-liner returns the average GDP for the five biggest countries in the middle east region:
+  post = Post[:title => 'hello world']
+  post = Post.find{:num_comments < 10}
 
-  DB[:countries].filter(:region => 'Middle East').reverse_order(:area).limit(5).avg(:GDP)
-  
-Which is equivalent to:
+=== Iterating over records
 
-  SELECT avg(GDP) FROM countries WHERE region = 'Middle East' ORDER BY area DESC LIMIT 5
+A model class lets you iterate over specific records by acting as a proxy to the underlying dataset. This means that you can use the entire Dataset API to create customized queries that return model instances, e.g.:
 
-Since datasets retrieve records only when needed, they can be stored and later reused. Records are fetched as hashes (they can also be fetched as custom model objects), and are accessed using an Enumerable interface:
+  Post.filter(:category => 'ruby').each{|post| p post}
 
-  middle_east = DB[:countries].filter(:region => 'Middle East')
-  middle_east.order(:name).each {|r| puts r[:name]}
-  
-Sequel also offers convenience methods for extracting data from Datasets, such as an extended map method:
+You can also manipulate the records in the dataset:
 
-  middle_east.map(:name) #=> ['Egypt', 'Greece', 'Israel', ...]
-  
-Or getting results as a transposed hash, with one column as key and another as value:
+  Post.filter{:num_comments < 7}.delete
+  Post.filter{:title =~ /ruby/}.update(:category => 'ruby')
 
-  middle_east.to_hash(:name, :area) #=> {'Israel' => 20000, 'Greece' => 120000, ...}
+=== Accessing record values
 
-Much of Sequel is still undocumented (especially the part relating to model classes). The following section provides examples of common usage. Feel free to explore...
+A model instances stores its values as a hash:
 
-== Getting Started
+  post.values #=> {:id => 123, :category => 'ruby', :title => 'hello world'}
 
-=== Connecting to a database
+You can read the record values as object attributes (assuming the attribute names are valid columns in the model's dataset):
 
-To connect to a database you simply provide Sequel with a URL:
+  post.id #=> 123
+  post.title #=> 'hello world'
 
-  require 'sequel'
-  DB = Sequel.open 'sqlite:///blog.db'
-  
-The connection URL can also include such stuff as the user name and password:
+You can also change record values:
 
-  DB = Sequel.open 'postgres://cico:12345@localhost:5432/mydb'
+  post.title = 'hey there'
+  post.save
 
-You can also specify optional parameters, such as the connection pool size, or a logger for logging SQL queries:
+Another way to change values by using the #update_with_params method:
 
-  DB = Sequel.open("postgres://postgres:postgres@localhost/my_db",
-    :max_connections => 10, :logger => Logger.new('log/db.log'))
+  post.update_with_params(:title => 'hey there')
 
-=== Arbitrary SQL queries
+=== Creating new records
 
-  DB.execute("create table t (a text, b text)")
-  DB.execute("insert into t values ('a', 'b')")
+New records can be created by calling Model.create:
 
-Or more succinctly:
+  post = Post.create(:title => 'hello world')
 
-  DB << "create table t (a text, b text)"
-  DB << "insert into t values ('a', 'b')"
+Another way is to construct a new instance and save it:
 
-=== Getting Dataset Instances
+  post = Post.new
+  post.title = 'hello world'
+  post.save
 
-Dataset is the primary means through which records are retrieved and manipulated. You can create an blank dataset by using the dataset method:
+You can also supply a block to Model.new and Model.create:
 
-  dataset = DB.dataset
+  post = Post.create {|p| p.title = 'hello world'}
 
-Or by using the from methods:
+  post = Post.new do |p|
+    p.title = 'hello world'
+    p.save
+  end
 
-  posts = DB.from(:posts)
+=== Hooks
 
-You can also use the equivalent shorthand:
+You can execute custom code when creating, updating, or deleting records by using hooks. The before_create and after_create hooks wrap record creation. The before_update and after_update wrap record updating. The before_save and after_save wrap record creation and updating. The before_destroy and after_destroy wrap destruction.
 
-  posts = DB[:posts]
+Hooks are defined by supplying a block:
 
-Note: the dataset will only fetch records when you explicitly ask for them, as will be shown below. Datasets can be manipulated to filter through records, change record order and even join tables, as will also be shown below.
+  class Post < Sequel::Model
+    after_create do
+      self.created_at = Time.now
+    end
 
-=== Retrieving Records
+    after_destroy do
+      author.update_post_count
+    end
+  end
 
-You can retrieve records by using the all method:
+=== Deleting records
 
-  posts.all
+You can delete individual records by calling #delete or #destroy. The only difference between the two methods is that #destroy invokes before_destroy and after_destroy hooks, while #delete does not:
 
-The all method returns an array of hashes, where each hash corresponds to a record.
+  post.delete #=> bypasses hooks
+  post.destroy #=> runs hooks
 
-You can also iterate through records one at a time:
+Records can also be deleted en-masse by invoking Model.delete and Model.destroy. As stated above, you can specify filters for the deleted records:
 
-  posts.each {|row| p row}
+  Post.filter(:category => 32).delete #=> bypasses hooks
+  Post.filter(:category => 32).destroy #=> runs hooks
 
-Or perform more advanced stuff:
+Please note that if Model.destroy is called, each record is deleted 
+separately, but Model.delete deletes all relevant records with a single 
+SQL statement.
 
-  posts.map(:id)
-  posts.inject({}) {|h, r| h[r[:id]] = r[:name]}
-  
-You can also retrieve the first record in a dataset:
+=== Associations
 
-  posts.first
-  
-Or retrieve a single record with a specific value:
+Associations are used in order to specify relationships between model classes that reflect relations between tables in the database using foreign keys.
 
-  posts[:id => 1]
-  
-If the dataset is ordered, you can also ask for the last record:
+  class Post < Sequel::Model
+    many_to_one :author
+    one_to_many :comments
+    many_to_many :tags
+  end
 
-  posts.order(:stamp).last
-  
-=== Filtering Records
+You can also use the ActiveRecord names for these associations:
 
-The simplest way to filter records is to provide a hash of values to match:
+  class Post < Sequel::Model
+    belongs_to :author
+    has_many :comments
+    has_and_belongs_to_many :tags
+  end
 
-  my_posts = posts.filter(:category => 'ruby', :author => 'david')
-  
-You can also specify ranges:
+many_to_one/belongs_to creates a getter and setter for each model object:
 
-  my_posts = posts.filter(:stamp => (2.weeks.ago)..(1.week.ago))
-  
-Or lists of values:
+  class Post < Sequel::Model
+    many_to_one :author
+  end
 
-  my_posts = posts.filter(:category => ['ruby', 'postgres', 'linux'])
-  
-Sequel now also accepts expressions as closures, AKA block filters:
+  post = Post.create(:name => 'hi!')
+  post.author = Author[:name => 'Sharon']
+  post.author
 
-  my_posts = posts.filter {:category == ['ruby', 'postgres', 'linux']}
-  
-Which also lets you do stuff like:
+one_to_many/has_many and many_to_many/has_and_belongs_to_many create a getter method, a method for adding an object to the association, and a method for removing an object from the association:
 
-  my_posts = posts.filter {:stamp > 1.month.ago}
-  
-Some adapters (like postgresql) will also let you specify Regexps:
+  class Post < Sequel::Model
+    one_to_many :comments
+    many_to_many :tags
+  end
 
-  my_posts = posts.filter(:category => /ruby/i)
-  
-You can also use an inverse filter:
-
-  my_posts = posts.exclude(:category => /ruby/i)
+  post = Post.create(:name => 'hi!')
+  post.comments
+  comment = Comment.create(:text=>'hi')
+  post.add_comment(comment)
+  post.remove_comment(comment)
+  tag = Tag.create(:tag=>'interesting')
+  post.add_tag(tag)
+  post.remove_tag(tag)
 
-You can then retrieve the records by using any of the retrieval methods:
+=== Eager Loading
 
-  my_posts.each {|row| p row}
-  
-You can also specify a custom WHERE clause:
+Associations can be eagerly loaded via .eager and the :eager association option. Eager loading is used when loading a group of objects. It loads all associated objects for all of the current objects in one query, instead of using a separate query to get the associated objects for each current object. Eager loading requires that you retrieve all model objects at once via .all (instead of individually by .each). Eager loading can be cascaded, loading association's associated objects.
 
-  posts.filter('(stamp < ?) AND (author <> ?)', 3.days.ago, author_name)
+  class Person < Sequel::Model
+    one_to_many :posts, :eager=>[:tags]
+  end
 
-Datasets can also be used as subqueries:
+  class Post < Sequel::Model
+    many_to_one :person
+    one_to_many :replies
+    many_to_many :tags
+  end
 
-  DB[:items].filter('price > ?', DB[:items].select('AVG(price) + 100'))
+  class Tag < Sequel::Model
+    many_to_many :posts
+    many_to_many :replies
+  end
 
-=== Summarizing Records
+  class Reply < Sequel::Model
+    many_to_one :person
+    many_to_one :post
+    many_to_many :tags
+  end
 
-Counting records is easy:
-  posts.filter(:category => /ruby/i).count
+  # Eager loading via .eager
+  Post.eager(:person).all
 
-And you can also query maximum/minimum values:
-  max_value = DB[:history].max(:value)
+  # eager is a dataset method, so it works with filters/orders/limits/etc.
+  Post.filter("topic > 'M'").order(:date).limit(5).eager(:person).all
   
-Or calculate a sum:
-  total = DB[:items].sum(:price)
+  person = Person.first
+  # Eager loading via :eager (will eagerly load the tags for this person's posts)
+  person.posts
   
-=== Ordering Records
-
-  posts.order(:stamp)
+  # These are equivalent
+  Post.eager(:person, :tags).all
+  Post.eager(:person).eager(:tags).all
   
-You can also specify descending order
+  # Cascading via .eager
+  Tag.eager(:posts=>:replies).all
+  
+  # Will also grab all associated posts' tags (because of :eager)
+  Reply.eager(:person=>:posts).all
+  
+  # No depth limit (other than memory/stack), and will also grab posts' tags
+  # Loads all people, their posts, their posts' tags, replies to those posts,
+  # the person for each reply, the tag for each reply, and all posts and
+  # replies that have that tag.  Uses a total of 8 queries.
+  Person.eager(:posts=>{:replies=>[:person, {:tags=>{:posts, :replies}}]}).all
 
-  posts.order(:stamp.desc)
+In addition to using eager, you can also use eager_graph, which will use a single query to get the object and all associated objects.  This may be necessary if you want to filter the result set based on columns in associated tables.  It works with cascading as well, the syntax is exactly the same.  Note that using eager_graph to eagerly load multiple *_to_many associations will cause the result set to be a cartesian product, so you should be very careful with your filters when using it in that case.
 
-=== Deleting Records
+=== Caching model instances with memcached
 
-  posts.filter('stamp < ?', 3.days.ago).delete
-  
-=== Inserting Records
+Sequel models can be cached using memcached based on their primary keys. The use of memcached can significantly reduce database load by keeping model instances in memory. The set_cache method is used to specify caching:
 
-  posts.insert(:category => 'ruby', :author => 'david')
-  
-Or alternatively:
+  require 'memcache'
+  CACHE = MemCache.new 'localhost:11211', :namespace => 'blog'
 
-  posts << {:category => 'ruby', :author => 'david'}
-  
-=== Updating Records
+  class Author < Sequel::Model
+    set_cache CACHE, :ttl => 3600
+  end
 
-  posts.filter('stamp < ?', 3.days.ago).update(:state => 'archived')
+  Author[333] # database hit
+  Author[333] # cache hit
 
-=== Joining Tables
+=== Extending the underlying dataset
 
-Joining is very useful in a variety of scenarios, for example many-to-many relationships. With Sequel it's really easy:
+The obvious way to add table-wide logic is to define class methods to the model class definition. That way you can define subsets of the underlying dataset, change the ordering, or perform actions on multiple records:
 
-  order_items = DB[:items].join(:order_items, :item_id => :id).
-    filter(:order_items__order_id => 1234)
-  
-This is equivalent to the SQL:
+  class Post < Sequel::Model
+    def self.posts_with_few_comments
+      filter{:num_comments < 30}
+    end
 
-  SELECT * FROM items LEFT OUTER JOIN order_items
-  ON order_items.item_id = items.id 
-  WHERE order_items.order_id = 1234
+    def self.clean_posts_with_few_comments
+      posts_with_few_comments.delete
+    end
+  end
 
-You can then do anything you like with the dataset:
+You can also implement table-wide logic by defining methods on the dataset:
 
-  order_total = order_items.sum(:price)
-  
-Which is equivalent to the SQL:
+  class Post < Sequel::Model
+    def_dataset_method(:posts_with_few_comments) do
+      filter{:num_comments < 30}
+    end
 
-  SELECT sum(price) FROM items LEFT OUTER JOIN order_items
-  ON order_items.item_id = items.id
-  WHERE order_items.order_id = 1234
-  
+    def_dataset_method(:clean_posts_with_few_comments) do
+      posts_with_few_comments.delete
+    end
+  end
+
+This is the recommended way of implementing table-wide operations, and allows you to have access to your model API from filtered datasets as well:
+
+  Post.filter(:category => 'ruby').clean_old_posts
+
+Sequel models also provide a short hand notation for filters:
+
+  class Post < Sequel::Model
+    subset(:posts_with_few_comments){:num_comments < 30}
+    subset :invisible, :visible => false
+  end
+
+=== Defining the underlying schema
+
+Model classes can also be used as a place to define your table schema and control it. The schema DSL is exactly the same provided by Sequel::Schema::Generator:
+
+  class Post < Sequel::Model
+    set_schema do
+      primary_key :id
+      text :title
+      text :category
+      foreign_key :author_id, :table => :authors
+    end
+  end
+
+You can then create the underlying table, drop it, or recreate it:
+
+  Post.table_exists?
+  Post.create_table
+  Post.drop_table
+  Post.create_table! # drops the table if it exists and then recreates it
+
+=== Basic Model Validations
+
+To assign default validations to a sequel model:
+
+  class MyModel < Sequel::Model
+    validates do
+      format_of...
+      presence_of...
+      acceptance_of...
+      confirmation_of...
+      length_of...
+      numericality_of...
+      format_of...
+      each...
+    end
+  end
+
+You may also perform the usual 'longhand' way to assign default model validates directly within the model class itself:
+
+  class MyModel < Sequel::Model
+    validates_format_of...
+    validates_presence_of...
+    validates_acceptance_of...
+    validates_confirmation_of...
+    validates_length_of...
+    validates_numericality_of...
+    validates_format_of...
+    validates_each...
+  end