knex: what is the appropriate way to create an array from results?

Question

I have an endpoint that joins the user and user_emails table as a one-to-many relationship (postgresql). It look as follows.

router.get('/', function (req, res, next) {
  db.select('users.id', 'users.name', 'user_emails.address')
    .from('users')
    .leftJoin('user_emails', 'users.id', 'user_emails.user_id')
    .then(users => res.status(200).json(users))
    .catch(next)  // go to error handler
});

However, this will return a new document for each email address. What I want is an array of documents that looks as follows:

[{
  id: 1,
  name: 'Steve',
  emails: [
    { address: '[email protected]' },
    { address: '[email protected]' }
  ]
}, {
  id: 2,
  name: 'Jimmy',
  emails: [
    { address: '[email protected]' }
  ]
}]

How should this be done in knex?

Answer 1

Assuming you're using Postgres - you need to use array_agg function to generate arrays. I would suggest using knex.raw

Please let me know if this works.

   knex('users')
    .innerJoin('user_emails','users.id','user_emails.user_id')
    .select([
      'users.id as userID',
      'users.name as userName',
      knex.raw('ARRAY_AGG(user_emails.adress) as email')
    ])
    .groupBy('users.id','users.name')