2007-01-22 14:43:50 +01:00
|
|
|
module ActiveRecord
|
|
|
|
# Allows programmers to programmatically define a schema in a portable
|
|
|
|
# DSL. This means you can define tables, indexes, etc. without using SQL
|
|
|
|
# directly, so your applications can more easily support multiple
|
|
|
|
# databases.
|
|
|
|
#
|
|
|
|
# Usage:
|
|
|
|
#
|
|
|
|
# ActiveRecord::Schema.define do
|
|
|
|
# create_table :authors do |t|
|
2007-12-21 08:48:59 +01:00
|
|
|
# t.string :name, :null => false
|
2007-01-22 14:43:50 +01:00
|
|
|
# end
|
|
|
|
#
|
|
|
|
# add_index :authors, :name, :unique
|
|
|
|
#
|
|
|
|
# create_table :posts do |t|
|
2007-12-21 08:48:59 +01:00
|
|
|
# t.integer :author_id, :null => false
|
|
|
|
# t.string :subject
|
|
|
|
# t.text :body
|
|
|
|
# t.boolean :private, :default => false
|
2007-01-22 14:43:50 +01:00
|
|
|
# end
|
|
|
|
#
|
|
|
|
# add_index :posts, :author_id
|
|
|
|
# end
|
|
|
|
#
|
|
|
|
# ActiveRecord::Schema is only supported by database adapters that also
|
|
|
|
# support migrations, the two features being very similar.
|
|
|
|
class Schema < Migration
|
|
|
|
private_class_method :new
|
|
|
|
|
|
|
|
# Eval the given block. All methods available to the current connection
|
|
|
|
# adapter are available within the block, so you can easily use the
|
|
|
|
# database definition DSL to build up your schema (#create_table,
|
|
|
|
# #add_index, etc.).
|
|
|
|
#
|
|
|
|
# The +info+ hash is optional, and if given is used to define metadata
|
2008-05-18 06:22:34 +02:00
|
|
|
# about the current schema (currently, only the schema's version):
|
2007-01-22 14:43:50 +01:00
|
|
|
#
|
2008-05-18 06:22:34 +02:00
|
|
|
# ActiveRecord::Schema.define(:version => 20380119000001) do
|
2007-01-22 14:43:50 +01:00
|
|
|
# ...
|
|
|
|
# end
|
|
|
|
def self.define(info={}, &block)
|
|
|
|
instance_eval(&block)
|
|
|
|
|
2008-05-18 06:22:34 +02:00
|
|
|
unless info[:version].blank?
|
|
|
|
initialize_schema_migrations_table
|
|
|
|
assume_migrated_upto_version info[:version]
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|