Module: Toy::Dynamo::Schema::ClassMethods

Defined in:
lib/toy/dynamo/schema.rb

Constant Summary collapse

KEY_TYPE = 
{
  :hash => "HASH",
  :range => "RANGE"
}
PROJECTION_TYPE = 
{
  :keys_only => "KEYS_ONLY",
  :all => "ALL",
  :include => "INCLUDE"
}

Instance Method Summary collapse

Instance Method Details

#attribute_definitions ⇒ Object

TODO - need to add projections?



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/toy/dynamo/schema.rb', line 85

def attribute_definitions
  # Keys for hash/range/secondary
  # S | N | B
  #{:attribute_name => , :attribute_type => }

  keys = []
  keys << hash_key[:attribute_name]
  keys << range_key[:attribute_name] if range_key
  local_secondary_indexes.each do |lsi|
    keys << lsi[:key_schema].select{|h| h[:key_type] == "RANGE"}.first[:attribute_name]
  end

  definitions = keys.uniq.collect do |k|
    attr = self.attributes[k.to_s]
    {
      :attribute_name => attr.name,
      :attribute_type => attribute_type_indicator(attr.type)
    }
  end
end

#attribute_type_indicator(type) ⇒ Object 



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
 
# File 'lib/toy/dynamo/schema.rb', line 106

def attribute_type_indicator(type)
  if type == Array
    "S"
  elsif type == Boolean
    "S"
  elsif type == Date
    "N"
  elsif type == Float
    "N"
  elsif type == Hash
    "S"
  elsif type == Integer
    "N"
  elsif type == Object
    "S"
  elsif type == Set
    "S"
  elsif type == String
    "S"
  elsif type == Time
    "N"
  elsif type == SimpleUUID::UUID
    "S"
  else
    raise "unsupported attribute type #{type}"
  end
end

#dynamo_table(options = {}, &block) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/toy/dynamo/schema.rb', line 19

def dynamo_table(options={}, &block)
  if block
    @dynamo_table_config_block ||= block
  else
    @dynamo_table_config_block.call unless @dynamo_table_configged

    unless @dynamo_table && @dynamo_table_configged
      begin
        @dynamo_table = Table.new(table_schema, self.adapter.client, options)
      rescue Exception => e
        # Reset table_schema
        @local_secondary_indexes = []
        raise e
      end
      unless options[:novalidate]
        validate_key_schema if @dynamo_table.schema_loaded_from_dynamo
      end
      @dynamo_table_configged = true
    end
    @dynamo_table
  end
end

#hash_key(hash_key_key = nil) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/toy/dynamo/schema.rb', line 141

def hash_key(hash_key_key=nil)
  if hash_key_key
    hash_key_attribute = self.attributes[hash_key_key.to_s]
    raise(ArgumentError, "Could not find attribute definition for hash_key #{hash_key_key}") unless hash_key_attribute
    raise(ArgumentError, "Cannot use virtual attributes for hash_key") if hash_key_attribute.virtual?
    raise(ArgumentError, "Invalid attribute type for hash_key") unless [String, Integer, Float].include?(hash_key_attribute.type)
    @dynamo_hash_key = {
      :attribute_name => hash_key_attribute.name,
      :key_type => KEY_TYPE[:hash]
    }
  else
    @dynamo_hash_key
  end
end

#key_schema ⇒ Object

Raises:

  • (ArgumentError) 


134
135
136
137
138
139
 
# File 'lib/toy/dynamo/schema.rb', line 134

def key_schema
  raise(ArgumentError, 'hash_key was not set for this table') if @dynamo_hash_key.blank?
  schema = [hash_key]
  schema << range_key if range_key 
  schema
end

#local_secondary_index(range_key_attr, options = {}) ⇒ Object

Parameters:

  • index_attr (Symbol) —

    the attribute to index secondary

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :projection (Symbol, Array<String>) —

    • ‘:all`

    • ‘:keys_only`

    • :attributes to project

Raises:

  • (ArgumentError) 


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
 
# File 'lib/toy/dynamo/schema.rb', line 210

def local_secondary_index(range_key_attr, options={})
  options[:projection] ||= :keys_only
  local_secondary_index_hash = {
    :projection => {}
  }
  if options[:projection].is_a?(Array) && options[:projection].size > 0
    options[:projection].each do |non_key_attr|
      attr = self.attributes[non_key_attr.to_s]
      raise(ArgumentError, "Could not find attribute definition for projection on #{non_key_attr}") unless attr
      (local_secondary_index_hash[:projection][:non_key_attributes] ||= []) << attr.name
    end
    local_secondary_index_hash[:projection][:projection_type] = PROJECTION_TYPE[:include]
  else
    raise(ArgumentError, 'projection must be :all, :keys_only, Array (or attrs)') unless options[:projection] == :keys_only || options[:projection] == :all
    local_secondary_index_hash[:projection][:projection_type] = PROJECTION_TYPE[options[:projection]]
  end

  range_attr = self.attributes[range_key_attr.to_s]
  raise(ArgumentError, "Could not find attribute definition for local secondary index on #{range_key_attr}") unless range_attr
  local_secondary_index_hash[:index_name] = (options[:name] || "#{range_attr.name}_index".camelcase)

  hash_key_attr = self.attributes[hash_key[:attribute_name].to_s]
  raise(ArgumentError, "Could not find attribute definition for hash_key") unless hash_key_attr

  local_secondary_index_hash[:key_schema] = [
    {
      :attribute_name => hash_key_attr.name,
      :key_type => KEY_TYPE[:hash]
    },
    {
      :attribute_name => range_attr.name,
      :key_type => KEY_TYPE[:range]
    }
  ]
  return false if (@local_secondary_indexes ||= []).select {|i| i[:index_name] == local_secondary_index_hash[:index_name] }.present? # Do not add if we already have a range key set for this attr
  (@local_secondary_indexes ||= []) << local_secondary_index_hash
end

#local_secondary_indexes ⇒ Object 



200
201
202
 
# File 'lib/toy/dynamo/schema.rb', line 200

def local_secondary_indexes
  @local_secondary_indexes ||= []
end

#range_key(range_key_key = nil) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/toy/dynamo/schema.rb', line 156

def range_key(range_key_key=nil)
  if range_key_key
    range_key_attribute = self.attributes[range_key_key.to_s]
    raise(ArgumentError, "Could not find attribute definition for range_key #{range_key_key}") unless range_key_attribute
    raise(ArgumentError, "Cannot use virtual attributes for range_key") if range_key_attribute.virtual?
    raise(ArgumentError, "Invalid attribute type for range_key") unless [String, Integer, Float].include?(range_key_attribute.type)

    validates_presence_of range_key_attribute.name.to_sym

    @dynamo_range_key = {
      :attribute_name => range_key_attribute.name,
      :key_type => KEY_TYPE[:range]
    }
  else
    @dynamo_range_key
  end
end

#read_provision(val = nil) ⇒ Object 



66
67
68
69
70
71
72
73
 
# File 'lib/toy/dynamo/schema.rb', line 66

def read_provision(val=nil)
  if val
    raise(ArgumentError, "Invalid read provision") unless val.to_i >= 1
    @dynamo_read_provision = val.to_i
  else
    @dynamo_read_provision || Toy::Dynamo::Config.read_provision
  end
end

#table_name(val = nil) ⇒ Object 



56
57
58
59
60
61
62
63
64
 
# File 'lib/toy/dynamo/schema.rb', line 56

def table_name(val=nil)
  if val
    raise(ArgumentError, "Invalid table name") unless val
    @dynamo_table_name = val
  else
    @dynamo_table_name ||= "#{Rails.application.class.parent_name.to_s.underscore.dasherize}-#{self.to_s.underscore.dasherize.pluralize.gsub(/[^a-zA-Z0-9_.-]/, '_')}-#{Rails.env}"
    @dynamo_table_name
  end
end

#table_schema ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/toy/dynamo/schema.rb', line 42

def table_schema
  schema = {
    :table_name => table_name,
    :provisioned_throughput => {
      :read_capacity_units => read_provision,
      :write_capacity_units => write_provision
    },
    :key_schema => key_schema,
    :attribute_definitions => attribute_definitions
  }
  schema[:local_secondary_indexes] = local_secondary_indexes unless local_secondary_indexes.blank?
  schema
end

#validate_key_schema ⇒ Object 



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
 
# File 'lib/toy/dynamo/schema.rb', line 174

def validate_key_schema
  if @dynamo_table.schema_loaded_from_dynamo[:table][:key_schema].sort_by { |k| k[:key_type] } != table_schema[:key_schema].sort_by { |k| k[:key_type] }
    raise ArgumentError, "It appears your key schema (Hash Key/Range Key) have changed from the table definition. Rebuilding the table is necessary."
  end

  if @dynamo_table.schema_loaded_from_dynamo[:table][:attribute_definitions].sort_by { |k| k[:attribute_name] } != table_schema[:attribute_definitions].sort_by { |k| k[:attribute_name] }
    raise ArgumentError, "It appears your attribute definition (types?) have changed from the table definition. Rebuilding the table is necessary."
  end

  if @dynamo_table.schema_loaded_from_dynamo[:table][:local_secondary_indexes].blank? != table_schema[:local_secondary_indexes].blank?
    raise ArgumentError, "It appears your local secondary indexes have changed from the table definition. Rebuilding the table is necessary."
  end
  
  if @dynamo_table.schema_loaded_from_dynamo[:table][:local_secondary_indexes] && (@dynamo_table.schema_loaded_from_dynamo[:table][:local_secondary_indexes].dup.collect {|i| i.delete_if{|k, v| [:index_size_bytes, :item_count].include?(k) }; i }.sort_by { |lsi| lsi[:index_name] } != table_schema[:local_secondary_indexes].sort_by { |lsi| lsi[:index_name] })
    raise ArgumentError, "It appears your local secondary indexes have changed from the table definition. Rebuilding the table is necessary."
  end

  if @dynamo_table.schema_loaded_from_dynamo[:table][:provisioned_throughput][:read_capacity_units] != read_provision
    Toy::Dynamo::Config.logger.error "read_capacity_units mismatch. Need to update table?"
  end

  if @dynamo_table.schema_loaded_from_dynamo[:table][:provisioned_throughput][:write_capacity_units] != write_provision
    Toy::Dynamo::Config.logger.error "write_capacity_units mismatch. Need to update table?"
  end
end

#write_provision(val = nil) ⇒ Object 



75
76
77
78
79
80
81
82
 
# File 'lib/toy/dynamo/schema.rb', line 75

def write_provision(val=nil)
  if val
    raise(ArgumentError, "Invalid write provision") unless val.to_i >= 1
    @dynamo_write_provision = val.to_i
  else
    @dynamo_write_provision || Toy::Dynamo::Config.write_provision
  end
end