sequelize: Can't exclude association's fields from select statement in sequelize

I have the following code (simplified):

var group = sequelize.define("group", {
    id: {type: DataTypes.INTEGER, autoIncrement: false, primaryKey: true},
    name: type: DataTypes.STRING,
    parentId: DataTypes.INTEGER
}, { classMethods: {
        associate: function (models) {
            group.belongsToMany(models.item, { as:'items', foreignKey: 'group_id', through: models.group_item_tie });
        }}
});

var group_item_tie = sequelize.define("group_item_tie", {}, {freezeTableName: true});

var item = sequelize.define("item", {
    spn: { type: DataTypes.INTEGER, autoIncrement: false, primaryKey: true },
}, { classMethods: {
        associate: function (models) {
            item.belongsToMany(models.group, { foreignKey: 'spn', through: models.group_item_tie });
        }}
});

When I try to return some records with relationships, let’s say like this:

dbcontext.group.findAll({
    where: { id: 6 },
    include: [{
                model: dbcontext.item,
                as: 'items',
                attributes: ['spn']
            }]
    })

I also get in result the fields from a tie table group_item_tie:

[{
    "id": 6,
    "name": "abc",
    "parentId": 5,
    "createdAt": "2015-05-06T15:54:58.000Z",
    "updatedAt": "2015-05-06T15:54:58.000Z",
    "items": [
        {   "spn": 1,
            "group_item_tie": {
                "createdAt": "2015-05-06 15:54:58.000 +00:00",
                "updatedAt": "2015-05-06 15:54:58.000 +00:00",
                "group_id": 6,
                "spn": 1
            }
        },
        {   "spn": 2,
            "group_item_tie": {
                "createdAt": "2015-05-06 15:54:58.000 +00:00",
                "updatedAt": "2015-05-06 15:54:58.000 +00:00",
                "group_id": 6,
                "spn": 2
            }
        },

I see it in generated sql query. How to exclude those from select statement? I’ve tried a few other things but was not successful.

I hope there is something cleaner then just doing:

delete item.group_item_tie;

About this issue

Original URL
State: closed
Created 9 years ago
Reactions: 3
Comments: 18 (3 by maintainers)

Commits related to this issue

Working Location Save * update migration to add required fields * add location module for db calls * update see for location Trick to return relationships without inluding sub resources - https://gi... — committed to jonesmac/breezy-api by deleted user 5 years ago

Most upvoted comments

include: [{
  model: dbcontext.item,
  as: 'items',
  attributes: ['spn'],
  through: {
    attributes: []
  }        
}]

+98

mickhansen on May 7, 2015

just use joinTableAttributes attribute

await user.getCars({
    joinTableAttributes: [] 
})

+13

kuubson on Jan 12, 2020

@AntonAL Did you manage to make it work?

Define “doesn’t work”, what happens, what do you expect to happen, etc.

@mickhansen through: { attributes: [] } doesn’t remove the join table fields from the SELECT. Tested with v4.37.6.

+12

danistefanovic on Apr 24, 2018

This issue should be re-opened, as the provided solution no longer works.

maxbogue on May 22, 2018

How do this by Model.getAssociatedModels()?

mqliutie on May 16, 2019

@mickhansen, It does’t work for “sequelize”: “^4.37.4”. Is there some alternative?

My code is following:

Country.prototype.getCompanies = function(options={}){
    const include = [{
      model: conn.models.city,
      required: true,
      duplicating: false,
      attributes: [],
      through: {
        attributes: []
      },
      include: [{
        model: conn.models.region,
        required: true,
        duplicating: false,
        attributes: [],
        include: [{
          model: conn.models.country,
          attributes: [],
          where: {
            id: this.get('id')
          }
        }]
      }]
    }];

    return conn.models.company.findAll({
      where: options.where,
      attributes: ['id', 'name'],
      limit: options.first,
      include: include,
      order: options.order ? [options.order.split(' ')] : undefined
    });
  };

AntonAL on Apr 10, 2018

yep! on polymorphic relationships, defining the empty through: { attributes: [] } property solves the problem in v4.38.0. it’s not exactly intuitive… but it it works.

e.g.

  MyDude.findOne({
    where: conditions,
    include: [{
      model: MyOtherDude,
      as: 'sub_dudes',
      attributes: ['name', 'slug'],
      through: {
        attributes: []
      }
  }).then((dude) => {
      ...
  });

broox on Aug 14, 2018

@danistefanovic it worked for me in v4.37.10 through: { attributes: [] } removed the join table fields from the SELECT

try upgrading to the latest version

dpkshrma on Jun 16, 2018

@toxxiczny You’re a life saver! This isn’t even included in the types of sequelize-typescript, but works with an as any.

santiagoramirez on Jun 15, 2020

This is what I’m using for my use case where I want to exclude a field from the associated record.

db.Bar.findOne({
  where: {
    attr: 'foo'
  },
  include: [
    {
      model: db.Foo,
      attributes: {
        exclude: ['xattr']
      }
    }
  ]
})

ryanburnette on Nov 4, 2018