Class: DeclareSchema::Model::IndexDefinition

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/declare_schema/model/index_definition.rb

Defined Under Namespace

Classes: IndexNameTooLongError

Constant Summary collapse

PRIMARY_KEY_NAME = 
"PRIMARY"
MYSQL_INDEX_NAME_MAX_LENGTH = 
64

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model, fields, **options) ⇒ IndexDefinition

Returns a new instance of IndexDefinition.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/declare_schema/model/index_definition.rb', line 17

def initialize(model, fields, **options)
  @model = model
  @table = options.delete(:table_name) || model.table_name
  @fields = Array.wrap(fields).map(&:to_s)
  @explicit_name = options[:name] unless options.delete(:allow_equivalent)
  @name = options.delete(:name) || self.class.default_index_name(@fields)
  @unique = options.delete(:unique) || name == PRIMARY_KEY_NAME || false

  if @name.length > MYSQL_INDEX_NAME_MAX_LENGTH
    raise IndexNameTooLongError, "Index '#{@name}' exceeds MySQL limit of #{MYSQL_INDEX_NAME_MAX_LENGTH} characters. Give it a shorter name."
  end

  if (where = options[:where])
    @where = where.start_with?('(') ? where : "(#{where})"
  end
end

Instance Attribute Details

#explicit_name ⇒ Object (readonly)

TODO: replace ‘fields` with `columns` and remove alias. -Colin



9
10
11
 
# File 'lib/declare_schema/model/index_definition.rb', line 9

def explicit_name
  @explicit_name
end

#fields ⇒ Object (readonly) Also known as: columns

TODO: replace ‘fields` with `columns` and remove alias. -Colin



9
10
11
 
# File 'lib/declare_schema/model/index_definition.rb', line 9

def fields
  @fields
end

#name ⇒ Object (readonly)

TODO: replace ‘fields` with `columns` and remove alias. -Colin



9
10
11
 
# File 'lib/declare_schema/model/index_definition.rb', line 9

def name
  @name
end

#table ⇒ Object (readonly)

TODO: replace ‘fields` with `columns` and remove alias. -Colin



9
10
11
 
# File 'lib/declare_schema/model/index_definition.rb', line 9

def table
  @table
end

#unique ⇒ Object (readonly)

TODO: replace ‘fields` with `columns` and remove alias. -Colin



9
10
11
 
# File 'lib/declare_schema/model/index_definition.rb', line 9

def unique
  @unique
end

#where ⇒ Object (readonly)

TODO: replace ‘fields` with `columns` and remove alias. -Colin



9
10
11
 
# File 'lib/declare_schema/model/index_definition.rb', line 9

def where
  @where
end

Class Method Details

.default_index_name(columns) ⇒ Object 



60
61
62
 
# File 'lib/declare_schema/model/index_definition.rb', line 60

def default_index_name(columns)
  "on_#{Array(columns).join("_and_")}"
end

.for_model(model, old_table_name = nil) ⇒ Object

extract IndexSpecs from an existing table includes the PRIMARY KEY index



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/declare_schema/model/index_definition.rb', line 37

def for_model(model, old_table_name = nil)
  t = old_table_name || model.table_name

  primary_key_columns = Array(model.connection.primary_key(t)).presence
  primary_key_columns or raise "could not find primary key for table #{t} in #{model.connection.columns(t).inspect}"

  primary_key_found = false
  index_definitions = model.connection.indexes(t).map do |i|
    model.ignore_indexes.include?(i.name) and next
    if i.name == PRIMARY_KEY_NAME
      i.columns == primary_key_columns && i.unique or
        raise "primary key on #{t} was not unique on #{primary_key_columns} (was unique=#{i.unique} on #{i.columns})"
      primary_key_found = true
    end
    new(model, i.columns, name: i.name, unique: i.unique, where: i.where, table_name: old_table_name)
  end.compact

  if !primary_key_found
    index_definitions << new(model, primary_key_columns, name: PRIMARY_KEY_NAME, unique: true, where: nil, table_name: old_table_name)
  end
  index_definitions
end

Instance Method Details

#<=>(rhs) ⇒ Object 



81
82
83
 
# File 'lib/declare_schema/model/index_definition.rb', line 81

def <=>(rhs)
  to_key <=> rhs.to_key
end

#equivalent?(rhs) ⇒ Boolean

Returns:



85
86
87
 
# File 'lib/declare_schema/model/index_definition.rb', line 85

def equivalent?(rhs)
  settings == rhs.settings
end

#hash ⇒ Object 



77
78
79
 
# File 'lib/declare_schema/model/index_definition.rb', line 77

def hash
  to_key.hash
end

#primary_key? ⇒ Boolean

Returns:



65
66
67
 
# File 'lib/declare_schema/model/index_definition.rb', line 65

def primary_key?
  name == PRIMARY_KEY_NAME
end

#settings ⇒ Object 



73
74
75
 
# File 'lib/declare_schema/model/index_definition.rb', line 73

def settings
  @settings ||= [table, fields, unique].map(&:to_s)
end

#to_key ⇒ Object 



69
70
71
 
# File 'lib/declare_schema/model/index_definition.rb', line 69

def to_key
  @key ||= [table, fields, name, unique, where].map(&:to_s)
end

#with_name(new_name) ⇒ Object 



89
90
91
 
# File 'lib/declare_schema/model/index_definition.rb', line 89

def with_name(new_name)
  self.class.new(@model, @fields, table_name: @table_name, index_name: @index_name, unique: @unique, name: new_name)
end