SolrAdapter Class
Ember Data Adapter for Apache Solr.
Item Index
Methods
- _lazyInjections
- _onLookup
- _scheduledDestroy
- addObserver
- ajax
- ajaxError
- ajaxOptions
- ajaxSuccess
- beginPropertyChanges
- buildRequest
- cacheFor
- combinePath
- coreForType
- createRecord
- decrementProperty
- deleteRecord
- destroy
- endPropertyChanges
- executeRequest
- filterQueryForType
- find
- findAll
- findMany
- findQuery
- generateIdForRecord
- get
- getProperties
- getWithDefault
- handlerForType
- hasObserverFor
- incrementProperty
- init
- notifyPropertyChange
- propertyDidChange
- propertyWillChange
- removeObserver
- reopen
- reopenClass
- serialize
- set
- setProperties
- toggleProperty
- toString
- uniqueKeyForType
- updateRecord
- willDestroy
Methods
_lazyInjections
()
Object
Returns a hash of property names and container names that injected properties will lookup on the container lazily.
Returns:
Hash of all lazy injected property keys to container names
_onLookup
()
private
Provides lookup-time type validation for injected properties.
_scheduledDestroy
()
private
Invoked by the run loop to actually destroy the object. This is
scheduled for execution by the destroy
method.
addObserver
-
key
-
target
-
method
Adds an observer on a property.
This is the core method used to register an observer for a property.
Once you call this method, any time the key's value is set, your observer will be notified. Note that the observers are triggered any time the value is set, regardless of whether it has actually changed. Your observer should be prepared to handle that.
You can also pass an optional context parameter to this method. The context will be passed to your observer method whenever it is triggered. Note that if you add the same target/method pair on a key multiple times with different context parameters, your observer will only be called once with the last context you passed.
Observer Methods
Observer methods you pass should generally have the following signature if
you do not pass a context
parameter:
fooDidChange: function(sender, key, value, rev) { };
The sender is the object that changed. The key is the property that changes. The value property is currently reserved and unused. The rev is the last property revision of the object when it changed, which you can use to detect if the key value has really changed or not.
If you pass a context
parameter, the context will be passed before the
revision like so:
fooDidChange: function(sender, key, value, context, rev) { };
Usually you will not need the value, context or revision parameters at the end. In this case, it is common to write observer methods that take only a sender and key value as parameters or, if you aren't interested in any of these values, to write an observer that has no parameters at all.
ajax
-
url
-
type
-
options
Takes a URL, an HTTP method and a hash of data, and makes an
HTTP request.
When the server responds with a payload, Ember Data will call into extractSingle
or extractArray
(depending on whether the original query was for one record or
many records).
By default, ajax
method has the following behavior:
- It sets the response
dataType
to"json"
- If the HTTP method is not
"GET"
, it sets theContent-Type
to beapplication/json; charset=utf-8
- If the HTTP method is not
"GET"
, it stringifies the data passed in. The data is the serialized record in the case of a save. - Registers success and failure handlers.
Returns:
promise
ajaxError
-
jqXHR
-
responseText
Takes an ajax response, and returns an error payload.
Returning a DS.InvalidError
from this method will cause the
record to transition into the invalid
state and make the
errors
object available on the record.
This function should return the entire payload as received from the
server. Error object extraction and normalization of model errors
should be performed by extractErrors
on the serializer.
Example
App.ApplicationAdapter = DS.RESTAdapter.extend({
ajaxError: function(jqXHR) {
var error = this._super(jqXHR);
if (jqXHR && jqXHR.status === 422) {
var jsonErrors = Ember.$.parseJSON(jqXHR.responseText);
return new DS.InvalidError(jsonErrors);
} else {
return error;
}
}
});
Note: As a correctness optimization, the default implementation of
the ajaxError
method strips out the then
method from jquery's
ajax response (jqXHR). This is important because the jqXHR's
then
method fulfills the promise with itself resulting in a
circular "thenable" chain which may cause problems for some
promise libraries.
Parameters:
-
jqXHR
Object -
responseText
Object
Returns:
jqXHR
ajaxOptions
-
url
-
type
-
options
Returns:
ajaxSuccess
-
jqXHR
-
jsonPayload
Takes an ajax response, and returns the json payload. By default this hook just returns the jsonPayload passed to it. You might want to override it in two cases:
- Your API might return useful results in the request headers. If you need to access these, you can override this hook to copy them from jqXHR to the payload object so they can be processed in you serializer.
- Your API might return errors as successful responses with status code 200 and an Errors text or object. You can return a DS.InvalidError from this hook and it will automatically reject the promise and put your record into the invalid state.
Parameters:
-
jqXHR
Object -
jsonPayload
Object
Returns:
jsonPayload
beginPropertyChanges
()
Ember.Observable
Begins a grouping of property changes.
You can use this method to group property changes so that notifications
will not be sent until the changes are finished. If you plan to make a
large number of changes to an object at one time, you should call this
method at the beginning of the changes to begin deferring change
notifications. When you are done making changes, call
endPropertyChanges()
to deliver the deferred change notifications and end
deferring.
Returns:
buildRequest
-
store
-
type
-
operation
-
data
Builds a request to send to Solr.
Parameters:
-
store
instance of DS.Store -
type
subclass of DS.Modelthe model type
-
operation
Stringone of
find
,findQuery
, etc. -
data
Datato be sent in the request
Returns:
request
cacheFor
-
keyName
Returns the cached value of a computed property, if it exists. This allows you to inspect the value of a computed property without accidentally invoking it if it is intended to be generated lazily.
Parameters:
-
keyName
String
Returns:
The cached value of the computed property, if any
combinePath
-
path1
-
path2
Joins two or more strings into a path delimited by forward slashes without adding redundant slashes. Any number of arguments can be passed into this method.
Returns:
coreForType
-
type
-
operation
Determines which Solr Core should handle queries for a given type and oepration. By default, defaultCore is used.
Parameters:
-
type
subclass of DS.Model -
operation
String
Returns:
core name
createRecord
-
store
-
type
-
record
Implement this method in a subclass to handle the creation of new records.
Serializes the record and send it to the server.
Example
App.ApplicationAdapter = DS.Adapter.extend({
createRecord: function(store, type, record) {
var data = this.serialize(record, { includeId: true });
var url = type;
return new Ember.RSVP.Promise(function(resolve, reject) {
jQuery.ajax({
type: 'POST',
url: url,
dataType: 'json',
data: data
}).then(function(data) {
Ember.run(null, resolve, data);
}, function(jqXHR) {
jqXHR.then = null; // tame jQuery's ill mannered promises
Ember.run(null, reject, jqXHR);
});
});
}
});
Parameters:
Returns:
promise
decrementProperty
-
keyName
-
decrement
Set the value of a property to the current value minus some amount.
player.decrementProperty('lives');
orc.decrementProperty('health', 5);
Parameters:
-
keyName
StringThe name of the property to decrement
-
decrement
NumberThe amount to decrement by. Defaults to 1
Returns:
The new property value
deleteRecord
-
store
-
type
-
record
Implement this method in a subclass to handle the deletion of a record.
Sends a delete request for the record to the server.
Example
App.ApplicationAdapter = DS.Adapter.extend({
deleteRecord: function(store, type, record) {
var data = this.serialize(record, { includeId: true });
var id = record.get('id');
var url = [type, id].join('/');
return new Ember.RSVP.Promise(function(resolve, reject) {
jQuery.ajax({
type: 'DELETE',
url: url,
dataType: 'json',
data: data
}).then(function(data) {
Ember.run(null, resolve, data);
}, function(jqXHR) {
jqXHR.then = null; // tame jQuery's ill mannered promises
Ember.run(null, reject, jqXHR);
});
});
}
});
Parameters:
Returns:
promise
destroy
()
Ember.Object
Destroys an object by setting the isDestroyed
flag and removing its
metadata, which effectively destroys observers and bindings.
If you try to set a property on a destroyed object, an exception will be raised.
Note that destruction is scheduled for the end of the run loop and does not happen immediately. It will set an isDestroying flag immediately.
Returns:
receiver
endPropertyChanges
()
Ember.Observable
Ends a grouping of property changes.
You can use this method to group property changes so that notifications
will not be sent until the changes are finished. If you plan to make a
large number of changes to an object at one time, you should call
beginPropertyChanges()
at the beginning of the changes to defer change
notifications. When you are done making changes, call this method to
deliver the deferred change notifications and end deferring.
Returns:
executeRequest
-
request
Builds a complete URL and initiates an AJAX request to Solr.
Parameters:
-
request
SolrRequest
Returns:
promise
filterQueryForType
-
type
-
operation
Builds an optional filter query (fq
) to include in search requests.
If multiple models are stored in the same Solr Core, applying
an appropriate filter query will ensure only the documents of
the appropriate type are included.
Example
App.ApplicationAdapter = SolrAdapter.extend({
filterQueryForType: function(type) {
return 'doc_type:' + type;
}
});
Returns:
a filter query or null
find
()
Find a record by its unique ID.
findAll
()
Find all documents of a type.
findMany
()
Find multiple documents in a single request.
findQuery
()
Find one or more records by arbitrary query
The query hash should include the key q
with
an appropriate Solr query to execute. If this key
is not specified, *:*
will be used to match all
documents.
The query hash may include the keys limit
and/or
offset
to override the Solr request handler's
page size and retrieve rows from a given offset.
generateIdForRecord
-
store
-
record
If the globally unique IDs for your records should be generated on the client,
implement the generateIdForRecord()
method. This method will be invoked
each time you create a new record, and the value returned from it will be
assigned to the record's primaryKey
.
Most traditional REST-like HTTP APIs will not use this method. Instead, the ID
of the record will be set by the server, and your adapter will update the store
with the new ID when it calls didCreateRecord()
. Only implement this method if
you intend to generate record IDs on the client-side.
The generateIdForRecord()
method will be invoked with the requesting store as
the first parameter and the newly created record as the second parameter:
generateIdForRecord: function(store, record) {
var uuid = App.generateUUIDWithStatisticallyLowOddsOfCollision();
return uuid;
}
Returns:
id
get
-
keyName
Retrieves the value of a property from the object.
This method is usually similar to using object[keyName]
or object.keyName
,
however it supports both computed properties and the unknownProperty
handler.
Because get
unifies the syntax for accessing all these kinds
of properties, it can make many refactorings easier, such as replacing a
simple property with a computed property, or vice versa.
Computed Properties
Computed properties are methods defined with the property
modifier
declared at the end, such as:
fullName: function() {
return this.get('firstName') + ' ' + this.get('lastName');
}.property('firstName', 'lastName')
When you call get
on a computed property, the function will be
called and the return value will be returned instead of the function
itself.
Unknown Properties
Likewise, if you try to call get
on a property whose value is
undefined
, the unknownProperty()
method will be called on the object.
If this method returns any value other than undefined
, it will be returned
instead. This allows you to implement "virtual" properties that are
not defined upfront.
Parameters:
-
keyName
StringThe property to retrieve
Returns:
The property value or undefined.
getProperties
-
list
To get the values of multiple properties at once, call getProperties
with a list of strings or an array:
record.getProperties('firstName', 'lastName', 'zipCode');
// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }
is equivalent to:
record.getProperties(['firstName', 'lastName', 'zipCode']);
// { firstName: 'John', lastName: 'Doe', zipCode: '10011' }
Parameters:
-
list
String... | Arrayof keys to get
Returns:
getWithDefault
-
keyName
-
defaultValue
Retrieves the value of a property, or a default value in the case that the
property returns undefined
.
person.getWithDefault('lastName', 'Doe');
Parameters:
-
keyName
StringThe name of the property to retrieve
-
defaultValue
ObjectThe value to return if the property value is undefined
Returns:
The property value or the defaultValue.
handlerForType
-
type
-
operation
Determines which Solr Core should handle queries for a given type and operation.
When
enableRealTimeGet
is set to true
, this method will choose RealTimeGet
for find
and findMany
operations.
Override this method to customize the path and type of handler that should be used for given operations.
Parameters:
-
type
subclass of DS.Model -
operation
String
Returns:
handler instance
hasObserverFor
-
key
Returns true
if the object currently has observers registered for a
particular key. You can use this method to potentially defer performing
an expensive action until someone begins observing a particular property
on the object.
Parameters:
-
key
StringKey to check
Returns:
incrementProperty
-
keyName
-
increment
Set the value of a property to the current value plus some amount.
person.incrementProperty('age');
team.incrementProperty('score', 2);
Parameters:
-
keyName
StringThe name of the property to increment
-
increment
NumberThe amount to increment by. Defaults to 1
Returns:
The new property value
init
()
An overridable method called when objects are instantiated. By default, does nothing unless it is overridden during class definition.
Example:
App.Person = Ember.Object.extend({
init: function() {
alert('Name is ' + this.get('name'));
}
});
var steve = App.Person.create({
name: "Steve"
});
// alerts 'Name is Steve'.
NOTE: If you do override init
for a framework class like Ember.View
or
Ember.ArrayController
, be sure to call this._super()
in your
init
declaration! If you don't, Ember may not have an opportunity to
do important setup work, and you'll see strange behavior in your
application.
notifyPropertyChange
-
keyName
Convenience method to call propertyWillChange
and propertyDidChange
in
succession.
Parameters:
-
keyName
StringThe property key to be notified about.
Returns:
propertyDidChange
-
keyName
Notify the observer system that a property has just changed.
Sometimes you need to change a value directly or indirectly without
actually calling get()
or set()
on it. In this case, you can use this
method and propertyWillChange()
instead. Calling these two methods
together will notify all observers that the property has potentially
changed value.
Note that you must always call propertyWillChange
and propertyDidChange
as a pair. If you do not, it may get the property change groups out of
order and cause notifications to be delivered more often than you would
like.
Parameters:
-
keyName
StringThe property key that has just changed.
Returns:
propertyWillChange
-
keyName
Notify the observer system that a property is about to change.
Sometimes you need to change a value directly or indirectly without
actually calling get()
or set()
on it. In this case, you can use this
method and propertyDidChange()
instead. Calling these two methods
together will notify all observers that the property has potentially
changed value.
Note that you must always call propertyWillChange
and propertyDidChange
as a pair. If you do not, it may get the property change groups out of
order and cause notifications to be delivered more often than you would
like.
Parameters:
-
keyName
StringThe property key that is about to change.
Returns:
removeObserver
-
key
-
target
-
method
Remove an observer you have previously registered on this object. Pass
the same key, target, and method you passed to addObserver()
and your
target will no longer receive notifications.
reopen
()
Augments a constructor's prototype with additional properties and functions:
MyObject = Ember.Object.extend({
name: 'an object'
});
o = MyObject.create();
o.get('name'); // 'an object'
MyObject.reopen({
say: function(msg){
console.log(msg);
}
})
o2 = MyObject.create();
o2.say("hello"); // logs "hello"
o.say("goodbye"); // logs "goodbye"
To add functions and properties to the constructor itself,
see reopenClass
reopenClass
()
Augments a constructor's own properties and functions:
MyObject = Ember.Object.extend({
name: 'an object'
});
MyObject.reopenClass({
canBuild: false
});
MyObject.canBuild; // false
o = MyObject.create();
In other words, this creates static properties and functions for the class. These are only available on the class and not on any instance of that class.
App.Person = Ember.Object.extend({
name : "",
sayHello : function(){
alert("Hello. My name is " + this.get('name'));
}
});
App.Person.reopenClass({
species : "Homo sapiens",
createPerson: function(newPersonsName){
return App.Person.create({
name:newPersonsName
});
}
});
var tom = App.Person.create({
name : "Tom Dale"
});
var yehuda = App.Person.createPerson("Yehuda Katz");
tom.sayHello(); // "Hello. My name is Tom Dale"
yehuda.sayHello(); // "Hello. My name is Yehuda Katz"
alert(App.Person.species); // "Homo sapiens"
Note that species
and createPerson
are not valid on the tom
and yehuda
variables. They are only valid on App.Person
.
To add functions and properties to instances of
a constructor by extending the constructor's prototype
see reopen
serialize
-
record
-
options
Proxies to the serializer's serialize
method.
Example
App.ApplicationAdapter = DS.Adapter.extend({
createRecord: function(store, type, record) {
var data = this.serialize(record, { includeId: true });
var url = type;
// ...
}
});
Parameters:
-
record
DS.Model -
options
Object
Returns:
serialized record
set
-
keyName
-
value
Sets the provided key or path to the value.
This method is generally very similar to calling object[key] = value
or
object.key = value
, except that it provides support for computed
properties, the setUnknownProperty()
method and property observers.
Computed Properties
If you try to set a value on a key that has a computed property handler
defined (see the get()
method for an example), then set()
will call
that method, passing both the value and key instead of simply changing
the value itself. This is useful for those times when you need to
implement a property that is composed of one or more member
properties.
Unknown Properties
If you try to set a value on a key that is undefined in the target
object, then the setUnknownProperty()
handler will be called instead. This
gives you an opportunity to implement complex "virtual" properties that
are not predefined on the object. If setUnknownProperty()
returns
undefined, then set()
will simply set the value on the object.
Property Observers
In addition to changing the property, set()
will also register a property
change with the object. Unless you have placed this call inside of a
beginPropertyChanges()
and endPropertyChanges(),
any "local" observers
(i.e. observer methods declared on the same object), will be called
immediately. Any "remote" observers (i.e. observer methods declared on
another object) will be placed in a queue and called at a later time in a
coalesced manner.
Chaining
In addition to property changes, set()
returns the value of the object
itself so you can do chaining like this:
record.set('firstName', 'Charles').set('lastName', 'Jolley');
Parameters:
-
keyName
StringThe property to set
-
value
ObjectThe value to set or
null
.
Returns:
setProperties
-
hash
Sets a list of properties at once. These properties are set inside
a single beginPropertyChanges
and endPropertyChanges
batch, so
observers will be buffered.
record.setProperties({ firstName: 'Charles', lastName: 'Jolley' });
Parameters:
-
hash
Hashthe hash of keys and values to set
Returns:
toggleProperty
-
keyName
Set the value of a boolean property to the opposite of its current value.
starship.toggleProperty('warpDriveEngaged');
Parameters:
-
keyName
StringThe name of the property to toggle
Returns:
The new property value
toString
()
String
Returns a string representation which attempts to provide more information
than Javascript's toString
typically does, in a generic way for all Ember
objects.
App.Person = Em.Object.extend()
person = App.Person.create()
person.toString() //=> "<App.Person:ember1024>"
If the object's class is not defined on an Ember namespace, it will indicate it is a subclass of the registered superclass:
Student = App.Person.extend()
student = Student.create()
student.toString() //=> "<(subclass of App.Person):ember1025>"
If the method toStringExtension
is defined, its return value will be
included in the output.
App.Teacher = App.Person.extend({
toStringExtension: function() {
return this.get('fullName');
}
});
teacher = App.Teacher.create()
teacher.toString(); //=> "<App.Teacher:ember1026:Tom Dale>"
Returns:
string representation
uniqueKeyForType
-
type
Determines the unique key
for a given type. Default Solr schemas use the canonical field id
and this method defaults to the same field.
Parameters:
-
type
subclass of DS.Model
Returns:
updateRecord
-
store
-
type
-
record
Implement this method in a subclass to handle the updating of a record.
Serializes the record update and send it to the server.
Example
App.ApplicationAdapter = DS.Adapter.extend({
updateRecord: function(store, type, record) {
var data = this.serialize(record, { includeId: true });
var id = record.get('id');
var url = [type, id].join('/');
return new Ember.RSVP.Promise(function(resolve, reject) {
jQuery.ajax({
type: 'PUT',
url: url,
dataType: 'json',
data: data
}).then(function(data) {
Ember.run(null, resolve, data);
}, function(jqXHR) {
jqXHR.then = null; // tame jQuery's ill mannered promises
Ember.run(null, reject, jqXHR);
});
});
}
});
Parameters:
Returns:
promise
willDestroy
()
Override to implement teardown.
Properties
baseURL
String
The base URL where the Solr instance is hosted.
This property is typically configured by setting
ENV.solrBaseURL
in your config/environment.js
file.
Default: '/solr'
commit
SolrCommitType
When enabled, sends a commit
command to Solr in update
requests to commit the index synchronously and
block the request until commit has completed.
There are many considerations when choosing to enable this feature. Consult the Solr documentation on autoCommit, and softAutoCommit.
See also commitWithinMilliseconds.
Default: SolrCommitType.None
commitWithinMilliseconds
Number milliseconds
When set, sends a commitWithin
command to Solr
in update requests to have the update committed
within a time limit (in milliseconds). Solr will
aggregate multiple pending writes into a single
commit to reduce overhead and improve performance.
This property, when set, takes precedence over commit.
There are many considerations when choosing to enable this feature. Consult the Solr documentation on autoCommit, and softAutoCommit.
In Solr 4 and later, commitWithin is handled by default as a soft commit. See UpdateHandlers in SolrConfig.
See also commit.
Default: undefined
concatenatedProperties
Array
Defines the properties that will be concatenated from the superclass (instead of overridden).
By default, when you extend an Ember class a property defined in
the subclass overrides a property with the same name that is defined
in the superclass. However, there are some cases where it is preferable
to build up a property's value by combining the superclass' property
value with the subclass' value. An example of this in use within Ember
is the classNames
property of Ember.View
.
Here is some sample code showing the difference between a concatenated property and a normal one:
App.BarView = Ember.View.extend({
someNonConcatenatedProperty: ['bar'],
classNames: ['bar']
});
App.FooBarView = App.BarView.extend({
someNonConcatenatedProperty: ['foo'],
classNames: ['foo']
});
var fooBarView = App.FooBarView.create();
fooBarView.get('someNonConcatenatedProperty'); // ['foo']
fooBarView.get('classNames'); // ['ember-view', 'bar', 'foo']
This behavior extends to object creation as well. Continuing the above example:
var view = App.FooBarView.create({
someNonConcatenatedProperty: ['baz'],
classNames: ['baz']
})
view.get('someNonConcatenatedProperty'); // ['baz']
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']
Adding a single property that is not an array will just add it in the array:
var view = App.FooBarView.create({
classNames: 'baz'
})
view.get('classNames'); // ['ember-view', 'bar', 'foo', 'baz']
Using the concatenatedProperties
property, we can tell Ember to mix the
content of the properties.
In Ember.View
the classNameBindings
and attributeBindings
properties
are also concatenated, in addition to classNames
.
This feature is available for you to use throughout the Ember object model, although typical app developers are likely to use it infrequently. Since it changes expectations about behavior of properties, you should properly document its usage in each individual concatenated property (to not mislead your users to think they can override the property in a subclass).
Default: null
dataType
String
Sets the data type for jQuery ajax requests.
Either json
or jsonp
are supported.
jsonp
is provided as the default to allow cross-origin
requests to succeed without needing special customization
of the Solr server.
Default: 'jsonp'
defaultCore
String
Specifies a default Solr Core to send requests to. If no default core is configured, this adapter will not include a core in the request URI path and the Solr server will use its own default.
Default: null
defaultSerializer
String
Sets the default serializer for this adapter. Uses SolrSerializer by default.
Default: '-solr'
enableRealTimeGet
Boolean
Enables or disables sending requests to Solr's Real Time Get handler. Note that this handler is disabled by default on many Solr servers.
Real Time Get allows retrieval of documents that have not yet been committed by retrieving them from the update log.
If you are using SolrCloud, it is generally safe to enable this feature.
Default: false
isDestroyed
Unknown
Destroyed object property flag.
if this property is true
the observers and bindings were already
removed by the effect of calling the destroy()
method.
Default: false
isDestroying
Unknown
Destruction scheduled flag. The destroy()
method has been called.
The object stays intact until the end of the run loop at which point
the isDestroyed
flag is set.
Default: false
updateMode
SolrUpdateMode
Sets the concurrency mode for how updates are sent to Solr.
Default: SolrUpdateType.None