Module: TinyDyno::Tables::ClassMethods

Defined in:
lib/tiny_dyno/tables.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.option(option_name, &block) ⇒ Object

Stores the provided block to be run when the option name specified is defined on a field.

No assumptions are made about what sort of work the handler might perform, so it will always be called if the option_name key is provided in the field definition – even if it is false or nil.

Examples:

TinyDyno::Tables.option :required do |model, field, value|
  model.validates_presence_of field if value
end

Parameters:

  • option_name (Symbol) —

    the option name to match against

  • block (Proc) —

    the handler to execute when the option is provided.

Since:

  • 2.1.0



41
42
43
 
# File 'lib/tiny_dyno/tables.rb', line 41

def option(option_name, &block)
  options[option_name] = block
end

.options ⇒ Hash

Return a map of custom option names to their handlers.

Examples:

TinyDyno::Tables.options
# => { :required => #<Proc:0x00000100976b38> }

Returns:

  • (Hash) —

    the option map

Since:

  • 2.1.0



54
55
56
 
# File 'lib/tiny_dyno/tables.rb', line 54

def options
  @options ||= {}
end

Instance Method Details

#create_table ⇒ true

Soft Create Request, which will accept that a table may already exist

Examples:

Create the table for the class

Returns:

  • (true) —

    If the operation succeeded <or> the table was already created



74
75
76
77
78
79
80
 
# File 'lib/tiny_dyno/tables.rb', line 74

def create_table
  if TinyDyno::Adapter.table_exists?(table_name: self.table_name)
    return true
  end
  raise InvalidTableDefinition.new "#{ self.name } has invalid table configuration" unless model_table_config_is_valid?
  TinyDyno::Adapter.create_table(create_table_request)
end

#create_table! ⇒ true

Send the actual table creation to the DynamoDB API and expect no table to be present

Examples:

Create the table for the class

Person.create_table!

Returns:

  • (true) —

    If the operation succeeded



64
65
66
67
 
# File 'lib/tiny_dyno/tables.rb', line 64

def create_table!
  raise InvalidTableDefinition.new "#{ self.name } has invalid table configuration" unless model_table_config_is_valid?
  TinyDyno::Adapter.create_table(create_table_request)
end

#delete_table ⇒ true

Request the table to be deleted

Examples:

Delete the table for the class

Person.delete_table

Returns:

  • (true) —

    If the operation succeeded



85
86
87
 
# File 'lib/tiny_dyno/tables.rb', line 85

def delete_table
  TinyDyno::Adapter.delete_table(table_name: self.table_name)
end

#model_table_config_is_valid? ⇒ String

Return the actual table name that represents the model in the DynamoDB store

Examples:

Return the table name for the class

Person.table_name

Returns:

  • (String) —

    The name of the table



95
96
97
 
# File 'lib/tiny_dyno/tables.rb', line 95

def model_table_config_is_valid?
  return (attribute_definitions_meet_spec? and not self.table_name.nil?)
end

#table_name ⇒ Object 



18
19
20
 
# File 'lib/tiny_dyno/tables.rb', line 18

def table_name
  self.name.to_s.downcase
end