Insert, update and remove relationships on your Bookshelf models. This plugin supports all relationship types: belongs-to, belongs-to-many has-one and has-many.

npm install bookshelf-relations --save

or

yarn add bookshelf-relations

• It's highly recommended to insert/update/delete your models within transactions when using this plugin, because updating nested relationships requires additional queries to the database. Otherwise if an error occurs during any query, you can't expect data to be rolled back fully.

Take a look at the plugin configuration in Ghost.

The plugin will automatically deal with relationships upserts and cascading deletions through hasMany relationships. It's required to register your relationships in Bookshelf before you can use bookshelf-relations, see this example.

1. Register the plugin.

    bookshelf.plugin('bookshelf-relations', {options});

2. Define your relationships on each model.

    bookshelf.Model.extend({
        relationships: ['tags', 'news']
    }, {...});

To opt-out of automatic child record deletion for hasMany relationships it's possible to define per-relationship config:

    bookshelf.Model.extend({
        relationships: ['tags', 'news', 'events'],
        relationshipConfig: {
            events: {
                destroyRelated: false
            }
        }
    });

You manually need to call the plugin to update relationships. It's required to register your relationships in Bookshelf before you can use bookshelf-relations, see this example.

1. Register the plugin.

    bookshelf.plugin('bookshelf-relations', {options});

2. Manually call bookshelf-relations.

    bookshelf.manager.updateRelations({
        model: model,
        relations: {tags: [...]},
        pluginOptions: {options}
    })

// will detach & remove all existing relations
model.set('tags', []);

// will check if "test" exists and if not, it will insert the target tag
// will remove all previous relations if exist
model.set('tags', [{slug: 'test'}]);

• yarn test to run tests & eslint
• yarn lint to run eslint only
• NODE_ENV=testing-mysql yarn test to run tests with mysql db
• yarn perf to run a performance test
• yarn coverage to run test coverage

• yarn ship

Copyright (c) 2013-2022 Ghost Foundation - Released under the MIT license.