Module: Sequel::ConstraintValidations

Classes and Modules

Module Sequel::ConstraintValidations::AlterTableGeneratorMethods
Module Sequel::ConstraintValidations::CreateTableGeneratorMethods
Class Sequel::ConstraintValidations::Generator

Constants

DEFAULT_CONSTRAINT_VALIDATIONS_TABLE = :sequel_constraint_validations The default table name used for the validation metadata.

Attributes

constraint_validations_table [RW] The name of the table storing the validation metadata. If modifying this from the default, this should be changed directly after loading the extension into the database

Public Class methods

extended(db)

Set the default validation metadata table name if it has not already been set.

[Source]

     # File lib/sequel/extensions/constraint_validations.rb, line 132
132:     def self.extended(db)
133:       db.constraint_validations_table ||= DEFAULT_CONSTRAINT_VALIDATIONS_TABLE
134:     end

Public Instance methods

create_constraint_validations_table()

Create the table storing the validation metadata for all of the constraints created by this extension.

[Source]

     # File lib/sequel/extensions/constraint_validations.rb, line 216
216:     def create_constraint_validations_table
217:       create_table(constraint_validations_table) do
218:         String :table, :null=>false
219:         String :constraint_name
220:         String :validation_type, :null=>false
221:         String :column, :null=>false
222:         String :argument
223:         String :message
224:         TrueClass :allow_nil
225:       end
226:     end

drop_constraint_validations_for(opts={})

Delete validation metadata for specific constraints. At least one of the following options should be specified:

:table :	The table containing the constraint
:column :	The column affected by the constraint
:constraint :	The name of the related constraint

The main reason for this method is when dropping tables or columns. If you have previously defined a constraint validation on the table or column, you should delete the related metadata when dropping the table or column. For a table, this isn‘t a big issue, as it will just result in some wasted space, but for columns, if you don‘t drop the related metadata, it could make it impossible to save rows, since a validation for a nonexistent column will be created.

[Source]

     # File lib/sequel/extensions/constraint_validations.rb, line 249
249:     def drop_constraint_validations_for(opts={})
250:       ds = from(constraint_validations_table)
251:       if table = opts[:table]
252:         ds = ds.where(:table=>constraint_validations_literal_table(table))
253:       end
254:       if column = opts[:column]
255:         ds = ds.where(:column=>column.to_s)
256:       end
257:       if constraint = opts[:constraint]
258:         ds = ds.where(:constraint_name=>constraint.to_s)
259:       end
260:       unless table || column || constraint
261:         raise Error, "must specify :table, :column, or :constraint when dropping constraint validations"
262:       end
263:       ds.delete
264:     end

drop_constraint_validations_table()

Drop the constraint validations table.

[Source]

     # File lib/sequel/extensions/constraint_validations.rb, line 229
229:     def drop_constraint_validations_table
230:       drop_table(constraint_validations_table)
231:     end