How do you add enum labels using sequelize?

Question

I have a table called characters. Each character has an enum called "state", which can be "sad" or "happy". How do I add a new state "confused" to my column? I tried this migration but it failed:

migration.describeTable('characters').success(function (attributes) {
    migration.changeColumn('characters', 'state',
        {
            type: DataTypes.ENUM,
            values: ['sad', 'happy', 'confused']
        })
        .complete(done);
});

It complained that error: type "enum_characters_state" already exists.

Edudjr · Accepted Answer · 2017-09-15 17:38:08Z

17

Expanding on briangonzalez answer, you will also need a down function to undo the migration:

'use strict';

module.exports = {
  up: (queryInterface, Sequelize) => {
    return queryInterface.sequelize.query("ALTER TYPE enum_type_name ADD VALUE 'new_value'");
  },

  down: (queryInterface, Sequelize) => {
    var query = 'DELETE FROM pg_enum ' +
      'WHERE enumlabel = \'new_value\' ' +
      'AND enumtypid = ( SELECT oid FROM pg_type WHERE typname = \'enum_type_name\')';
    return queryInterface.sequelize.query(query);
  }
};

change enum_type_name and new_value to fit your needs.

answered Sep 15, 2017 at 17:38

Edudjr

1,85520 silver badges28 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Sylver Over a year ago

That's the most accurate and complete answer, this should be the one accepted for this question.

JacobIRR Over a year ago

When searching for the enum inside pg_enum, are you in the context of one schema or all schemas?

briangonzalez · Accepted Answer · 2019-04-03 05:04:20Z

9

With the latest version of Sequelize, you could achieve this by running a query (Postgres assumed):

module.exports = {
  up: function (queryInterface, Sequelize) {
    return queryInterface.sequelize.query("ALTER TYPE enum_character_state ADD VALUE 'confused';");
  }
};

edited Apr 3, 2019 at 5:04

answered Jan 3, 2016 at 16:57

briangonzalez

1,61616 silver badges21 bronze badges

Comments

Austin · Accepted Answer · 2023-03-02 22:41:05Z

5

I hope I am not late to the party..

this works for me

module.exports = {
  up: async (queryInterface, Sequelize) => {
    await queryInterface.sequelize.query(`
      ALTER TYPE "enum_type_name" ADD VALUE 'confused';
    `);
  },

  down: async(queryInterface, Sequelize) => {
    await queryInterface.sequelize.query(`
      ALTER TYPE "enum_type_name" DROP VALUE 'confused';
    `);
  }
};

answered Mar 2, 2023 at 22:41

Austin

4341 gold badge11 silver badges21 bronze badges

Comments

Zaeem · Accepted Answer · 2018-06-08 11:46:26Z

4

create a migration with following script:

module.exports = {
  up  : function (queryInterface) {
    return queryInterface
      .changeColumn(tableName, columnName, {
        values: arrayOfNewValues
      });
  },
  down: function (queryInterface) {
    return queryInterface
      .changeColumn(tableName, columnName, {
        values: arrayOfOldValues
      });
  }
};

answered Jun 8, 2018 at 11:46

Zaeem

3924 silver badges17 bronze badges

2 Comments

Alexander Santos Over a year ago

This should be the accepted one. It's the less database-dependant solution.

Tomh Over a year ago

This one doesn't work for me with PostgreSQL - it complains that the enum type already exists.

Pang · Accepted Answer · 2017-03-30 07:35:36Z

0

You need to remove the type, if you want to re-add it. Useful in down migrations if nothing else.

queryInterface.sequelize.query('DROP TYPE enum_characters_state;')

edited Mar 30, 2017 at 7:35

Pang

10.2k146 gold badges87 silver badges126 bronze badges

answered Mar 30, 2017 at 7:04

Smolkis

113 bronze badges

Collectives™ on Stack Overflow

How do you add enum labels using sequelize?

5 Answers 5

2 Comments

Comments

Comments

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

2 Comments

Comments

Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related