Class Store

Returns an instance of the adapter for a given type. For example, adapterFor('person') will return an instance of the adapter located at app/adapters/person.js

If no person adapter is found, this method will look for an application adapter (the default adapter for your entire application).

Instantiation hook allowing applications or addons to configure the store to utilize a custom Cache implementation.

This hook should not be called directly by consuming applications or libraries. Use Store.cache to access the Cache instance.

Create a new record in the current store. The properties passed to this method are set on the newly created record.

To create a new instance of a Post:

store.createRecord('post', {
  title: 'Ember is awesome!'
});

To create a new instance of a Post that has a relationship with a User record:

let user = this.store.peekRecord('user', '1');
store.createRecord('post', {
  title: 'Ember is awesome!',
  user: user
});

For symmetry, a record can be deleted via the store.

Example

let post = store.createRecord('post', {
  title: 'Ember is awesome!'
});

store.deleteRecord(post);

findAll asks the adapter's findAll method to find the records for the given type, and returns a promise which will resolve with all records of this type present in the store, even if the adapter only returns a subset of them.

export default class AuthorsRoute extends Route {
  model(params) {
    return this.store.findAll('author');
  }
}

When the returned promise resolves depends on the reload behavior, configured via the passed options hash and the result of the adapter's shouldReloadAll method.

Reloading

If { reload: true } is passed or adapter.shouldReloadAll evaluates to true, then the returned promise resolves once the adapter returns data, regardless if there are already records in the store:

store.push({
  data: {
    id: 'first',
    type: 'author'
  }
});

// adapter#findAll resolves with
// [
//   {
//     id: 'second',
//     type: 'author'
//   }
// ]
store.findAll('author', { reload: true }).then(function(authors) {
  authors.getEach('id'); // ['first', 'second']
});

If no reload is indicated via the above mentioned ways, then the promise immediately resolves with all the records currently loaded in the store.

Background Reloading

Optionally, if adapter.shouldBackgroundReloadAll evaluates to true, then a background reload is started. Once this resolves, the array with which the promise resolves, is updated automatically so it contains all the records in the store:

import Adapter from '@ember-data/adapter';

export default class ApplicationAdapter extends Adapter {
  shouldReloadAll(store, snapshotsArray) {
    return false;
  },

  shouldBackgroundReloadAll(store, snapshotsArray) {
    return true;
  }
});

// ...

store.push({
  data: {
    id: 'first',
    type: 'author'
  }
});

let allAuthors;
store.findAll('author').then(function(authors) {
  authors.getEach('id'); // ['first']

  allAuthors = authors;
});

// later, once adapter#findAll resolved with
// [
//   {
//     id: 'second',
//     type: 'author'
//   }
// ]

allAuthors.getEach('id'); // ['first', 'second']

If you would like to force or prevent background reloading, you can set a boolean value for backgroundReload in the options object for findAll.

export default class PostEditRoute extends Route {
  model() {
    return this.store.findAll('post', { backgroundReload: false });
  }
}

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

export default class PostsRoute extends Route {
  model(params) {
    return this.store.findAll('post', {
      adapterOptions: { subscribe: false }
    });
  }
}

import MyCustomAdapter from './custom-adapter';

export default class UserAdapter extends MyCustomAdapter {
  findAll(store, type, sinceToken, snapshotRecordArray) {
    if (snapshotRecordArray.adapterOptions.subscribe) {
      // ...
    }
    // ...
  }
}

See peekAll to get an array of current records in the store, without waiting until a reload is finished.

Retrieving Related Model Records

If you use an adapter such as Ember's default JSONAPIAdapter that supports the JSON API specification and if your server endpoint supports the use of an 'include' query parameter, you can use findAll() to automatically retrieve additional records related to those requested by supplying an include parameter in the options object.

For example, given a post model that has a hasMany relationship with a comment model, when we retrieve all of the post records we can have the server also return all of the posts' comments in the same request:

export default class PostsRoute extends Route {
  model() {
    return this.store.findAll('post', { include: 'comments' });
  }
}

Multiple relationships can be requested using an include parameter consisting of a comma-separated list (without white-space) while nested relationships can be specified using a dot-separated sequence of relationship names. So to request both the posts' comments and the authors of those comments the request would look like this:

export default class PostsRoute extends Route {
  model() {
    return this.store.findAll('post', { include: 'comments,comments.author' });
  }
}

See query to only get a subset of records from the server.

This method returns a record for a given identifier or type and id combination.

The findRecord method will always resolve its promise with the same object for a given identifier or type and id.

The findRecord method will always return a promise that will be resolved with the record.

Example 1

export default class PostRoute extends Route {
  model({ post_id }) {
    return this.store.findRecord('post', post_id);
  }
}

Example 2

findRecord can be called with a single identifier argument instead of the combination of type (modelName) and id as separate arguments. You may recognize this combo as the typical pairing from JSON:API

export default class PostRoute extends Route {
  model({ post_id: id }) {
    return this.store.findRecord({ type: 'post', id });
  }
}

Example 3

If you have previously received an lid via an Identifier for this record, and the record has already been assigned an id, you can find the record again using just the lid.

store.findRecord({ lid });

If the record is not yet available, the store will ask the adapter's findRecord method to retrieve and supply the necessary data. If the record is already present in the store, it depends on the reload behavior when the returned promise resolves.

Preloading

You can optionally preload specific attributes and relationships that you know of by passing them via the passed options.

For example, if your Ember route looks like /posts/1/comments/2 and your API route for the comment also looks like /posts/1/comments/2 if you want to fetch the comment without also fetching the post you can pass in the post to the findRecord call:

export default class PostRoute extends Route {
  model({ post_id, comment_id: id }) {
    return this.store.findRecord({ type: 'comment', id, { preload: { post: post_id }} });
  }
}

In your adapter you can then access this id without triggering a network request via the snapshot:

export default class Adapter {

  findRecord(store, schema, id, snapshot) {
    let type = schema.modelName;

    if (type === 'comment')
      let postId = snapshot.belongsTo('post', { id: true });

      return fetch(`./posts/${postId}/comments/${id}`)
        .then(response => response.json())
    }
  }

  static create() {
    return new this();
  }
}

This could also be achieved by supplying the post id to the adapter via the adapterOptions property on the options hash.

export default class PostRoute extends Route {
  model({ post_id, comment_id: id }) {
    return this.store.findRecord({ type: 'comment', id, { adapterOptions: { post: post_id }} });
  }
}

export default class Adapter {
  findRecord(store, schema, id, snapshot) {
    let type = schema.modelName;

    if (type === 'comment')
      let postId = snapshot.adapterOptions.post;

      return fetch(`./posts/${postId}/comments/${id}`)
        .then(response => response.json())
    }
  }

  static create() {
    return new this();
  }
}

If you have access to the post model you can also pass the model itself to preload:

let post = await store.findRecord('post', '1');
let comment = await store.findRecord('comment', '2', { post: myPostModel });

Reloading

The reload behavior is configured either via the passed options hash or the result of the adapter's shouldReloadRecord.

If { reload: true } is passed or adapter.shouldReloadRecord evaluates to true, then the returned promise resolves once the adapter returns data, regardless if the requested record is already in the store:

store.push({
  data: {
    id: 1,
    type: 'post',
    revision: 1
  }
});

// adapter#findRecord resolves with
// [
//   {
//     id: 1,
//     type: 'post',
//     revision: 2
//   }
// ]
store.findRecord('post', '1', { reload: true }).then(function(post) {
  post.revision; // 2
});

If no reload is indicated via the above mentioned ways, then the promise immediately resolves with the cached version in the store.

Background Reloading

Optionally, if adapter.shouldBackgroundReloadRecord evaluates to true, then a background reload is started, which updates the records' data, once it is available:

// app/adapters/post.js
import ApplicationAdapter from "./application";

export default class PostAdapter extends ApplicationAdapter {
  shouldReloadRecord(store, snapshot) {
    return false;
  },

  shouldBackgroundReloadRecord(store, snapshot) {
    return true;
  }
});

// ...

store.push({
  data: {
    id: 1,
    type: 'post',
    revision: 1
  }
});

let blogPost = store.findRecord('post', '1').then(function(post) {
  post.revision; // 1
});

// later, once adapter#findRecord resolved with
// [
//   {
//     id: 1,
//     type: 'post',
//     revision: 2
//   }
// ]

blogPost.revision; // 2

If you would like to force or prevent background reloading, you can set a boolean value for backgroundReload in the options object for findRecord.

export default class PostEditRoute extends Route {
  model(params) {
    return this.store.findRecord('post', params.post_id, { backgroundReload: false });
  }
}

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

export default class PostEditRoute extends Route {
  model(params) {
    return this.store.findRecord('post', params.post_id, {
      adapterOptions: { subscribe: false }
    });
  }
}

import MyCustomAdapter from './custom-adapter';

export default class PostAdapter extends MyCustomAdapter {
  findRecord(store, type, id, snapshot) {
    if (snapshot.adapterOptions.subscribe) {
      // ...
    }
    // ...
  }
}

See peekRecord to get the cached version of a record.

Retrieving Related Model Records

If you use an adapter such as Ember's default JSONAPIAdapter that supports the JSON API specification and if your server endpoint supports the use of an 'include' query parameter, you can use findRecord() or findAll() to automatically retrieve additional records related to the one you request by supplying an include parameter in the options object.

For example, given a post model that has a hasMany relationship with a comment model, when we retrieve a specific post we can have the server also return that post's comments in the same request:

export default class PostRoute extends Route {
  model(params) {
    return this.store.findRecord('post', params.post_id, { include: 'comments' });
  }
}

export default class Adapter {
  findRecord(store, schema, id, snapshot) {
    let type = schema.modelName;

    if (type === 'post')
      let includes = snapshot.adapterOptions.include;

      return fetch(`./posts/${postId}?include=${includes}`)
        .then(response => response.json())
    }
  }

  static create() {
    return new this();
  }
}

In this case, the post's comments would then be available in your template as model.comments.

Multiple relationships can be requested using an include parameter consisting of a comma-separated list (without white-space) while nested relationships can be specified using a dot-separated sequence of relationship names. So to request both the post's comments and the authors of those comments the request would look like this:

export default class PostRoute extends Route {
  model(params) {
    return this.store.findRecord('post', params.post_id, { include: 'comments,comments.author' });
  }
}

Retrieving Specific Fields by Type

If your server endpoint supports the use of a 'fields' query parameter, you can use pass those fields through to your server. At this point in time, this requires a few manual steps on your part.

1. Implement buildQuery in your adapter.

buildQuery(snapshot) {
  let query = super.buildQuery(...arguments);

  let { fields } = snapshot.adapterOptions;

  if (fields) {
    query.fields = fields;
  }

  return query;
}

2. Then pass through the applicable fields to your findRecord request.

Given a post model with attributes body, title, publishDate and meta, you can retrieve a filtered list of attributes.

export default class extends Route {
  model(params) {
    return this.store.findRecord('post', params.post_id, { adapterOptions: { fields: { post: 'body,title' } });
  }
}

Moreover, you can filter attributes on related models as well. If a post has a belongsTo relationship to a user, just include the relationship key and attributes.

export default class extends Route {
  model(params) {
    return this.store.findRecord('post', params.post_id, { adapterOptions: { fields: { post: 'body,title', user: 'name,email' } });
  }
}

Get the reference for the specified record.

Example

let userRef = store.getReference('user', '1');

// check if the user 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();
}

// load user (via store.find)
userRef.load().then(...)

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

// provide data for reference
userRef.push({ id: 1, username: '@user' }).then(function(user) {
  userRef.value() === user;
});

Retrieve the RequestStateService instance associated with this Store.

This can be used to query the status of requests that have been initiated for a given identifier.

A hook which an app or addon may implement. Called when the Store is attempting to create a Record Instance for a resource.

This hook can be used to select or instantiate any desired mechanism of presenting cache data to the ui for access mutation, and interaction.

normalize converts a json payload into the normalized form that push expects.

Example

socket.on('message', function(message) {
  let modelName = message.model;
  let data = message.data;
  store.push(store.normalize(modelName, data));
});

This method returns a filtered array that contains all of the known records for a given type in the store.

Note that because it's just a filter, the result will contain any locally created records of the type, however, it will not make a request to the backend to retrieve additional records. If you would like to request all the records from the backend please use store.findAll.

Also note that multiple calls to peekAll for a given type will always return the same RecordArray.

Example

let localPosts = store.peekAll('post');

Get a record by a given type and ID without triggering a fetch.

This method will synchronously return the record if it is available in the store, otherwise it will return null. A record is available if it has been fetched earlier, or pushed manually into the store.

See findRecord if you would like to request this record from the backend.

Note: This is a synchronous method and does not return a promise.

Example 1

let post = store.peekRecord('post', '1');

post.id; // '1'

peekRecord can be called with a single identifier argument instead of the combination of type (modelName) and id as separate arguments. You may recognize this combo as the typical pairing from JSON:API

Example 2

let post = store.peekRecord({ type: 'post', id });
post.id; // '1'

If you have previously received an lid from an Identifier for this record, you can lookup the record again using just the lid.

Example 3

let post = store.peekRecord({ lid });
post.id; // '1'

Push some data for a given type into the store.

This method expects normalized JSON API document. This means you have to follow JSON API specification with few minor adjustments:

• record's type should always be in singular, dasherized form
• members (properties) should be camelCased

Your primary data should be wrapped inside data property:

store.push({
  data: {
    // primary data for single record of type `Person`
    id: '1',
    type: 'person',
    attributes: {
      firstName: 'Daniel',
      lastName: 'Kmak'
    }
  }
});

Demo.

data property can also hold an array (of records):

store.push({
  data: [
    // an array of records
    {
      id: '1',
      type: 'person',
      attributes: {
        firstName: 'Daniel',
        lastName: 'Kmak'
      }
    },
    {
      id: '2',
      type: 'person',
      attributes: {
        firstName: 'Tom',
        lastName: 'Dale'
      }
    }
  ]
});

Demo.

There are some typical properties for JSONAPI payload:

• id - mandatory, unique record's key
• type - mandatory string which matches model's dasherized name in singular form
• attributes - object which holds data for record attributes - attr's declared in model
• relationships - object which must contain any of the following properties under each relationships' respective key (example path is relationships.achievements.data):
• links
• data - place for primary data
• meta - object which contains meta-information about relationship

For this model:

import Model, { attr, hasMany } from '@ember-data/model';

export default class PersonRoute extends Route {
  @attr('string') firstName;
  @attr('string') lastName;

  @hasMany('person') children;
}

To represent the children as IDs:

{
  data: {
    id: '1',
    type: 'person',
    attributes: {
      firstName: 'Tom',
      lastName: 'Dale'
    },
    relationships: {
      children: {
        data: [
          {
            id: '2',
            type: 'person'
          },
          {
            id: '3',
            type: 'person'
          },
          {
            id: '4',
            type: 'person'
          }
        ]
      }
    }
  }
}

Demo.

To represent the children relationship as a URL:

{
  data: {
    id: '1',
    type: 'person',
    attributes: {
      firstName: 'Tom',
      lastName: 'Dale'
    },
    relationships: {
      children: {
        links: {
          related: '/people/1/children'
        }
      }
    }
  }
}

If you're streaming data or implementing an adapter, make sure that you have converted the incoming data into this form. The store's normalize method is a convenience helper for converting a json payload into the form Ember Data expects.

store.push(store.normalize('person', data));

This method can be used both to push in brand new records, as well as to update existing records.

Push some raw data into the store.

This method can be used both to push in brand new records, as well as to update existing records. You can push in more than one type of object at once. All objects should be in the format expected by the serializer.

import RESTSerializer from '@ember-data/serializer/rest';

export default class ApplicationSerializer extends RESTSerializer;

let pushData = {
  posts: [
    { id: 1, postTitle: "Great post", commentIds: [2] }
  ],
  comments: [
    { id: 2, commentBody: "Insightful comment" }
  ]
}

store.pushPayload(pushData);

By default, the data will be deserialized using a default serializer (the application serializer if it exists).

Alternatively, pushPayload will accept a model type which will determine which serializer will process the payload.

import RESTSerializer from '@ember-data/serializer/rest';

 export default class ApplicationSerializer extends RESTSerializer;

import JSONSerializer from '@ember-data/serializer/json';

export default JSONSerializer;

store.pushPayload(pushData); // Will use the application serializer
store.pushPayload('post', pushData); // Will use the post serializer

This method delegates a query to the adapter. This is the one place where adapter-level semantics are exposed to the application.

Each time this method is called a new request is made through the adapter.

Exposing queries this way seems preferable to creating an abstract query language for all server-side queries, and then require all adapters to implement them.

If you do something like this:

store.query('person', { page: 1 });

The request made to the server will look something like this:

GET "/api/v1/person?page=1"

If you do something like this:

store.query('person', { ids: ['1', '2', '3'] });

The request made to the server will look something like this:

GET "/api/v1/person?ids%5B%5D=1&ids%5B%5D=2&ids%5B%5D=3"
decoded: "/api/v1/person?ids[]=1&ids[]=2&ids[]=3"

This method returns a promise, which is resolved with a Collection once the server returns.

This method makes a request for one record, where the id is not known beforehand (if the id is known, use findRecord instead).

This method can be used when it is certain that the server will return a single object for the primary data.

Each time this method is called a new request is made through the adapter.

Let's assume our API provides an endpoint for the currently logged in user via:

// GET /api/current_user
{
  user: {
    id: 1234,
    username: 'admin'
  }
}

Since the specific id of the user is not known beforehand, we can use queryRecord to get the user:

store.queryRecord('user', {}).then(function(user) {
  let username = user.username;
  // do thing
});

The request is made through the adapters' queryRecord:

import Adapter from '@ember-data/adapter';
import $ from 'jquery';

export default class UserAdapter extends Adapter {
  queryRecord(modelName, query) {
    return $.getJSON('/api/current_user');
  }
}

Note: the primary use case for store.queryRecord is when a single record is queried and the id is not known beforehand. In all other cases store.query and using the first item of the array is likely the preferred way:

// GET /users?username=unique
{
  data: [{
    id: 1234,
    type: 'user',
    attributes: {
      username: "unique"
    }
  }]
}

store.query('user', { username: 'unique' }).then(function(users) {
  return users.firstObject;
}).then(function(user) {
  let id = user.id;
});

This method returns a promise, which resolves with the found record.

If the adapter returns no data for the primary data of the payload, then queryRecord resolves with null:

// GET /users?username=unique
{
  data: null
}

store.queryRecord('user', { username: 'unique' }).then(function(user) {
   // user is null
});

Issue a request via the configured RequestManager, inserting the response into the cache and handing back a Future which resolves to a ResponseDocument

Cache Keys

Only GET requests with a url or requests with an explicit cache key (cacheOptions.key) will have the request result and document cached.

The cache key used is requestConfig.cacheOptions.key if present, falling back to requestConfig.url.

Params are not serialized as part of the cache-key, so either ensure they are already in the url or utilize requestConfig.cacheOptions.key. For queries issued via the POST method requestConfig.cacheOptions.key MUST be supplied for the document to be cached.

Requesting Without a Cache Key

Resource data within the request is always updated in the cache, regardless of whether a cache key is present for the request.

Fulfilling From Cache

When a cache-key is determined, the request may fulfill from cache provided the cache is not stale.

Cache staleness is determined by the configured CachePolicy with priority given to the cacheOptions.reload and cacheOptions.backgroundReload on the request if present.

If the cache data has soft expired or the request asks for a background reload, the request will fulfill from cache if possible and make a non-blocking request in the background to update the cache.

If the cache data has hard expired or the request asks for a reload, the request will not fulfill from cache and will make a blocking request to update the cache.

The Response

The primary difference between requestManager.request and store.request is that store.request will attempt to hydrate the response content into a response Document containing RecordInstances.

Trigger a save for a Record.

Returns a promise resolving with the same record when the save is complete.

Returns an instance of the serializer for a given type. For example, serializerFor('person') will return an instance of App.PersonSerializer.

If no App.PersonSerializer is found, this method will look for an App.ApplicationSerializer (the default serializer for your entire application).

If a serializer cannot be found on the adapter, it will fall back to an instance of JSONSerializer.

A hook which an app or addon may implement. Called when the Store is destroying a Record Instance. This hook should be used to teardown any custom record instances instantiated with instantiateRecord.

This method unloads all records in the store. It schedules unloading to happen during the next run loop.

Optionally you can pass a type which unload all records for a given type.

store.unloadAll();
store.unloadAll('post');

For symmetry, a record can be unloaded via the store. This will cause the record to be destroyed and freed up for garbage collection.

Example

store.findRecord('post', '1').then(function(post) {
  store.unloadRecord(post);
});