Mixin the triggerThen function into all relevant Backbone objects,
10 | so we can have event driven async validations, functions, etc.
An example "sync" object which is extended 4 | by dialect-specific sync implementations, 5 | making Bookshelf effectively a data store 6 | agnostic "Data Mapper".
Used as the base of the prototype chain,
10 | a convenient object for any instanceof
11 | checks you may need.
May be used for any setup for the class.
Return a single model object.
Select one or more models, returning an array 16 | of data objects.
Insert a single row, returning an object 19 | (typically containing an "insert id").
Update an object in the data store.
Delete a record from the data store.
Used internally, the Relation helps in simplifying the relationship building,
11 | centralizing all logic dealing with type & option handling.
Creates a new relation instance, used by the Eager relation in
21 | dealing with morphTo cases, where the same relation is targeting multiple models.
Creates a new model, used internally in the eager fetch helper methods.
Eager pair the models.
The exec plugin is used to optionally add
2 | support node-style callbacks, delegating to the promise
3 | method under the hood:
Bookshelf.plugin(require('bookshelf/plugins/exec'))
Accept the instance of Bookshelf we'd like to add exec support to.
A method which is passed the target object and method we're
6 | looking to extend with the exec interface.
The then method is essentially the same as it was before, 12 | just is not automatically called.
A facade for the then method, throwing any uncaught errors
16 | rather than swallowing them.
Wrap the appropriate methods on each object prototype, exposing the new API.
Sets the constraints necessary during a model.save call.
Finds the specific morphTo table we should be working with, or throws
17 | an error if none is matched.
If there are no arguments, return the current object's 26 | query builder (or create and return a new one). If there are arguments, 27 | call the query builder with the first argument, applying the rest. 28 | If the first argument is an object, assume the keys are query builder 29 | methods, and the values are the arguments for the query.
(c) 2013 Tim Griesser
2 | Bookshelf may be freely distributed under the MIT license.
3 | For all details and documentation:
4 | http://bookshelfjs.org
5 | All external libraries needed in this scope.
All local dependencies... These are the main objects that 11 | need to be augmented in the constructor to work properly.
Finally, the Events, which we've supplemented with a triggerThen
14 | method to allow for asynchronous event handling via promises. We also
15 | mix this into the prototypes of the main objects in the library.
Constructor for a new Bookshelf object, it accepts
16 | an active knex instance and initializes the appropriate
17 | Model and Collection constructors for use in the current instance.
Allows you to construct the library with either Bookshelf(opts)
18 | or new Bookshelf(opts).
If the knex isn't a Knex instance, we'll assume it's
21 | a compatible config object and pass it through to create a new instance.
The Model constructor is referenced as a property on the Bookshelf instance,
24 | mixing in the correct builder method, as well as the relation method,
25 | passing in the correct Model & Collection constructors for later reference.
The collection also references the correct Model, specified above, for creating
33 | new Model instances in the collection. We also extend with the correct builder /
34 | knex combo.
Used internally, the Relation helps in simplifying the relationship building,
40 | centralizing all logic dealing with type & option handling.
Grab a reference to the knex instance passed (or created) in this constructor,
44 | for convenience.
A Bookshelf instance may be used as a top-level pub-sub bus, as it mixes in the
46 | Events object. It also contains the version number, and a Transaction method
47 | referencing the correct version of knex passed into the object.
Keep in sync with package.json.
Helper method to wrap a series of Bookshelf actions in a knex transaction block;
Provides a nice, tested, standardized way of adding plugins to a Bookshelf instance,
50 | injecting the current instance into the plugin, which should be a module.exports.
Alias to new Bookshelf(opts).
The forge function properly instantiates a new Model or Collection
58 | without needing the new operator... to make object creation cleaner
59 | and more chainable.
Finally, export Bookshelf to the world.
Sync is the dispatcher for any database queries,
9 | taking the "syncing" model or collection being queried, along with
10 | a hash of options that are used in the various query methods.
11 | If the transacting option is set, the query is assumed to be
12 | part of a transaction, and this information is passed along to Knex.
Select the first item from the database - only used by models.
Runs a select query on the database, adding any necessary relational
28 | constraints, resetting the query when complete. If there are results and
29 | eager loaded relations, those are fetched and returned on the model before
30 | the promise is resolved. Any success handler passed in the
31 | options will be called - used by both models & collections.
Inject all appropriate select costraints dealing with the relation
34 | into the knex query builder for the current instance.
Set the query builder on the options, in-case we need to
40 | access in the fetching event handlers.
Trigger a fetching event on the model, and then select the appropriate columns.
Issues an insert command on the query - only used by models.
Issues an update command on the query - only used by models.
Issues a delete command on the query.
Events