feat: time with timezone

docs/manual/other-topics/other-data-types.md

@@ -189,4 +189,6 @@ DataTypes.MACADDR                     // MACADDR               PostgreSQL only
 DataTypes.GEOMETRY                    // Spatial column. PostgreSQL (with PostGIS) or MySQL only.
 DataTypes.GEOMETRY('POINT')           // Spatial column with geometry type. PostgreSQL (with PostGIS) or MySQL only.
 DataTypes.GEOMETRY('POINT', 4326)     // Spatial column with geometry type and SRID. PostgreSQL (with PostGIS) or MySQL only.
+
+DateTypes.TIME.ZONED                  // TIME WITH TIMEZONE    PostgreSQL only
 ```

src/data-types.d.ts

@@ -324,7 +324,21 @@ export const BOOLEAN: AbstractDataTypeConstructor;
 /**
  * A time column
  */
-export const TIME: AbstractDataTypeConstructor;
+export const TIME: TimeDataTypeConstructor;
+
+interface TimeDataTypeConstructor extends AbstractDataTypeConstructor {
+  ZONED: this;
+  new (options?: TimeDataTypeOptions): TimeDataType;
+  (options?: TimeDataTypeOptions): TimeDataType;
+}
+
+export interface TimeDataType extends AbstractDataType {
+  options: TimeDataTypeOptions;
+}
+
+export interface TimeDataTypeOptions {
+  zoned?: boolean;
+}
 
 /**
  * A datetime column

src/data-types.js

@@ -462,8 +462,34 @@ BOOLEAN.parse = BOOLEAN.prototype._sanitize;
  *
  */
 class TIME extends ABSTRACT {
+  /**
+   * @param {object} options type options
+   * @param {object} [options.zoned] Is zoned?
+   */
+  constructor(options = {}) {
+    super();
+
+    this._zoned = options?.zoned ?? false;
+  }
+
   toSql() {
-    return 'TIME';
+    let result = this.key;
+
+    if (this._zoned) {
+      result += ' WITH TIME ZONE';
+    }
+
+    return result;
+  }
+
+  get ZONED() {
+    this._zoned = true;
+
+    return this;
+  }
+
+  static get ZONED() {
+    return new this().ZONED;
   }
 }
 

src/dialects/db2/data-types.js

@@ -265,6 +265,20 @@ module.exports = BaseTypes => {
     }
   }
 
+  class TIME extends BaseTypes.TIME {
+    constructor() {
+      super();
+
+      if (this._zoned) {
+        warn('DB2 does not support TIME WITH TIMEZONE. Plain `TIME` will be used instead.');
+        this.options.zoned = undefined;
+        this._zoned = undefined;
+      }
+    }
+  }
+
+  delete TIME.parse;
+
   class INTEGER extends BaseTypes.INTEGER {
     constructor(length) {
       super(length);
@@ -368,6 +382,7 @@ module.exports = BaseTypes => {
     UUID,
     DATE,
     DATEONLY,
+    TIME,
     NOW,
     TINYINT,
     SMALLINT,

src/dialects/ibmi/data-types.js

@@ -90,6 +90,20 @@ module.exports = BaseTypes => {
     }
   }
 
+  class TIME extends BaseTypes.TIME {
+    constructor() {
+      super();
+
+      if (this._zoned) {
+        warn('ibmi does not support TIME WITH TIMEZONE. Plain `TIME` will be used instead.');
+        this.options.zoned = undefined;
+        this._zoned = undefined;
+      }
+    }
+  }
+
+  delete TIME.parse;
+
   class BOOLEAN extends BaseTypes.BOOLEAN {
     toSql() {
       return 'SMALLINT';
@@ -309,6 +323,7 @@ module.exports = BaseTypes => {
     BOOLEAN,
     DATE,
     DATEONLY,
+    TIME,
     STRING,
     CHAR,
     NUMBER,

src/dialects/mariadb/data-types.js

@@ -6,6 +6,7 @@ const momentTz = require('moment-timezone');
 const moment = require('moment');
 
 module.exports = BaseTypes => {
+  const warn = BaseTypes.ABSTRACT.warn.bind(undefined, 'https://mariadb.com/kb/en/data-types/');
   BaseTypes.ABSTRACT.prototype.dialectTypes = 'https://mariadb.com/kb/en/library/resultset/#field-types';
 
   /**
@@ -87,6 +88,20 @@ module.exports = BaseTypes => {
     }
   }
 
+  class TIME extends BaseTypes.TIME {
+    constructor() {
+      super();
+
+      if (this._zoned) {
+        warn('MariaDB does not support TIME WITH TIMEZONE. Plain `TIME` will be used instead.');
+        this.options.zoned = undefined;
+        this._zoned = undefined;
+      }
+    }
+  }
+
+  delete TIME.parse;
+
   class UUID extends BaseTypes.UUID {
     toSql() {
       return 'CHAR(36) BINARY';
@@ -139,6 +154,7 @@ module.exports = BaseTypes => {
     ENUM,
     DATE,
     DATEONLY,
+    TIME,
     UUID,
     GEOMETRY,
     DECIMAL,

src/dialects/mssql/data-types.js

@@ -142,6 +142,20 @@ module.exports = BaseTypes => {
     }
   }
 
+  class TIME extends BaseTypes.TIME {
+    constructor() {
+      super();
+
+      if (this._zoned) {
+        warn('MSSQL does not support TIME WITH TIMEZONE. Plain `TIME` will be used instead.');
+        this.options.zoned = undefined;
+        this._zoned = undefined;
+      }
+    }
+  }
+
+  delete TIME.parse;
+
   class INTEGER extends BaseTypes.INTEGER {
     constructor(length) {
       super(length);
@@ -223,6 +237,7 @@ module.exports = BaseTypes => {
     UUID,
     DATE,
     DATEONLY,
+    TIME,
     NOW,
     TINYINT,
     SMALLINT,

src/dialects/mysql/data-types.js

@@ -6,6 +6,7 @@ const momentTz = require('moment-timezone');
 const moment = require('moment');
 
 module.exports = BaseTypes => {
+  const warn = BaseTypes.ABSTRACT.warn.bind(undefined, 'https://dev.mysql.com/doc/refman/8.0/en/data-types.html');
   BaseTypes.ABSTRACT.prototype.dialectTypes = 'https://dev.mysql.com/doc/refman/5.7/en/data-types.html';
 
   /**
@@ -92,6 +93,20 @@ module.exports = BaseTypes => {
     }
   }
 
+  class TIME extends BaseTypes.TIME {
+    constructor() {
+      super();
+
+      if (this._zoned) {
+        warn('MySQL does not support TIME WITH TIMEZONE. Plain `TIME` will be used instead.');
+        this.options.zoned = undefined;
+        this._zoned = undefined;
+      }
+    }
+  }
+
+  delete TIME.parse;
+
   class UUID extends BaseTypes.UUID {
     toSql() {
       return 'CHAR(36) BINARY';
@@ -153,6 +168,7 @@ module.exports = BaseTypes => {
     ENUM,
     DATE,
     DATEONLY,
+    TIME,
     UUID,
     GEOMETRY,
     DECIMAL,

src/dialects/snowflake/data-types.js

@@ -4,6 +4,7 @@ const momentTz = require('moment-timezone');
 const moment = require('moment');
 
 module.exports = BaseTypes => {
+  const warn = BaseTypes.ABSTRACT.warn.bind(undefined, 'https://docs.snowflake.com/en/sql-reference/data-types.html');
   BaseTypes.ABSTRACT.prototype.dialectTypes = 'https://dev.snowflake.com/doc/refman/5.7/en/data-types.html';
 
   /**
@@ -76,6 +77,20 @@ module.exports = BaseTypes => {
     }
   }
 
+  class TIME extends BaseTypes.TIME {
+    constructor() {
+      super();
+
+      if (this._zoned) {
+        warn('Snowflake does not support TIME WITH TIMEZONE. Plain `TIME` will be used instead.');
+        this.options.zoned = undefined;
+        this._zoned = undefined;
+      }
+    }
+  }
+
+  delete TIME.parse;
+
   class UUID extends BaseTypes.UUID {
     toSql() {
       // https://community.snowflake.com/s/question/0D50Z00009LH2fl/what-is-the-best-way-to-store-uuids
@@ -106,6 +121,7 @@ module.exports = BaseTypes => {
     DATE,
     BOOLEAN,
     DATEONLY,
+    TIME,
     UUID,
     JSON: JSONTYPE,
   };

src/dialects/sqlite/data-types.js

@@ -66,6 +66,20 @@ module.exports = BaseTypes => {
     }
   }
 
+  class TIME extends BaseTypes.TIME {
+    constructor() {
+      super();
+
+      if (this._zoned) {
+        warn('SQLite does not support TIME WITH TIMEZONE. Plain `TIME` will be used instead.');
+        this.options.zoned = undefined;
+        this._zoned = undefined;
+      }
+    }
+  }
+
+  delete TIME.parse;
+
   class STRING extends BaseTypes.STRING {
     toSql() {
       if (this._binary) {
@@ -203,6 +217,7 @@ module.exports = BaseTypes => {
   return {
     DATE,
     DATEONLY,
+    TIME,
     STRING,
     CHAR,
     NUMBER,

test/types/data-types.ts

@@ -1,7 +1,13 @@
 import { expectTypeOf } from 'expect-type';
 import { DataTypes } from '@sequelize/core';
 
-const { TINYINT, SMALLINT, MEDIUMINT, BIGINT, INTEGER, JSON, JSONB, CITEXT, MACADDR, TSVECTOR, CIDR, INET } = DataTypes;
+const { TIME, TINYINT, SMALLINT, MEDIUMINT, BIGINT, INTEGER, JSON, JSONB, CITEXT, MACADDR, TSVECTOR, CIDR, INET } = DataTypes;
+
+// TIME
+expectTypeOf(TIME()).toEqualTypeOf<DataTypes.TimeDataType>();
+expectTypeOf(new TIME()).toEqualTypeOf<DataTypes.TimeDataType>();
+expectTypeOf(TIME.ZONED()).toEqualTypeOf<DataTypes.TimeDataType>();
+expectTypeOf(new TIME.ZONED()).toEqualTypeOf<DataTypes.TimeDataType>();
 
 // TINYINT
 expectTypeOf(TINYINT()).toEqualTypeOf<DataTypes.TinyIntegerDataType>();

test/unit/sql/data-types.test.js

@@ -233,6 +233,41 @@ describe(Support.getTestDialectTeaser('SQL'), () => {
       });
     });
 
+    describe('TIME', () => {
+      testsql('TIME', DataTypes.TIME, {
+        ibmi: 'TIME',
+        postgres: 'TIME',
+        mssql: 'TIME',
+        mariadb: 'TIME',
+        mysql: 'TIME',
+        db2: 'TIME',
+        sqlite: 'TIME',
+        snowflake: 'TIME',
+      });
+
+      testsql('TIME.ZONED', DataTypes.TIME({ zoned: true }), {
+        ibmi: 'TIME',
+        postgres: 'TIME WITH TIME ZONE',
+        mssql: 'TIME',
+        mariadb: 'TIME',
+        mysql: 'TIME',
+        db2: 'TIME',
+        sqlite: 'TIME',
+        snowflake: 'TIME',
+      });
+
+      testsql('TIME.ZONED', DataTypes.TIME.ZONED, {
+        ibmi: 'TIME',
+        postgres: 'TIME WITH TIME ZONE',
+        mssql: 'TIME',
+        mariadb: 'TIME',
+        mysql: 'TIME',
+        db2: 'TIME',
+        sqlite: 'TIME',
+        snowflake: 'TIME',
+      });
+    });
+
     if (current.dialect.supports.HSTORE) {
       describe('HSTORE', () => {
         describe('validate', () => {