DS Namespace addon/-private/core.js:8


Defined in: addon/-private/core.js:8

Module: ember-data

All Ember Data methods and functions are defined inside of this namespace.

Show:

Methods

Properties

Show:

_normalizeLink

(link) Object|null private

This method normalizes a link to an "links object". If the passed link is already an object it's returned without any modifications.

See http://jsonapi.org/format/#document-links for more information.

Parameters:

link String

Returns:

Object|null

attr

(type, options) Attribute
Defined in addon/attr.js:38

DS.attr defines an attribute on a DS.Model. By default, attributes are passed through as-is, however you can specify an optional type to have the value automatically transformed. Ember Data ships with four basic transform types: string, number, boolean and date. You can define your own transforms by subclassing DS.Transform.

Note that you cannot use attr to define an attribute of id.

DS.attr takes an optional hash as a second parameter, currently supported options are:

  • defaultValue: Pass a string or a function to be called to set the attribute to a default value if none is supplied.

Example

app/models/user.js
1
2
3
4
5
6
7
import DS from 'ember-data';

export default DS.Model.extend({
  username: DS.attr('string'),
  email: DS.attr('string'),
  verified: DS.attr('boolean', { defaultValue: false })
});

Default value can also be a function. This is useful it you want to return a new object for each attribute.

app/models/user.js
1
2
3
4
5
6
7
8
9
import DS from 'ember-data';

export default DS.Model.extend({
  username: attr('string'),
  email: attr('string'),
  settings: attr({defaultValue: function() {
    return {};
  }})
});

The options hash is passed as second argument to a transforms' serialize and deserialize method. This allows to configure a transformation and adapt the corresponding value, based on the config:

app/models/post.js
1
2
3
4
5
export default DS.Model.extend({
  text: DS.attr('text', {
    uppercase: true
  })
});
app/transforms/text.js
1
2
3
4
5
6
7
8
9
10
11
12
13
export default DS.Transform.extend({
  serialize: function(value, options) {
    if (options.uppercase) {
      return value.toUpperCase();
    }

    return value;
  },

  deserialize: function(value) {
    return value;
  }
})

Parameters:

type String
the attribute type
options Object
a hash of options

Returns:

Attribute

belongsTo

(modelName, options) Ember.computed

DS.belongsTo is used to define One-To-One and One-To-Many relationships on a DS.Model.

DS.belongsTo takes an optional hash as a second parameter, currently supported options are:

  • async: A boolean value used to explicitly declare this to be an async relationship.
  • inverse: A string used to identify the inverse property on a related model in a One-To-Many relationship. See Explicit Inverses

One-To-One

To declare a one-to-one relationship between two models, use DS.belongsTo:

app/models/user.js
1
2
3
4
5
import DS from 'ember-data';

export default DS.Model.extend({
  profile: DS.belongsTo('profile')
});
app/models/profile.js
1
2
3
4
5
import DS from 'ember-data';

export default DS.Model.extend({
  user: DS.belongsTo('user')
});

One-To-Many

To declare a one-to-many relationship between two models, use DS.belongsTo in combination with DS.hasMany, like this:

app/models/post.js
1
2
3
4
5
import DS from 'ember-data';

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

export default DS.Model.extend({
  post: DS.belongsTo('post')
});

You can avoid passing a string as the first parameter. In that case Ember Data will infer the type from the key name.

app/models/comment.js
1
2
3
4
5
import DS from 'ember-data';

export default DS.Model.extend({
  post: DS.belongsTo()
});

will lookup for a Post type.

Parameters:

modelName String
(optional) type of the relationship
options Object
(optional) a hash of options

Returns:

Ember.computed
relationship

hasMany

(type, options) Ember.computed

DS.hasMany is used to define One-To-Many and Many-To-Many relationships on a DS.Model.

DS.hasMany takes an optional hash as a second parameter, currently supported options are:

  • async: A boolean value used to explicitly declare this to be an async relationship.
  • inverse: A string used to identify the inverse property on a related model.

One-To-Many

To declare a one-to-many relationship between two models, use DS.belongsTo in combination with DS.hasMany, like this:

app/models/post.js
1
2
3
4
5
import DS from 'ember-data';

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

export default DS.Model.extend({
  post: DS.belongsTo('post')
});

Many-To-Many

To declare a many-to-many relationship between two models, use DS.hasMany:

app/models/post.js
1
2
3
4
5
import DS from 'ember-data';

export default DS.Model.extend({
  tags: DS.hasMany('tag')
});
app/models/tag.js
1
2
3
4
5
import DS from 'ember-data';

export default DS.Model.extend({
  posts: DS.hasMany('post')
});

You can avoid passing a string as the first parameter. In that case Ember Data will infer the type from the singularized key name.

app/models/post.js
1
2
3
4
5
import DS from 'ember-data';

export default DS.Model.extend({
  tags: DS.hasMany()
});

will lookup for a Tag type.

Explicit Inverses

Ember Data will do its best to discover which relationships map to one another. In the one-to-many code above, for example, Ember Data can figure out that changing the comments relationship should update the post relationship on the inverse because post is the only relationship to that model.

However, sometimes you may have multiple belongsTo/hasManys for the same type. You can specify which property on the related model is the inverse using DS.hasMany's inverse option:

app/models/comment.js
1
2
3
4
5
6
7
8
import DS from 'ember-data';

export default DS.Model.extend({
  onePost: DS.belongsTo('post'),
  twoPost: DS.belongsTo('post'),
  redPost: DS.belongsTo('post'),
  bluePost: DS.belongsTo('post')
});
app/models/post.js
1
2
3
4
5
6
7
import DS from 'ember-data';

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

You can also specify an inverse on a belongsTo, which works how you'd expect.

Parameters:

type String
(optional) type of the relationship
options Object
(optional) a hash of options

Returns:

Ember.computed
relationship

normalizeModelName

(modelName) String public

All modelNames are dasherized internally. Changing this function may require changes to other normalization hooks (such as typeForRoot).

Parameters:

modelName String

Returns:

String
if the adapter can generate one, an ID
Show:

VERSION

String static