Unclear docs re debug mode

The docs currently show re debugging:

If you pass {debug: true} as one of the options in your initialize settings

It is unclear what is meant by initialize settings, and I couldn’t find reference to them nor their mention anywhere.

The changelog states that it can be passed to any Sync query, which is not clarifying, and the codebase mentions show only the Sync function takes the debug option

I would put a PR in if I had a clue how to enable debug

[fl0w]

Here’s another hack btw.

Bookshelf does a shallow copy of options on use (even down the eager chain). So if you pass an options object with a preset namespace (e.g. context, or scope) you can retain the full qb. This allows for some hacking.

class MyModel extends bookshelf.Model {
  initialize (...args) {
    super.initialize(...args)
    this.on('fetching', (modelCollection, attrs, options) => {
      if (!options.scope || !options.scope.qbs) return
      options.scope.qbs.push(options.query)
    })
  }
}

class MyCollection extends bookshelf.Collection {
  // same as above
}

bookshelf.Model = MyModel

class User extends bookshelf.Model {
  relation () {
    return this.belongsTo('Relation')
  }
  // ...
}

const fetchOptions = {
  withRelated: 'relation',
  scope: {
    qbs: []
  }
}

await bookshelf.model('User').forge().fetch(fetchOptions)

// pseudo but you get the idea
for (const qb of fetchOptions.scope.qbs)
  console.log(await bookshelf.knex.raw(`explain analyze ${qb.toString()}`)

// console.log's the result of an PG explain query for both User- and Relation queries

Edit; It’s late and this was of the top of my head but let me know if you want a more succinct example.

[davidfurlong]

I’m actually thinking of revamping the debug feature to be a little more custom. What kind of features are you missing with the current debug mode?

I don’t know. But debugging my latest issue (https://github.com/bookshelf/bookshelf/issues/1823) would have been easier if I could have seen a log of mutations or functions performed on models. Knex doesn’t show Bookshelf models ids, and logging yourself presumes you know what you’re looking for.