fixing allowNull, onDelete, onChange, deferrable

[obecny]

fixes and new things for postgresql

1. fixing allowNull
2. adding onDelete and onChange for foreign keys
3. adding deferrable information to be used later in ts model for foreign keys.

For point 3 I had to comment out the last piece for deferrable in ModelBuilder.ts, can you please give me a hint how this should be handled - I suspect I need to build some ts property - although I'm not sure how

[spinlud]

@obecny Hi, thanks a lot for the contribution!
I am on vacation now, will look into that when I am back 🙂

[obecny]

@spinlud hey any update on that, thx

[spinlud]

Hi @obecny, sry for the long delay.
I am afraid I am not very familiar with deferred constraints in Postgre, thus I am not sure how much can I help here.

I can be wrong but probably you need to import these types from Sequelize?

import { ModelAttributeColumnOptions, ModelAttributeColumnReferencesOptions } from 'sequelize';

// [...]

const props: Partial<ModelAttributeColumnOptions> = {
                ...col.originName && col.name !== col.originName && { field: col.originName },
                ...col.primaryKey && { primaryKey: col.primaryKey },
                ...col.autoIncrement && { autoIncrement: col.autoIncrement },
                ...col.allowNull && { allowNull: col.allowNull },
                ...col.dataType && { type: col.dataType },
                ...col.comment && { comment: col.comment },
                ...col.defaultValue && { defaultValue: col.defaultValue },
                ...col.onUpdate && { onUpdate: col.onUpdate },
                ...col.onDelete && { onDelete: col.onDelete },
                // @TODO fix this by creating a typescript definition for model
                ...col.references && { references: col.references as ModelAttributeColumnReferencesOptions },
            };

// [...]

Some questions:

Can we extended the onUpdate and onDelete behaviours to all the dialects (probably needed a query update)?

Do you think will be possible to add tests for deferrable constraints in Postgre?

[spinlud]

I think this is redundant, it's the same as build

[obecny]

it is not
https://docs.npmjs.com/misc/scripts#description
This is needed so when you simply call npm install it will build the packages correctly, otherwise the build is not run. This is especially visible when you use the package using github path.

[spinlud]

Probably the following type must be imported?

import { ModelAttributeColumnOptions, ModelAttributeColumnReferencesOptions } from 'sequelize';

[obecny]

This is not about importing types. This is about reading references directly from postgres tables instead of taking it from file definition - this was just a try

[spinlud]

Are these types common to all the Dialects?
If I assuming correctly these are constraint for foreign keys, so we should probably name it something like FOREIGN_KEY_CONSTRAINTS. Also for enum we should probably use more verbose naming, using constant case:

export enum FOREIGN_KEY_CONSTRAINTS {
    CASCADE = 'CASCADE',
    SET_DEFAULT = 'SET DEFAULT',
    SET_NULL = 'SET NULL',
    RESTRICT = 'RESTRICT',
    NO_ACTION = 'NO ACTION',
}

[obecny]

I don't know about other dialects, this is for postgresql. The keys are what is coming from postgresql already and then how it should be mapped so you can't change it

[spinlud]

We probably don't need to create this interface, this type is already defined in sequelize:

/**
 * References options for the column's attributes
 */
export interface ModelAttributeColumnReferencesOptions {
  /**
   * If this column references another table, provide it here as a Model, or a string
   */
  model?: string | typeof Model;

  /**
   * The column of the foreign table that this column references
   */
  key?: string;

  /**
   * When to check for the foreign key constraing
   *
   * PostgreSQL only
   */
  deferrable?: Deferrable;
}