DS.Model

The model class that all Ember Data records descend from. This is the public API of Ember Data models. If you are using Ember Data in your application, this is the class you should use. If you are working on Ember Data internals, you most likely want to be dealing with InternalModel

Show:

name
String
of the relationship
returns
BelongsToReference
reference for this relationship

Get the reference for the specified belongsTo relationship.

Example

1
2
3
export default DS.Model.extend({
  user: DS.belongsTo({ async: true })
});
1
2
3
4
5
6
7
8
9
10
11
12
13
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
let blog = store.push({
  data: {
    type: 'blog',
    id: 1,
    relationships: {
      user: {
        data: { type: 'user', id: 1 }
      }
    }
  }
});
let userRef = blog.belongsTo('user');

// check if the user relationship is loaded
let isLoaded = userRef.value() !== null;

// get the record of the reference (null if not yet available)
let user = userRef.value();

// get the identifier of the reference
if (userRef.remoteType() === "id") {
  let id = userRef.id();
} else if (userRef.remoteType() === "link") {
  let link = userRef.link();
}

// load user (via store.findRecord or store.findBelongsTo)
userRef.load().then(...)

// or trigger a reload
userRef.reload().then(...)

// provide data for reference
userRef.push({
  type: 'user',
  id: 1,
  attributes: {
    username: "@user"
  }
}).then(function(user) {
  userRef.value() === user;
});
returns
Object
an object, whose keys are changed properties, and value is an [oldProp, newProp] array.

Returns an object, whose keys are changed properties, and value is an [oldProp, newProp] array.

The array represents the diff of the canonical state with the local state of the model. Note: if the model is created locally, the canonical state is empty since the adapter hasn't acknowledged the attributes yet:

Example

1
2
3
4
5
6
7
8
import DS from 'ember-data';

export default DS.Model.extend({
  name: DS.attr('string'),
  isAdmin: DS.attr('boolean', {
    defaultValue: false
  })
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
let mascot = store.createRecord('mascot');

mascot.changedAttributes(); // {}

mascot.set('name', 'Tomster');
mascot.changedAttributes(); // { name: [undefined, 'Tomster'] }

mascot.set('isAdmin', true);
mascot.changedAttributes(); // { isAdmin: [undefined, true], name: [undefined, 'Tomster'] }

mascot.save().then(function() {
  mascot.changedAttributes(); // {}

  mascot.set('isAdmin', false);
  mascot.changedAttributes(); // { isAdmin: [true, false] }
});

Marks the record as deleted but does not save it. You must call save afterwards if you want to persist it. You might use this method if you want to allow the user to still rollbackAttributes() after a delete was made.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import Ember from 'ember';

export default Ember.Route.extend({
  actions: {
    softDelete: function() {
      this.controller.get('model').deleteRecord();
    },
    confirm: function() {
      this.controller.get('model').save();
    },
    undo: function() {
      this.controller.get('model').rollbackAttributes();
    }
  }
});
options
Object
returns
Promise
a promise that will be resolved when the adapter returns successfully or rejected if the adapter returns with an error.

Same as deleteRecord, but saves the record immediately.

Example

1
2
3
4
5
6
7
8
9
10
11
12
import Ember from 'ember';

export default Ember.Route.extend({
  actions: {
    delete: function() {
      let controller = this.controller;
      controller.get('model').destroyRecord().then(function() {
        controller.transitionToRoute('model.index');
      });
    }
  }
});

If you pass an object on the adapterOptions property of the options argument it will be passed to your adapter via the snapshot

1
record.destroyRecord({ adapterOptions: { subscribe: false } });
1
2
3
4
5
6
7
8
9
10
import MyCustomAdapter from './custom-adapter';

export default MyCustomAdapter.extend({
  deleteRecord: function(store, type, snapshot) {
    if (snapshot.adapterOptions.subscribe) {
      // ...
    }
    // ...
  }
});
proto
Object
key
String
value
Ember.ComputedProperty

This Ember.js hook allows an object to be notified when a property is defined.

In this case, we use it to be notified when an Ember Data user defines a belongs-to relationship. In that case, we need to set up observers for each one, allowing us to track relationship changes and automatically reflect changes in the inverse has-many array.

This hook passes the class being set up, as well as the key and value being defined. So, for example, when the user does this:

1
2
3
DS.Model.extend({
 parent: DS.belongsTo('user')
    });

This hook would be called with "parent" as the key and the computed property returned by DS.belongsTo as the value.

callback
Function
The callback to execute
binding
Object
the value to which the callback's `this` should be bound

Iterates through the attributes of the model, calling the passed function on each attribute.

The callback method you provide should have the following signature (all parameters are optional):

1
function(name, meta);
  • name the name of the current property in the iteration
  • meta the meta object for the attribute property in the iteration

Note that in addition to a callback, you can also pass an optional target object that will be set as this on the context.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import DS from 'ember-data';

let Person = DS.Model.extend({
   firstName: DS.attr('string'),
   lastName: DS.attr('string'),
   birthday: DS.attr('date')
 });

Person.eachAttribute(function(name, meta) {
   console.log(name, meta);
 });

// prints:
// firstName {type: "string", isAttribute: true, options: Object, parentType: function, name: "firstName"}
// lastName {type: "string", isAttribute: true, options: Object, parentType: function, name: "lastName"}
// birthday {type: "date", isAttribute: true, options: Object, parentType: function, name: "birthday"}
callback
Function
the callback to invoke
binding
Any
the value to which the callback's `this` should be bound

Given a callback, iterates over each of the types related to a model, invoking the callback with the related type's class. Each type will be returned just once, regardless of how many different relationships it has with a model.

callback
Function
the callback to invoke
binding
Any
the value to which the callback's `this` should be bound

Given a callback, iterates over each of the relationships in the model, invoking the callback with the name of each relationship and its relationship descriptor.

The callback method you provide should have the following signature (all parameters are optional):

1
function(name, descriptor);
  • name the name of the current property in the iteration
  • descriptor the meta object that describes this relationship

The relationship descriptor argument is an object with the following properties.

  • key String the name of this relationship on the Model
  • kind String "hasMany" or "belongsTo"
  • options Object the original options hash passed when the relationship was declared
  • parentType DS.Model the type of the Model that owns this relationship
  • type String the type name of the related Model

Note that in addition to a callback, you can also pass an optional target object that will be set as this on the context.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
import DS from 'ember-data';

export default DS.JSONSerializer.extend({
 serialize: function(record, options) {
   let json = {};

   record.eachRelationship(function(name, descriptor) {
     if (descriptor.kind === 'hasMany') {
       let serializedHasManyName = name.toUpperCase() + '_IDS';
       json[serializedHasManyName] = record.get(name).mapBy('id');
     }
   });

   return json;
 }
  });
callback
Function
The callback to execute
binding
Object
the value to which the callback's `this` should be bound

Iterates through the transformedAttributes of the model, calling the passed function on each attribute. Note the callback will not be called for any attributes that do not have an transformation type.

The callback method you provide should have the following signature (all parameters are optional):

1
function(name, type);
  • name the name of the current property in the iteration
  • type a string containing the name of the type of transformed applied to the attribute

Note that in addition to a callback, you can also pass an optional target object that will be set as this on the context.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import DS from 'ember-data';

let Person = DS.Model.extend({
   firstName: DS.attr(),
   lastName: DS.attr('string'),
   birthday: DS.attr('date')
 });

Person.eachTransformedAttribute(function(name, type) {
   console.log(name, type);
 });

// prints:
// lastName string
// birthday date
name
String
of the relationship
returns
HasManyReference
reference for this relationship

Get the reference for the specified hasMany relationship.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
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
// models/blog.js
export default DS.Model.extend({
  comments: DS.hasMany({ async: true })
});

let blog = store.push({
  data: {
    type: 'blog',
    id: 1,
    relationships: {
      comments: {
        data: [
          { type: 'comment', id: 1 },
          { type: 'comment', id: 2 }
        ]
      }
    }
  }
});
let commentsRef = blog.hasMany('comments');

// check if the comments are loaded already
let isLoaded = commentsRef.value() !== null;

// get the records of the reference (null if not yet available)
let comments = commentsRef.value();

// get the identifier of the reference
if (commentsRef.remoteType() === "ids") {
  let ids = commentsRef.ids();
} else if (commentsRef.remoteType() === "link") {
  let link = commentsRef.link();
}

// load comments (via store.findMany or store.findHasMany)
commentsRef.load().then(...)

// or trigger a reload
commentsRef.reload().then(...)

// provide data for reference
commentsRef.push([{ type: 'comment', id: 1 }, { type: 'comment', id: 2 }]).then(function(comments) {
  commentsRef.value() === comments;
});
name
String
the name of the relationship
store
DS.Store
returns
Object
the inverse relationship, or null

Find the relationship which is the inverse of the one asked for.

For example, if you define models like this:

1
2
3
4
5
import DS from 'ember-data';

export default DS.Model.extend({
   comments: DS.hasMany('message')
 });
1
2
3
4
5
import DS from 'ember-data';

export default DS.Model.extend({
   owner: DS.belongsTo('post')
 });
1
2
store.modelFor('post').inverseFor('comments', store) // { type: App.Message, name: 'owner', kind: 'belongsTo' }
store.modelFor('message').inverseFor('owner', store) // { type: App.Post, name: 'comments', kind: 'hasMany' }
returns
Promise
a promise that will be resolved with the record when the adapter returns successfully or rejected if the adapter returns with an error.

Reload the record from the adapter.

This will only work if the record has already finished loading.

Example

1
2
3
4
5
6
7
8
9
10
11
import Ember from 'ember';

export default Ember.Route.extend({
  actions: {
    reload: function() {
      this.controller.get('model').reload().then(function(model) {
        // do something with the reloaded model
      });
    }
  }
});

Discards any unsaved changes to the given attribute. This feature is not enabled by default. You must enable ds-rollback-attribute and be running a canary build.

Example

1
2
3
4
5
record.get('name'); // 'Untitled Document'
record.set('name', 'Doc 1');
record.get('name'); // 'Doc 1'
record.rollbackAttribute('name');
record.get('name'); // 'Untitled Document'

If the model hasDirtyAttributes this function will discard any unsaved changes. If the model isNew it will be removed from the store.

Example

1
2
3
4
5
record.get('name'); // 'Untitled Document'
record.set('name', 'Doc 1');
record.get('name'); // 'Doc 1'
record.rollbackAttributes();
record.get('name'); // 'Untitled Document'
options
Object
returns
Promise
a promise that will be resolved when the adapter returns successfully or rejected if the adapter returns with an error.

Save the record and persist any changes to the record to an external source via the adapter.

Example

1
2
3
4
5
6
record.set('name', 'Tomster');
record.save().then(function() {
  // Success callback
}, function() {
  // Error callback
});

If you pass an object on the adapterOptions property of the options argument it will be passed to you adapter via the snapshot

1
record.save({ adapterOptions: { subscribe: false } });
1
2
3
4
5
6
7
8
9
10
import MyCustomAdapter from './custom-adapter';

export default MyCustomAdapter.extend({
  updateRecord: function(store, type, snapshot) {
    if (snapshot.adapterOptions.subscribe) {
      // ...
    }
    // ...
  }
});
options
Object
returns
Object
an object whose values are primitive JSON values only

Create a JSON representation of the record, using the serialization strategy of the store's adapter.

serialize takes an optional hash as a parameter, currently supported options are:

  • includeId: true if the record's ID should be included in the JSON representation.
options
Object
returns
Object
A JSON representation of the object.

Use DS.JSONSerializer to get the JSON representation of a record.

toJSON takes an optional hash as a parameter, currently supported options are:

  • includeId: true if the record's ID should be included in the JSON representation.
name
String
the name of the relationship
store
Store
an instance of DS.Store
returns
DS.Model
the type of the relationship, or undefined

For a given relationship name, returns the model type of the relationship.

For example, if you define a model like this:

1
2
3
4
5
import DS from 'ember-data';

export default DS.Model.extend({
   comments: DS.hasMany('comment')
 });

Calling store.modelFor('post').typeForRelationship('comments', store) will return Comment.

Unloads the record from the store. This will cause the record to be destroyed and freed up for garbage collection.