### Home Classes Methods

### In Files

- lib/sequel/database/schema_generator.rb
- lib/sequel/extensions/schema_dumper.rb

### Parent

Object

### Methods

- ::add_type_method
- ::new
- #check
- #column
- #constraint
- #dump_columns
- #dump_constraints
- #dump_indexes
- #foreign_key
- #full_text_index
- #has_column?
- #index
- #method_missing
- #primary_key
- #primary_key_name
- #spatial_index
- #unique

### Files

- CHANGELOG
- COPYING
- README.rdoc
- advanced_associations.rdoc
- association_basics.rdoc
- cheat_sheet.rdoc
- dataset_basics.rdoc
- dataset_filtering.rdoc
- migration.rdoc
- model_hooks.rdoc
- opening_databases.rdoc
- prepared_statements.rdoc
- querying.rdoc
- reflection.rdoc
- 1.0.txt
- 1.1.txt
- 1.3.txt
- 1.4.0.txt
- 1.5.0.txt
- 2.0.0.txt
- 2.1.0.txt
- 2.10.0.txt
- 2.11.0.txt
- 2.12.0.txt
- 2.2.0.txt
- 2.3.0.txt
- 2.4.0.txt
- 2.5.0.txt
- 2.6.0.txt
- 2.7.0.txt
- 2.8.0.txt
- 2.9.0.txt
- 3.0.0.txt
- 3.1.0.txt
- 3.10.0.txt
- 3.11.0.txt
- 3.12.0.txt
- 3.2.0.txt
- 3.3.0.txt
- 3.4.0.txt
- 3.5.0.txt
- 3.6.0.txt
- 3.7.0.txt
- 3.8.0.txt
- 3.9.0.txt
- sharding.rdoc
- sql.rdoc
- virtual_rows.rdoc

### Class/Module Index

Quicksearch

- Sequel
- Sequel::ADO
- Sequel::ADO::Database
- Sequel::ADO::Dataset
- Sequel::ADO::MSSQL
- Sequel::ADO::MSSQL::DatabaseMethods
- Sequel::ADO::MSSQL::Dataset
- Sequel::AdapterNotFound
- Sequel::Amalgalite
- Sequel::Amalgalite::Database
- Sequel::Amalgalite::Dataset
- Sequel::Amalgalite::SequelTypeMap
- Sequel::BasicObject
- Sequel::BeforeHookFailed
- Sequel::ConnectionPool
- Sequel::ConnectionPool::ClassMethods
- Sequel::DB2
- Sequel::DB2::Database
- Sequel::DB2::Dataset
- Sequel::DBI
- Sequel::DBI::Database
- Sequel::DBI::Dataset
- Sequel::DataObjects
- Sequel::DataObjects::Database
- Sequel::DataObjects::Dataset
- Sequel::DataObjects::MySQL
- Sequel::DataObjects::MySQL::DatabaseMethods
- Sequel::DataObjects::MySQL::Dataset
- Sequel::DataObjects::Postgres
- Sequel::DataObjects::Postgres::AdapterMethods
- Sequel::DataObjects::Postgres::DatabaseMethods
- Sequel::DataObjects::Postgres::Dataset
- Sequel::DataObjects::SQLite
- Sequel::DataObjects::SQLite::DatabaseMethods
- Sequel::DataObjects::SQLite::Dataset
- Sequel::Database
- Sequel::DatabaseConnectionError
- Sequel::DatabaseDisconnectError
- Sequel::DatabaseError
- Sequel::Dataset
- Sequel::Dataset::ArgumentMapper
- Sequel::Dataset::Pagination
- Sequel::Dataset::PreparedStatementMethods
- Sequel::Dataset::QueryBlockCopy
- Sequel::Dataset::StoredProcedureMethods
- Sequel::Dataset::StoredProcedures
- Sequel::Dataset::UnnumberedArgumentMapper
- Sequel::Error
- Sequel::Error::AdapterNotFound
- Sequel::Error::InvalidOperation
- Sequel::Error::InvalidValue
- Sequel::Error::PoolTimeoutError
- Sequel::Error::Rollback
- Sequel::Firebird
- Sequel::Firebird::Database
- Sequel::Firebird::Dataset
- Sequel::Inflections
- Sequel::Informix
- Sequel::Informix::Database
- Sequel::Informix::Dataset
- Sequel::IntegerMigrator
- Sequel::InvalidOperation
- Sequel::InvalidValue
- Sequel::JDBC
- Sequel::JDBC::AS400
- Sequel::JDBC::AS400::DatabaseMethods
- Sequel::JDBC::AS400::Dataset
- Sequel::JDBC::Database
- Sequel::JDBC::Dataset
- Sequel::JDBC::Dataset::PreparedStatementMethods
- Sequel::JDBC::Dataset::StoredProcedureMethods
- Sequel::JDBC::H2
- Sequel::JDBC::H2::DatabaseMethods
- Sequel::JDBC::H2::Dataset
- Sequel::JDBC::JavaLang
- Sequel::JDBC::JavaSQL
- Sequel::JDBC::JavaxNaming
- Sequel::JDBC::MSSQL
- Sequel::JDBC::MSSQL::DatabaseMethods
- Sequel::JDBC::MSSQL::Dataset
- Sequel::JDBC::MySQL
- Sequel::JDBC::MySQL::DatabaseMethods
- Sequel::JDBC::MySQL::Dataset
- Sequel::JDBC::Oracle
- Sequel::JDBC::Oracle::DatabaseMethods
- Sequel::JDBC::Oracle::Dataset
- Sequel::JDBC::Postgres
- Sequel::JDBC::Postgres::AdapterMethods
- Sequel::JDBC::Postgres::DatabaseMethods
- Sequel::JDBC::Postgres::Dataset
- Sequel::JDBC::SQLite
- Sequel::JDBC::SQLite::DatabaseMethods
- Sequel::JDBC::SQLite::Dataset
- Sequel::LiteralString
- Sequel::LooserTypecasting
- Sequel::MSSQL
- Sequel::MSSQL::DatabaseMethods
- Sequel::MSSQL::DatasetMethods
- Sequel::Metaprogramming
- Sequel::Migration
- Sequel::MigrationDSL
- Sequel::Migrator
- Sequel::Migrator::Error
- Sequel::Model
- Sequel::Model::Associations
- Sequel::Model::Associations::AssociationDatasetMethods
- Sequel::Model::Associations::AssociationReflection
- Sequel::Model::Associations::ClassMethods
- Sequel::Model::Associations::DatasetMethods
- Sequel::Model::Associations::InstanceMethods
- Sequel::Model::Associations::ManyToManyAssociationReflection
- Sequel::Model::Associations::ManyToOneAssociationReflection
- Sequel::Model::Associations::OneToManyAssociationReflection
- Sequel::Model::Associations::OneToOneAssociationReflection
- Sequel::Model::ClassMethods
- Sequel::Model::DatasetMethods
- Sequel::Model::Errors
- Sequel::Model::InstanceMethods
- Sequel::MySQL
- Sequel::MySQL::Database
- Sequel::MySQL::DatabaseMethods
- Sequel::MySQL::Dataset
- Sequel::MySQL::Dataset::CallableStatementMethods
- Sequel::MySQL::Dataset::PreparedStatementMethods
- Sequel::MySQL::Dataset::StoredProcedureMethods
- Sequel::MySQL::DatasetMethods
- Sequel::NamedTimezones
- Sequel::NoExistingObject
- Sequel::NotImplemented
- Sequel::ODBC
- Sequel::ODBC::Database
- Sequel::ODBC::Dataset
- Sequel::ODBC::MSSQL
- Sequel::ODBC::MSSQL::DatabaseMethods
- Sequel::ODBC::MSSQL::Dataset
- Sequel::OpenBase
- Sequel::OpenBase::Database
- Sequel::OpenBase::Dataset
- Sequel::Oracle
- Sequel::Oracle::Database
- Sequel::Oracle::DatabaseMethods
- Sequel::Oracle::Dataset
- Sequel::Oracle::DatasetMethods
- Sequel::Plugins
- Sequel::Plugins::ActiveModel
- Sequel::Plugins::ActiveModel::InstanceMethods
- Sequel::Plugins::AssociationDependencies
- Sequel::Plugins::AssociationDependencies::ClassMethods
- Sequel::Plugins::AssociationDependencies::InstanceMethods
- Sequel::Plugins::AssociationPks
- Sequel::Plugins::AssociationPks::ClassMethods
- Sequel::Plugins::AssociationProxies
- Sequel::Plugins::AssociationProxies::AssociationProxy
- Sequel::Plugins::AssociationProxies::ClassMethods
- Sequel::Plugins::BooleanReaders
- Sequel::Plugins::BooleanReaders::ClassMethods
- Sequel::Plugins::Caching
- Sequel::Plugins::Caching::ClassMethods
- Sequel::Plugins::Caching::InstanceMethods
- Sequel::Plugins::ClassTableInheritance
- Sequel::Plugins::ClassTableInheritance::ClassMethods
- Sequel::Plugins::ClassTableInheritance::InstanceMethods
- Sequel::Plugins::Composition
- Sequel::Plugins::Composition::ClassMethods
- Sequel::Plugins::Composition::InstanceMethods
- Sequel::Plugins::ForceEncoding
- Sequel::Plugins::ForceEncoding::ClassMethods
- Sequel::Plugins::ForceEncoding::InstanceMethods
- Sequel::Plugins::HookClassMethods
- Sequel::Plugins::HookClassMethods::ClassMethods
- Sequel::Plugins::HookClassMethods::InstanceMethods
- Sequel::Plugins::IdentityMap
- Sequel::Plugins::IdentityMap::ClassMethods
- Sequel::Plugins::IdentityMap::InstanceMethods
- Sequel::Plugins::InstanceFilters
- Sequel::Plugins::InstanceFilters::InstanceMethods
- Sequel::Plugins::InstanceHooks
- Sequel::Plugins::InstanceHooks::InstanceMethods
- Sequel::Plugins::LazyAttributes
- Sequel::Plugins::LazyAttributes::ClassMethods
- Sequel::Plugins::LazyAttributes::InstanceMethods
- Sequel::Plugins::ManyThroughMany
- Sequel::Plugins::ManyThroughMany::ClassMethods
- Sequel::Plugins::ManyThroughMany::ManyThroughManyAssociationReflection
- Sequel::Plugins::NestedAttributes
- Sequel::Plugins::NestedAttributes::ClassMethods
- Sequel::Plugins::NestedAttributes::InstanceMethods
- Sequel::Plugins::OptimisticLocking
- Sequel::Plugins::OptimisticLocking::ClassMethods
- Sequel::Plugins::OptimisticLocking::InstanceMethods
- Sequel::Plugins::RcteTree
- Sequel::Plugins::Schema
- Sequel::Plugins::Schema::ClassMethods
- Sequel::Plugins::Serialization
- Sequel::Plugins::Serialization::ClassMethods
- Sequel::Plugins::Serialization::InstanceMethods
- Sequel::Plugins::Sharding
- Sequel::Plugins::Sharding::ClassMethods
- Sequel::Plugins::Sharding::DatasetMethods
- Sequel::Plugins::Sharding::InstanceMethods
- Sequel::Plugins::SingleTableInheritance
- Sequel::Plugins::SingleTableInheritance::ClassMethods
- Sequel::Plugins::SingleTableInheritance::InstanceMethods
- Sequel::Plugins::SkipCreateRefresh
- Sequel::Plugins::SkipCreateRefresh::InstanceMethods
- Sequel::Plugins::StringStripper
- Sequel::Plugins::StringStripper::InstanceMethods
- Sequel::Plugins::Subclasses
- Sequel::Plugins::Subclasses::ClassMethods
- Sequel::Plugins::TacticalEagerLoading
- Sequel::Plugins::TacticalEagerLoading::DatasetMethods
- Sequel::Plugins::TacticalEagerLoading::InstanceMethods
- Sequel::Plugins::Timestamps
- Sequel::Plugins::Timestamps::ClassMethods
- Sequel::Plugins::Timestamps::InstanceMethods
- Sequel::Plugins::Touch
- Sequel::Plugins::Touch::ClassMethods
- Sequel::Plugins::Touch::InstanceMethods
- Sequel::Plugins::TypecastOnLoad
- Sequel::Plugins::TypecastOnLoad::ClassMethods
- Sequel::Plugins::TypecastOnLoad::InstanceMethods
- Sequel::Plugins::UpdatePrimaryKey
- Sequel::Plugins::UpdatePrimaryKey::ClassMethods
- Sequel::Plugins::UpdatePrimaryKey::InstanceMethods
- Sequel::Plugins::ValidationClassMethods
- Sequel::Plugins::ValidationClassMethods::ClassMethods
- Sequel::Plugins::ValidationClassMethods::ClassMethods::Generator
- Sequel::Plugins::ValidationClassMethods::InstanceMethods
- Sequel::Plugins::ValidationHelpers
- Sequel::Plugins::ValidationHelpers::InstanceMethods
- Sequel::PoolTimeout
- Sequel::Postgres
- Sequel::Postgres::Adapter
- Sequel::Postgres::AdapterMethods
- Sequel::Postgres::Database
- Sequel::Postgres::DatabaseMethods
- Sequel::Postgres::Dataset
- Sequel::Postgres::Dataset::ArgumentMapper
- Sequel::Postgres::Dataset::BindArgumentMethods
- Sequel::Postgres::Dataset::PreparedStatementMethods
- Sequel::Postgres::DatasetMethods
- Sequel::Postgres::DatasetMethods::PreparedStatementMethods
- Sequel::PrettyTable
- Sequel::Progress
- Sequel::Progress::DatabaseMethods
- Sequel::Progress::DatasetMethods
- Sequel::Rollback
- Sequel::SQL
- Sequel::SQL::AliasMethods
- Sequel::SQL::AliasedExpression
- Sequel::SQL::BitwiseMethods
- Sequel::SQL::Blob
- Sequel::SQL::BooleanConstant
- Sequel::SQL::BooleanExpression
- Sequel::SQL::BooleanMethods
- Sequel::SQL::CaseExpression
- Sequel::SQL::Cast
- Sequel::SQL::CastMethods
- Sequel::SQL::ColumnAll
- Sequel::SQL::ComplexExpression
- Sequel::SQL::ComplexExpressionMethods
- Sequel::SQL::Constant
- Sequel::SQL::Constants
- Sequel::SQL::Expression
- Sequel::SQL::Function
- Sequel::SQL::GenericComplexExpression
- Sequel::SQL::GenericExpression
- Sequel::SQL::Identifier
- Sequel::SQL::IdentifierMethods
- Sequel::SQL::InequalityMethods
- Sequel::SQL::JoinClause
- Sequel::SQL::JoinOnClause
- Sequel::SQL::JoinUsingClause
- Sequel::SQL::NegativeBooleanConstant
- Sequel::SQL::NoBooleanInputMethods
- Sequel::SQL::NumericExpression
- Sequel::SQL::NumericMethods
- Sequel::SQL::OrderMethods
- Sequel::SQL::OrderedExpression
- Sequel::SQL::PlaceholderLiteralString
- Sequel::SQL::QualifiedIdentifier
- Sequel::SQL::QualifyingMethods
- Sequel::SQL::SQLArray
- Sequel::SQL::StringConcatenationMethods
- Sequel::SQL::StringExpression
- Sequel::SQL::StringMethods
- Sequel::SQL::Subscript
- Sequel::SQL::SubscriptMethods
- Sequel::SQL::VirtualRow
- Sequel::SQL::Window
- Sequel::SQL::WindowFunction
- Sequel::SQLite
- Sequel::SQLite::Database
- Sequel::SQLite::DatabaseMethods
- Sequel::SQLite::Dataset
- Sequel::SQLite::Dataset::ArgumentMapper
- Sequel::SQLite::Dataset::PreparedStatementMethods
- Sequel::SQLite::DatasetMethods
- Sequel::Schema
- Sequel::Schema::AlterTableGenerator
- Sequel::Schema::Generator
- Sequel::ShardedSingleConnectionPool
- Sequel::ShardedThreadedConnectionPool
- Sequel::SimpleMigration
- Sequel::SingleConnectionPool
- Sequel::ThreadLocalTimezones
- Sequel::ThreadedConnectionPool
- Sequel::TimestampMigrator
- Sequel::Timezones
- Sequel::ValidationFailed
- String
- String::Inflections
- Array
- FalseClass
- Hash
- NilClass
- Numeric
- Object
- PGconn
- PGresult
- Proc
- Symbol
- TrueClass

No matching classes.

# Sequel::Schema::Generator

Schema::Generator is an internal class that the user is not expected to instantiate directly. Instances are created by Database#create_table. It is used to specify table creation parameters. It takes a Database object and a block of column/index/constraint specifications, and gives the Database a table description, which the database uses to create a table.

Schema::Generator has some methods but also includes method_missing, allowing users to specify column type as a method instead of using the column method, which makes for a nicer DSL.

For more information on Sequel’s support for schema modification, see the “Migrations and Schema Modification” guide.

### Constants

GENERIC_TYPES

  Classes specifying generic types that Sequel will convert to database-specific types.

### Attributes

columns[R]

Return the columns created by this generator

constraints[R]

Return the constraints created by this generator

indexes[R]

Return the indexes created by this generator

### Public Class Methods

add_type_method(*types) click to toggle source

Add a method for each of the given types that creates a column with that type as a constant. Types given should either already be constants/classes or a capitalized string/symbol with the same name as a constant/class.

    # File lib/sequel/database/schema_generator.rb, line 47
    def self.add_type_method(*types)
      types.each do |type|
        class_eval("def #{type}(name, opts={}); column(name, #{type}, opts); end", __FILE__, __LINE__)
      end
    end

new(db, &block) click to toggle source

Set the database in which to create the table, and evaluate the block in the context of this object.

    # File lib/sequel/database/schema_generator.rb, line 33
    def initialize(db, &block)
      @db = db
      @columns = []
      @indexes = []
      @constraints = []
      @primary_key = nil
      instance_eval(&block) if block
      @columns.unshift(@primary_key) if @primary_key && !has_column?(primary_key_name)
    end

### Public Instance Methods

check(*args, &block) click to toggle source

Add a unnamed constraint to the DDL, specified by the given block or args.

    # File lib/sequel/database/schema_generator.rb, line 55
    def check(*args, &block)
      constraint(nil, *args, &block)
    end

column(name, type, opts = {}) click to toggle source

Add a column with the given name, type, and opts to the DDL.

You can also create columns via method missing, so the following are equivalent:

    column :number, :integer
    integer :number

The following options are supported:

- :default - The default value for the column.

- :index - Create an index on this column.

- :key - For foreign key columns, the column in the associated table that this column references. Unnecessary if this column references the primary key of the associated table.

- :null - Mark the column as allowing NULL values (if true), or not allowing NULL values (if false). If unspecified, will default to whatever the database default is.

- :on_delete - Specify the behavior of this column when being deleted. See Schema::SQL#on_delete_clause for options.

- :on_update - Specify the behavior of this column when being updated. See Schema::SQL#on_delete_clause for options.

- :size - The size of the column, generally used with string columns to specify the maximum number of characters the column will hold. An array of two integers can be provided to set the size and the precision, respectively, of decimal columns.

- :unique - Mark the column as unique, generally has the same effect as creating a unique index on the column.

- :unsigned - Make the column type unsigned, only useful for integer columns.

- :deferrable - This ensure Referential Integrity will work even if reference table will use for its foreign key a value that does not exists(yet) on referenced table. Basically it adds DEFERRABLE INITIALLY DEFERRED on key creation.

    # File lib/sequel/database/schema_generator.rb, line 93
    def column(name, type, opts = {})
      columns << {:name => name, :type => type}.merge(opts)
      index(name) if opts[:index]
    end

constraint(name, *args, &block) click to toggle source

Adds a named constraint (or unnamed if name is nil) to the DDL, with the given block or args.

    # File lib/sequel/database/schema_generator.rb, line 100
    def constraint(name, *args, &block)
      constraints << {:name => name, :type => :check, :check => block || args}
    end

dump_columns() click to toggle source

Dump this generator’s columns to a string that could be evaled inside another instance to represent the same columns

    # File lib/sequel/extensions/schema_dumper.rb, line 190
    def dump_columns
      strings = []
      cols = columns.dup
      if pkn = primary_key_name
        cols.delete_if{|x| x[:name] == pkn}
        pk = @primary_key.dup
        pkname = pk.delete(:name)
        @db.serial_primary_key_options.each{|k,v| pk.delete(k) if v == pk[k]}
        strings << "primary_key #{pkname.inspect}#{opts_inspect(pk)}"
      end
      cols.each do |c|
        c = c.dup
        name = c.delete(:name)
        type = c.delete(:type)
        opts = opts_inspect(c)
        strings << if type.is_a?(Class)
          "#{type.name} #{name.inspect}#{opts}"
        else
          "column #{name.inspect}, #{type.inspect}#{opts}"
        end
      end
      strings.join("\n")
    end

dump_constraints() click to toggle source

Dump this generator’s constraints to a string that could be evaled inside another instance to represent the same constraints

    # File lib/sequel/extensions/schema_dumper.rb, line 216
    def dump_constraints
      cs = constraints.map do |c|
        c = c.dup
        type = c.delete(:type)
        case type
        when :check
          raise(Error, "can't dump check/constraint specified with Proc") if c[:check].is_a?(Proc)
          name = c.delete(:name)
          if !name and c[:check].length == 1 and c[:check].first.is_a?(Hash)
            "check #{c[:check].first.inspect[1...-1]}"
          else
            "#{name ? "constraint #{name.inspect}," : 'check'} #{c[:check].map{|x| x.inspect}.join(', ')}"
          end
        else
          cols = c.delete(:columns)
          "#{type} #{cols.inspect}#{opts_inspect(c)}"
        end
      end
      cs.join("\n")
    end

dump_indexes(options={}) click to toggle source

Dump this generator’s indexes to a string that could be evaled inside another instance to represent the same indexes. Options:

- :add_index - Use add_index instead of index, so the methods can be called outside of a generator but inside a migration. The value of this option should be the table name to use.

- :drop_index - Same as add_index, but create drop_index statements.

- :ignore_errors - Add the ignore_errors option to the outputted indexes

    # File lib/sequel/extensions/schema_dumper.rb, line 244
    def dump_indexes(options={})
      is = indexes.map do |c|
        c = c.dup
        cols = c.delete(:columns)
        if table = options[:add_index] || options[:drop_index]
          "#{options[:drop_index] ? 'drop' : 'add'}_index #{table.inspect}, #{cols.inspect}#{', :ignore_errors=>true' if options[:ignore_errors]}#{opts_inspect(c)}"
        else
          "index #{cols.inspect}#{opts_inspect(c)}"
        end
      end
      is.join("\n")
    end

foreign_key(name, table=nil, opts = {}) click to toggle source

Add a foreign key in the table that references another table to the DDL. See column for available options.

    # File lib/sequel/database/schema_generator.rb, line 106
    def foreign_key(name, table=nil, opts = {})
      opts = case table
      when Hash
        table.merge(opts)
      when Symbol
        opts.merge(:table=>table)
      when NilClass
        opts
      else
        raise(Error, "The second argument to foreign_key should be a Hash, Symbol, or nil")
      end
      return composite_foreign_key(name, opts) if name.is_a?(Array)
      column(name, Integer, opts)
    end

full_text_index(columns, opts = {}) click to toggle source

Add a full text index on the given columns to the DDL.

    # File lib/sequel/database/schema_generator.rb, line 122
    def full_text_index(columns, opts = {})
      index(columns, opts.merge(:type => :full_text))
    end

has_column?(name) click to toggle source

True if the DDL includes the creation of a column with the given name.

    # File lib/sequel/database/schema_generator.rb, line 127
    def has_column?(name)
      columns.any?{|c| c[:name] == name}
    end

index(columns, opts = {}) click to toggle source

Add an index on the given column(s) with the given options to the DDL. The available options are:

- :type - The type of index to use (only supported by some databases)

- :unique - Make the index unique, so duplicate values are not allowed.

- :where - Create a partial index (only supported by some databases)

    # File lib/sequel/database/schema_generator.rb, line 137
    def index(columns, opts = {})
      indexes << {:columns => Array(columns)}.merge(opts)
    end

method_missing(type, name = nil, opts = {}) click to toggle source

Add a column with the given type, name, and opts to the DDL. See column for available options.

    # File lib/sequel/database/schema_generator.rb, line 143
    def method_missing(type, name = nil, opts = {})
      name ? column(name, type, opts) : super
    end

primary_key(name, *args) click to toggle source

Add primary key information to the DDL. Takes between one and three arguments. The last one is an options hash as for Generator#column. The first one distinguishes two modes: an array of existing column names adds a composite primary key constraint. A single symbol adds a new column of that name and makes it the primary key. In that case the optional middle argument denotes the type.

Examples:

    primary_key(:id)
    primary_key(:zip_code, :null => false)
    primary_key([:street_number, :house_number])
    primary_key(:id, :string, :auto_increment => false)

    # File lib/sequel/database/schema_generator.rb, line 159
    def primary_key(name, *args)
      return composite_primary_key(name, *args) if name.is_a?(Array)
      @primary_key = @db.serial_primary_key_options.merge({:name => name})

      if opts = args.pop
        opts = {:type => opts} unless opts.is_a?(Hash)
        if type = args.pop
          opts.merge!(:type => type)
        end
        @primary_key.merge!(opts)
      end
      @primary_key
    end

primary_key_name() click to toggle source

The name of the primary key for this table, if it has a primary key.

    # File lib/sequel/database/schema_generator.rb, line 174
    def primary_key_name
      @primary_key[:name] if @primary_key
    end

spatial_index(columns, opts = {}) click to toggle source

Add a spatial index on the given columns to the DDL.

    # File lib/sequel/database/schema_generator.rb, line 179
    def spatial_index(columns, opts = {})
      index(columns, opts.merge(:type => :spatial))
    end

unique(columns, opts = {}) click to toggle source

Add a unique constraint on the given columns to the DDL.

    # File lib/sequel/database/schema_generator.rb, line 184
    def unique(columns, opts = {})
      constraints << {:type => :unique, :columns => Array(columns)}.merge(opts)
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.