Module: Parse::Core::Schema

Included in:
Object
Defined in:
lib/parse/model/core/schema.rb

Overview

Defines the Schema methods applied to a Parse::Object.

Instance Method Summary collapse

Instance Method Details

#auto_upgrade!Parse::Response, Boolean

Note:

This feature requires use of the master_key. No columns or fields are removed, this is a safe non-destructive upgrade.

A class method for non-destructive auto upgrading a remote schema based on the properties and relations you have defined in your local model. If the collection doesn't exist, we create the schema. If the collection already exists, the current schema is fetched, and only add the additional fields that are missing.

Returns:

  • (Parse::Response)

    if the remote schema was modified.

  • (Boolean)

    if no changes were made to the schema, it returns true.


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
# File 'lib/parse/model/core/schema.rb', line 78

def auto_upgrade!

  unless client.master_key.present?
    warn "[Parse] Schema changes for #{parse_class} is only available with the master key!"
    return false
  end
  # fetch the current schema (requires master key)
  response = fetch_schema

  # if it's a core class that doesn't exist, then create the collection without any fields,
  # since parse-server will automatically create the collection with the set of core fields.
  # then fetch the schema again, to add the missing fields.
  if response.error? && self.to_s.start_with?('Parse::') #is it a core class?
    client.create_schema parse_class, {}
    response = fetch_schema
    # if it still wasn't able to be created, raise an error.
    if response.error?
      warn "[Parse] Schema error: unable to create class #{parse_class}"
      return response
    end
  end

  if response.success?
    #let's figure out the diff fields
    remote_fields = response.result['fields']
    current_schema = schema
    current_schema[:fields] = current_schema[:fields].reduce({}) do |h,(k,v)|
      #if the field does not exist in Parse, then add it to the update list
      h[k] = v if remote_fields[k.to_s].nil?
      h
    end
    return true if current_schema[:fields].empty?
    return update_schema( current_schema )
  end
    create_schema
end

#create_schemaParse::Response

Create a new collection for this model with the schema defined by the local model.

Returns:

See Also:


60
61
62
# File 'lib/parse/model/core/schema.rb', line 60

def create_schema
  client.create_schema parse_class, schema
end

#fetch_schemaParse::Response

Fetche the current schema for this collection from Parse server.

Returns:


66
67
68
# File 'lib/parse/model/core/schema.rb', line 66

def fetch_schema
  client.schema parse_class
end

#schemaHash

Generate a Parse-server compatible schema hash for performing changes to the structure of the remote collection.

Returns:

  • (Hash)

    the schema for this Parse::Object subclass.


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
# File 'lib/parse/model/core/schema.rb', line 14

def schema
  sch = { className: parse_class, fields: {} }
  #first go through all the attributes
  attributes.each do |k,v|
    # don't include the base Parse fields
    next if Parse::Properties::BASE.include?(k)
    next if v.nil?
    result = { type: v.to_s.camelize }
    # if it is a basic column property, find the right datatype
    case v
    when :integer, :float
      result[:type] = Parse::Model::TYPE_NUMBER
    when :geopoint, :geo_point
      result[:type] = Parse::Model::TYPE_GEOPOINT
    when :pointer
      result = { type: Parse::Model::TYPE_POINTER, targetClass: references[k] }
    when :acl
      result[:type] = Parse::Model::ACL
    when :timezone, :time_zone
      result[:type] = "String" # no TimeZone native in Parse
    else
      result[:type] = v.to_s.camelize
    end

    sch[:fields][k] = result

  end
  #then add all the relational column attributes
  relations.each do |k,v|
    sch[:fields][k] = { type: Parse::Model::TYPE_RELATION, targetClass: relations[k] }
  end
  sch
end

#update_schema(schema_updates = nil) ⇒ Parse::Response

Update the remote schema for this Parse collection.

Parameters:

  • schema_updates (Hash) (defaults to: nil)

    the changes to be made to the schema.

Returns:


51
52
53
54
# File 'lib/parse/model/core/schema.rb', line 51

def update_schema(schema_updates = nil)
  schema_updates ||= schema
  client.update_schema parse_class, schema_updates
end