/usr/lib/ruby/vendor_ruby/sequel/database/schema_generator.rb is in ruby-sequel 4.15.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 | module Sequel
# The Schema module holds the schema generators.
module Schema
# Schema::CreateTableGenerator 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::CreateTableGenerator 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 {"Schema Modification" guide}[rdoc-ref:doc/schema_modification.rdoc].
class CreateTableGenerator
# Classes specifying generic types that Sequel will convert to database-specific types.
GENERIC_TYPES=[String, Integer, Fixnum, Bignum, Float, Numeric, BigDecimal,
Date, DateTime, Time, File, TrueClass, FalseClass]
# Return the column hashes created by this generator
attr_reader :columns
# Return the constraint hashes created by this generator
attr_reader :constraints
# Return the index hashes created by this generator
attr_reader :indexes
# Set the database in which to create the table, and evaluate the block
# in the context of this object.
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
# 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.
#
# Do not call this method with untrusted input, as that can result in
# arbitrary code execution.
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
# Add an unnamed constraint to the DDL, specified by the given block
# or args:
#
# check(:num=>1..5) # CHECK num >= 1 AND num <= 5
# check{num > 5} # CHECK num > 5
def check(*args, &block)
constraint(nil, *args, &block)
end
# Add a column with the given name, type, and opts to the DDL.
#
# column :num, :integer
# # num INTEGER
#
# column :name, String, :null=>false, :default=>'a'
# # name varchar(255) NOT NULL DEFAULT 'a'
#
# inet :ip
# # ip inet
#
# 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.
# :deferrable :: For foreign key columns, this ensures referential integrity will work even if
# referencing table uses a foreign key value that does not
# yet exist on referenced table (but will exist before the transaction commits).
# Basically it adds DEFERRABLE INITIALLY DEFERRED on key creation.
# If you use :immediate as the value, uses DEFERRABLE INITIALLY IMMEDIATE.
# :index :: Create an index on this column. If given a hash, use the hash as the
# options for the index.
# :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, except if you are
# using MySQL.
# :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
# (:restrict, :cascade, :set_null, :set_default, :no_action).
# :on_update :: Specify the behavior of this column when being updated
# (:restrict, :cascade, :set_null, :set_default, :no_action).
# :primary_key :: Make the column as a single primary key column. This should only
# be used if you have a single, nonautoincrementing primary key column.
# :primary_key_constraint_name :: The name to give the primary key constraint
# :type :: Overrides the type given as the argument. Generally not used by column
# itself, but can be passed as an option to other methods that call column.
# :unique :: Mark the column as unique, generally has the same effect as
# creating a unique index on the column.
# :unique_constraint_name :: The name to give the unique key constraint
def column(name, type, opts = OPTS)
columns << {:name => name, :type => type}.merge(opts)
if index_opts = opts[:index]
index(name, index_opts.is_a?(Hash) ? index_opts : {})
end
end
# Adds a named constraint (or unnamed if name is nil) to the DDL,
# with the given block or args. To provide options for the constraint, pass
# a hash as the first argument.
#
# constraint(:blah, :num=>1..5)
# # CONSTRAINT blah CHECK num >= 1 AND num <= 5
# constraint({:name=>:blah, :deferrable=>true}, :num=>1..5)
# # CONSTRAINT blah CHECK num >= 1 AND num <= 5 DEFERRABLE INITIALLY DEFERRED
def constraint(name, *args, &block)
opts = name.is_a?(Hash) ? name : {:name=>name}
constraints << opts.merge(:type=>:check, :check=>block || args)
end
# Add a foreign key in the table that references another table to the DDL. See column
# for available options.
#
# foreign_key(:artist_id) # artist_id INTEGER
# foreign_key(:artist_id, :artists) # artist_id INTEGER REFERENCES artists
# foreign_key(:artist_id, :artists, :key=>:id) # artist_id INTEGER REFERENCES artists(id)
# foreign_key(:artist_id, :artists, :type=>String) # artist_id varchar(255) REFERENCES artists(id)
#
# Additional Options:
#
# :foreign_key_constraint_name :: The name to give the foreign key constraint
#
# If you want a foreign key constraint without adding a column (usually because it is a
# composite foreign key), you can provide an array of columns as the first argument, and
# you can provide the :name option to name the constraint:
#
# foreign_key([:artist_name, :artist_location], :artists, :name=>:artist_fk)
# # ADD CONSTRAINT artist_fk FOREIGN KEY (artist_name, artist_location) REFERENCES artists
def foreign_key(name, table=nil, opts = 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
# Add a full text index on the given columns to the DDL.
#
# PostgreSQL specific options:
# :index_type :: Can be set to :gist to use a GIST index instead of the
# default GIN index.
# :language :: Set a language to use for the index (default: simple).
#
# Microsoft SQL Server specific options:
# :key_index :: The KEY INDEX to use for the full text index.
def full_text_index(columns, opts = OPTS)
index(columns, opts.merge(:type => :full_text))
end
# True if the DDL includes the creation of a column with the given name.
def has_column?(name)
columns.any?{|c| c[:name] == name}
end
# Add an index on the given column(s) with the given options to the DDL.
# General options:
#
# :name :: The name to use for the index. If not given, a default name
# based on the table and columns is used.
# :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)
#
# PostgreSQL specific options:
#
# :concurrently :: Create the index concurrently, so it doesn't block
# operations on the table while the index is being
# built.
# :opclass :: Use a specific operator class in the index.
#
# Microsoft SQL Server specific options:
#
# :include :: Include additional column values in the index, without
# actually indexing on those values.
#
# index :name
# # CREATE INDEX table_name_index ON table (name)
#
# index [:artist_id, :name]
# # CREATE INDEX table_artist_id_name_index ON table (artist_id, name)
def index(columns, opts = OPTS)
indexes << {:columns => Array(columns)}.merge(opts)
end
# Add a column with the given type, name, and opts to the DDL. See +column+ for available
# options.
def method_missing(type, name = nil, opts = OPTS)
name ? column(name, type, opts) : super
end
# This object responds to all methods.
def respond_to_missing?(meth, include_private)
true
end
# Adds an autoincrementing primary key column or a primary key constraint to the DDL.
# To just create a constraint, the first argument should be an array of column symbols
# specifying the primary key columns. To create an autoincrementing primary key
# column, a single symbol can be used. In both cases, an options hash can be used
# as the second argument.
#
# If you want to create a primary key column that is not autoincrementing, you
# should not use this method. Instead, you should use the regular +column+ method
# with a <tt>:primary_key=>true</tt> option.
#
# If an array of column symbols is used, you can specify the :name option
# to name the constraint.
#
# Examples:
# primary_key(:id)
# primary_key([:street_number, :house_number], :name=>:some constraint_name)
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
# The name of the primary key for this generator, if it has a primary key.
def primary_key_name
@primary_key[:name] if @primary_key
end
# Add a spatial index on the given columns to the DDL.
def spatial_index(columns, opts = OPTS)
index(columns, opts.merge(:type => :spatial))
end
# Add a unique constraint on the given columns to the DDL.
#
# unique(:name) # UNIQUE (name)
#
# Supports the same :deferrable option as #column. The :name option can be used
# to name the constraint.
def unique(columns, opts = OPTS)
constraints << {:type => :unique, :columns => Array(columns)}.merge(opts)
end
private
# Add a composite primary key constraint
def composite_primary_key(columns, *args)
opts = args.pop || {}
constraints << {:type => :primary_key, :columns => columns}.merge(opts)
end
# Add a composite foreign key constraint
def composite_foreign_key(columns, opts)
constraints << {:type => :foreign_key, :columns => columns}.merge(opts)
end
add_type_method(*GENERIC_TYPES)
end
# Alias of CreateTableGenerator for backwards compatibility.
Generator = CreateTableGenerator
# Schema::AlterTableGenerator is an internal class that the user is not expected
# to instantiate directly. Instances are created by Database#alter_table.
# It is used to specify table alteration parameters. It takes a Database
# object and a block of operations to perform on the table, and
# gives the Database an array of table altering operations, which the database uses to
# alter a table's description.
#
# For more information on Sequel's support for schema modification, see
# the {"Schema Modification" guide}[link:files/doc/schema_modification_rdoc.html].
class AlterTableGenerator
# An array of DDL operations to perform
attr_reader :operations
# Set the Database object to which to apply the DDL, and evaluate the
# block in the context of this object.
def initialize(db, &block)
@db = db
@operations = []
instance_eval(&block) if block
end
# Add a column with the given name, type, and opts to the DDL for the table.
# See CreateTableGenerator#column for the available options.
#
# add_column(:name, String) # ADD COLUMN name varchar(255)
def add_column(name, type, opts = OPTS)
@operations << {:op => :add_column, :name => name, :type => type}.merge(opts)
end
# Add a constraint with the given name and args to the DDL for the table.
# See CreateTableGenerator#constraint.
#
# add_constraint(:valid_name, Sequel.like(:name, 'A%'))
# # ADD CONSTRAINT valid_name CHECK (name LIKE 'A%' ESCAPE '\')
# add_constraint({:name=>:valid_name, :deferrable=>true}, :num=>1..5)
# # ADD CONSTRAINT valid_name CHECK (name LIKE 'A%' ESCAPE '\') DEFERRABLE INITIALLY DEFERRED
def add_constraint(name, *args, &block)
opts = name.is_a?(Hash) ? name : {:name=>name}
@operations << opts.merge(:op=>:add_constraint, :type=>:check, :check=>block || args)
end
# Add a unique constraint to the given column(s)
#
# add_unique_constraint(:name) # ADD UNIQUE (name)
# add_unique_constraint(:name, :name=>:unique_name) # ADD CONSTRAINT unique_name UNIQUE (name)
#
# Supports the same :deferrable option as CreateTableGenerator#column.
def add_unique_constraint(columns, opts = OPTS)
@operations << {:op => :add_constraint, :type => :unique, :columns => Array(columns)}.merge(opts)
end
# Add a foreign key with the given name and referencing the given table
# to the DDL for the table. See CreateTableGenerator#column for the available options.
#
# You can also pass an array of column names for creating composite foreign
# keys. In this case, it will assume the columns exist and will only add
# the constraint. You can provide a :name option to name the constraint.
#
# NOTE: If you need to add a foreign key constraint to a single existing column
# use the composite key syntax even if it is only one column.
#
# add_foreign_key(:artist_id, :table) # ADD COLUMN artist_id integer REFERENCES table
# add_foreign_key([:name], :table) # ADD FOREIGN KEY (name) REFERENCES table
#
# PostgreSQL specific options:
#
# :not_valid :: Set to true to add the constraint with the NOT VALID syntax.
# This makes it so that future inserts must respect referential
# integrity, but allows the constraint to be added even if existing
# column values reference rows that do not exist. After all the
# existing data has been cleaned up, validate_constraint can be used
# to mark the constraint as valid. Note that this option only makes
# sense when using an array of columns.
def add_foreign_key(name, table, opts = OPTS)
return add_composite_foreign_key(name, table, opts) if name.is_a?(Array)
add_column(name, Integer, {:table=>table}.merge(opts))
end
# Add a full text index on the given columns to the DDL for the table.
# See CreateTableGenerator#index for available options.
def add_full_text_index(columns, opts = OPTS)
add_index(columns, {:type=>:full_text}.merge(opts))
end
# Add an index on the given columns to the DDL for the table. See
# CreateTableGenerator#index for available options.
#
# add_index(:artist_id) # CREATE INDEX table_artist_id_index ON table (artist_id)
def add_index(columns, opts = OPTS)
@operations << {:op => :add_index, :columns => Array(columns)}.merge(opts)
end
# Add a primary key to the DDL for the table. See CreateTableGenerator#column
# for the available options. Like +add_foreign_key+, if you specify
# the column name as an array, it just creates a constraint:
#
# add_primary_key(:id) # ADD COLUMN id serial PRIMARY KEY
# add_primary_key([:artist_id, :name]) # ADD PRIMARY KEY (artist_id, name)
def add_primary_key(name, opts = OPTS)
return add_composite_primary_key(name, opts) if name.is_a?(Array)
opts = @db.serial_primary_key_options.merge(opts)
add_column(name, opts.delete(:type), opts)
end
# Add a spatial index on the given columns to the DDL for the table.
# See CreateTableGenerator#index for available options.
def add_spatial_index(columns, opts = OPTS)
add_index(columns, {:type=>:spatial}.merge(opts))
end
# Remove a column from the DDL for the table.
#
# drop_column(:artist_id) # DROP COLUMN artist_id
# drop_column(:artist_id, :cascade=>true) # DROP COLUMN artist_id CASCADE
def drop_column(name, opts=OPTS)
@operations << {:op => :drop_column, :name => name}.merge(opts)
end
# Remove a constraint from the DDL for the table. MySQL/SQLite specific options:
#
# :type :: Set the type of constraint to drop, either :primary_key, :foreign_key,
# or :unique.
#
# drop_constraint(:unique_name) # DROP CONSTRAINT unique_name
# drop_constraint(:unique_name, :cascade=>true) # DROP CONSTRAINT unique_name CASCADE
def drop_constraint(name, opts=OPTS)
@operations << {:op => :drop_constraint, :name => name}.merge(opts)
end
# Remove a foreign key and the associated column from the DDL for the table. General options:
#
# :name :: The name of the constraint to drop. If not given, uses the same name
# that would be used by add_foreign_key with the same columns.
#
# NOTE: If you want to drop only the foreign key constraint but keep the column,
# use the composite key syntax even if it is only one column.
#
# drop_foreign_key(:artist_id) # DROP CONSTRAINT table_artist_id_fkey, DROP COLUMN artist_id
# drop_foreign_key([:name]) # DROP CONSTRAINT table_name_fkey
def drop_foreign_key(name, opts=OPTS)
drop_composite_foreign_key(Array(name), opts)
drop_column(name) unless name.is_a?(Array)
end
# Remove an index from the DDL for the table. General options:
#
# :name :: The name of the index to drop. If not given, uses the same name
# that would be used by add_index with the same columns.
#
# PostgreSQL specific options:
#
# :cascade :: Cascade the index drop to dependent objects.
# :concurrently :: Drop the index using CONCURRENTLY, which doesn't block
# operations on the table. Supported in PostgreSQL 9.2+.
# :if_exists :: Only drop the index if it already exists.
#
# drop_index(:artist_id) # DROP INDEX table_artist_id_index
# drop_index([:a, :b]) # DROP INDEX table_a_b_index
# drop_index([:a, :b], :name=>:foo) # DROP INDEX foo
def drop_index(columns, options=OPTS)
@operations << {:op => :drop_index, :columns => Array(columns)}.merge(options)
end
# Modify a column's name in the DDL for the table.
#
# rename_column(:name, :artist_name) # RENAME COLUMN name TO artist_name
def rename_column(name, new_name, opts = OPTS)
@operations << {:op => :rename_column, :name => name, :new_name => new_name}.merge(opts)
end
# Modify a column's default value in the DDL for the table.
#
# set_column_default(:artist_name, 'a') # ALTER COLUMN artist_name SET DEFAULT 'a'
#
# On MySQL, make sure to use a symbol for the name of the column, as otherwise you
# can lose the type and NULL/NOT NULL setting for the column.
def set_column_default(name, default)
@operations << {:op => :set_column_default, :name => name, :default => default}
end
# Modify a column's type in the DDL for the table.
#
# set_column_type(:artist_name, 'char(10)') # ALTER COLUMN artist_name TYPE char(10)
#
# PostgreSQL specific options:
#
# :using :: Add a USING clause that specifies how to convert existing values to new values.
#
# On MySQL, make sure to use a symbol for the name of the column, as otherwise you
# can lose the default and NULL/NOT NULL setting for the column.
def set_column_type(name, type, opts=OPTS)
@operations << {:op => :set_column_type, :name => name, :type => type}.merge(opts)
end
# Set a given column as allowing NULL values.
#
# set_column_allow_null(:artist_name) # ALTER COLUMN artist_name DROP NOT NULL
#
# On MySQL, make sure to use a symbol for the name of the column, as otherwise you
# can lose the default and type for the column.
def set_column_allow_null(name, allow_null=true)
@operations << {:op => :set_column_null, :name => name, :null => allow_null}
end
# Set a given column as not allowing NULL values.
#
# set_column_not_null(:artist_name) # ALTER COLUMN artist_name SET NOT NULL
#
# On MySQL, make sure to use a symbol for the name of the column, as otherwise you
# can lose the default and type for the column.
def set_column_not_null(name)
set_column_allow_null(name, false)
end
private
# Add a composite primary key constraint
def add_composite_primary_key(columns, opts)
@operations << {:op => :add_constraint, :type => :primary_key, :columns => columns}.merge(opts)
end
# Add a composite foreign key constraint
def add_composite_foreign_key(columns, table, opts)
@operations << {:op => :add_constraint, :type => :foreign_key, :columns => columns, :table => table}.merge(opts)
end
# Drop a composite foreign key constraint
def drop_composite_foreign_key(columns, opts)
@operations << {:op => :drop_constraint, :type => :foreign_key, :columns => columns}.merge(opts)
end
end
end
end
|