Bookshelf vital

0.1.15 • Public • Published 7 years ago ReadmeCode Beta3 Dependencies6 Dependents16 Versionsbookshelf-eloquentThis is a plugin for Bookshelf.js that adds some functionality from the Laravel's eloquent ORM. Most notably it improves nested eager loading (with function) and adds the withCount and whereHas functions while supporting existing Bookshelf plugins like registry, visibility, bookshelf-paranoia and others. All the functions documented here are accessible on both the static Bookshelf models and their instances.About Bookshelf:Bookshelf is a JavaScript ORM for Node.js, built on the Knex SQL query builder. Featuring both promise based and traditional callback interfaces, providing transaction support, eager/nested-eager relation loading, polymorphic associations, and support for one-to-one, one-to-many, and many-to-many relations. It is designed to work well with PostgreSQL, MySQL, and SQLite3.Requirementsrequires node v7.6.0 or higher for ES2015 and async function support,all the documented functions have been tested on Bookshelf 0.12.0, 0.10.4, 0.10.3 and MySQL.InstallationRun the npm install command:npm i --save bookshelf-eloquentAfter installing bookshelf-eloquent, all you need to do is add it as a bookshelf plugin to enable it on your models.let knex = require('knex')(require('./knexfile.js').development);let bookshelf = require('bookshelf')(knex);bookshelf.plugin(require('bookshelf-eloquent'));List of supported relationshasOnebelongsTohasManybelongsToManyList of all functionsModel.get([options]) → Promise.first([options]) → Promise.select(columns) → Bookshelf model (this) / function is chainableKnex where statements (see the Where statements section).orderBy(column, [direction]) → Bookshelf model (this) / function is chainable Knex docs for orderBy.orderByRaw(sql) → Bookshelf model (this) / function is chainable Knex docs for orderByRaw.offset(value) / .skip → Bookshelf model (this) / function is chainable Knex docs for offset.limit(value) / .take → Bookshelf model (this) / function is chainable Knex docs for limit.with(withRelated, [signleRelationSubquery]) → Bookshelf model (this) / function is chainable.withSelect(relationName, columns, [subquery]) → Bookshelf model (this) / function is chainable.withCount(withRelated, [signleRelationSubquery]) → Bookshelf model (this) / function is chainable.has(relationName, [operator], [operand1], [operand2]) / .orHas → Bookshelf model (this) / function is chainable.where(~mixed~) / .orWhere → Bookshelf model (this) / function is chainable (nested where support).whereHas(relationName, [subquery], [operator], [operand1], [operand2]) / .orWhereHas → Bookshelf model (this) / function is chainable.destroyAll([options]) / .deleteAll → Promise.withDeleted() / .withTrashed → Bookshelf model (this) / function is chainable.fakeSync([options]) → PromiseBookshelf Sync>.buildQuery([options]) → PromiseBookshelf Sync>.useTableAlias(alias) → Bookshelf model (this) / function is chainableCollection.add(data, [options])

QUICK VIEW Add to bookshelf The Decline and Fall of the Roman Empire, Volumes 1 to 3 (of six)(Box Set) Edward Gibbon Hardcover $100.00 QUICK VIEW Add to bookshelf The First Emancipator Andrew Levy Paperback $22.00 QUICK VIEW Add to bookshelf The Gospels Paperback $20.00 QUICK VIEW Add to bookshelf On the Natural History of Destruction W.G. Sebald Paperback $21.00 QUICK VIEW Add to bookshelf On Impeachment Paperback $15.00 QUICK VIEW Add to bookshelf Confessions Augustine Paperback $17.00 QUICK VIEW Add to bookshelf The Virgin and the Gipsy D.H. Lawrence Paperback $18.00 QUICK VIEW Add to bookshelf The Decline and Fall of the Roman Empire, Volume I Edward Gibbon Ebook $14.99 QUICK VIEW Add to bookshelf The American Transcendentalists Ralph Waldo Emerson Paperback $22.00 QUICK VIEW Add to bookshelf The Essential Faulkner William Faulkner Ebook $6.99 "Cervantes’s masterpiece is lucky to have found so perfect a translator as the flamboyant Smollett. The rambunctious personalities of author and translator are ideally matched."

For bookshelf-paranoia Bookshelf plugin. Bookshelf-eloquent adds the .withDeleted() and .withTrashed() function which allow you to retrieve soft deleted rows.Example:Now you can use .withDeleted() / .withTrashed()var user = await User.where('id', 57).withDeleted().first();instead of the fetch options (old way):var user = await User.where('id', 57).first({ withDeleted: true });Complete list of function synonyms.get([options]) is Bookshelf's fetchAll,.first([options]) is Bookshelf's fetch,.delete([options]) is Bookshelf's destroy,.withDeleted() is a synonym for .withTrashed()Miscellaneous.fakeSync([options]) → PromiseBookshelf Sync>{object} [options] Bookshelf fetch options.Triggers plugins (like bookshelf-paranoia) that listen to the Bookshelf fetch events by triggering the fetching event. Function returns a PromiseBookshelf Sync>.Exampleconst User = require('../models/user');var sync = await User.where('id', 57).fakeSync();var knexBuilder = sync.query;console.log(knexBuilder.toString());prints:select * from `users` where `id` = 57.buildQuery([options]) → PromiseBookshelf Sync>{object} [options] Bookshelf fetch options.Should be used for subquery building. Similar to the fakeSync function. Triggers plugins (like bookshelf-paranoia) that listen to the Bookshelf fetch events by triggering the fetching event. Also selects the Bookshelf fetch options columns. Function returns a PromiseBookshelf Sync>.Exampleconst User = require('../models/user');var sync = await User.where('id', 57).buildQuery({columns: ['id', 'username']});var knexBuilder = sync.query;console.log(knexBuilder.toString());prints:select `id`, `username` from `users` where `id` = 57.useTableAlias(alias) → Bookshelf model (this) / function is chainable{string} alias Table alias name.Exampleconst User = require('../models/user');var sync = await User.where('id', 57).useTableAlias('t').buildQuery();var knexBuilder = sync.query;console.log(knexBuilder.toString());prints:select `t`.* from `users` as `t` where `id` = 57Bulk insert.add(data, [options]) → Bookshelf model | Bookshelf collection (this) / function is chainable{object|object[]} data Model data. Function returns a Bookshelf model ifIf the data parameter is an object then the function returns a Bookshelf model.If the data parameter is an object[] then the function returns a Bookshelf collection (this) / function is chainable{object} [options] Bookshelf model forge options.This function is overriden Bookshelf collection add function.NOTE: this function is not chainable anymore unless you pass an object[] for the data parameter.ExamplesAdd some users to a user collection.const User = require('../models/user');var userCollection = User.collection();var user1 = userCollection.add({name: 'Geovanny Waelchi Jr.', number: 81});var user2 = userCollection.add({name: 'Christ Green', number: 35});var user3 = userCollection.add({name: 'Timmy Windler', number: 2});userCollection.add([ {name: 'Francisca Altenwerth DDS', number: 33}, {name: 'Lamont Brekke I', number: 55}, {name: 'Georgiana Frami', number: 36}]);.insert([ignoreDuplicates = false]) → Promise (Promise){boolean} ignoreDuplicates Add 'on duplicate ignore' to the SQL statement.If