feat(SchemaBuilder): Add more column types

Included column types are: - datetimeTz - lineString - nullableTimestamps - point - polygon - softDeletes - softDeletesTz - timeTz - timestamps - timestampTz - timestampsTz - withCurrent
coldbox-modules · Oct 4, 2019 · c9c4678 · c9c4678
1 parent 88bfe81
commit c9c4678
Show file tree

Hide file tree

Showing 12 changed files with 468 additions and 10 deletions.
diff --git a/models/Grammars/BaseGrammar.cfc b/models/Grammars/BaseGrammar.cfc
@@ -1189,6 +1189,10 @@ component displayname="Grammar" accessors="true" singleton {
         return "DATETIME";
     }
 
+    function typeDatetimeTz( column ) {
+        return typeDatetime( column );
+    }
+
     function typeDecimal( column ) {
         return "DECIMAL(#column.getLength()#,#column.getPrecision()#)";
     }
@@ -1229,6 +1233,10 @@ component displayname="Grammar" accessors="true" singleton {
         return typeChar( column, 36 );
     }
 
+    function typeLineString( column ) {
+        return "GEOGRAPHY";
+    }
+
     function typeMediumInteger( column ) {
         return arrayToList( arrayFilter( [
             "MEDIUMINT",
@@ -1246,6 +1254,14 @@ component displayname="Grammar" accessors="true" singleton {
         return "TEXT";
     }
 
+    function typePoint( column ) {
+        return "GEOGRAPHY";
+    }
+
+    function typePolygon( column ) {
+        return "GEOGRAPHY";
+    }
+
     function typeSmallInteger( column ) {
         return arrayToList( arrayFilter( [
             "SMALLINT",
@@ -1275,10 +1291,18 @@ component displayname="Grammar" accessors="true" singleton {
         return "TIME";
     }
 
+    function typeTimeTz( column ) {
+        return "TIME";
+    }
+
     function typeTimestamp( column ) {
         return "TIMESTAMP";
     }
 
+    function typeTimestampTz( column ) {
+        return typeTimestamp( column );
+    }
+
     function typeTinyInteger( column ) {
         return arrayToList( arrayFilter( [
             "TINYINT",

diff --git a/models/Grammars/MSSQLGrammar.cfc b/models/Grammars/MSSQLGrammar.cfc
@@ -328,7 +328,11 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
     }
 
     function typeDatetime( column ) {
-        return "DATETIME2";
+        return typeTimestamp( column );
+    }
+
+    function typeDatetimeTz( column ) {
+        return typeTimestampTz( column );
     }
 
     function typeUUID( column ) {
@@ -404,6 +408,10 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
         return "DATETIME2";
     }
 
+    function typeTimestampTz( column ) {
+        return "DATETIMEOFFSET";
+    }
+
     function typeTinyInteger( column ) {
         if ( !isNull( column.getPrecision() ) ) {
             return "NUMERIC(#column.getPrecision()#)";

diff --git a/models/Grammars/MySQLGrammar.cfc b/models/Grammars/MySQLGrammar.cfc
@@ -96,8 +96,12 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
     }
 
     function generateDefault( column ) {
-        if ( column.getDefault() == "" && column.getType() == "TIMESTAMP" ) {
-            column.setDefault( "CURRENT_TIMESTAMP" );
+        if (
+            column.getDefault() == "" &&
+            column.getType().findNoCase( "TIMESTAMP" ) > 0 &&
+            ! column.getNullable()
+        ) {
+            column.withCurrent();
         }
         return super.generateDefault( column );
     }
@@ -118,4 +122,16 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
         return "NCHAR(#column.getLength()#)";
     }
 
+    function typeLineString( column ) {
+        return "LINESTRING";
+    }
+
+    function typePoint( column ) {
+        return "POINT";
+    }
+
+    function typePolygon( column ) {
+        return "POLYGON";
+    }
+
 }
diff --git a/models/Grammars/OracleGrammar.cfc b/models/Grammars/OracleGrammar.cfc
@@ -306,7 +306,11 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
     }
 
     function typeDatetime( column ) {
-        return "DATE";
+        return typeTimestamp( column );
+    }
+
+    function typeDatetimeTz( column ) {
+        return typeTimestampTz( column );
     }
 
     function typeDecimal( column ) {
@@ -335,6 +339,10 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
         return "CLOB";
     }
 
+    function typeLineString( column ) {
+        return "SDO_GEOMETRY";
+    }
+
     function typeLongText( column ) {
         return "CLOB";
     }
@@ -352,6 +360,14 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
         return "CLOB";
     }
 
+    function typePoint( column ) {
+        return "SDO_GEOMETRY";
+    }
+
+    function typePolygon( column ) {
+        return "SDO_GEOMETRY";
+    }
+
     function typeSmallInteger( column ) {
         var precision = isNull( column.getPrecision() ) ? 5 : column.getPrecision();
         return "NUMBER(#precision#, 0)";
@@ -374,13 +390,21 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
     }
 
     function typeTime( column ) {
-        return "DATE";
+        return typeTimestamp( column );
+    }
+
+    function typeTimeTz( column ) {
+        return typeTimestampTz( column );
     }
 
     function typeTimestamp( column ) {
         return "DATE";
     }
 
+    function typeTimestampTz( column ) {
+        return "TIMESTAMP WITH TIME ZONE";
+    }
+
     function typeTinyInteger( column ) {
         var precision = isNull( column.getPrecision() ) ? 3 : column.getPrecision();
         return "NUMBER(#precision#, 0)";

diff --git a/models/Grammars/PostgresGrammar.cfc b/models/Grammars/PostgresGrammar.cfc
@@ -187,7 +187,11 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
     }
 
     function typeDatetime( column ) {
-        return "TIMESTAMP";
+        return typeTimestamp( column );
+    }
+
+    function typeDatetimeTz( column ) {
+        return typeTimestampTz( column );
     }
 
     function typeEnum( column ) {
@@ -226,6 +230,10 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
         return "BIGINT";
     }
 
+    function typeLineString( column ) {
+        return formatPostGisType( "linestring" );
+    }
+
     function typeMediumInteger( column ) {
         if ( column.getAutoIncrement() ) {
             return "SERIAL";
@@ -238,6 +246,14 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
         return "INTEGER";
     }
 
+    function typePoint( column ) {
+        return formatPostGisType( "point" );
+    }
+
+    function typePolygon( column ) {
+        return formatPostGisType( "polygon" );
+    }
+
     function typeSmallInteger( column ) {
         if ( column.getAutoIncrement() ) {
             return "SERIAL";
@@ -258,6 +274,14 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
         return typeText( argumentCollection = arguments );
     }
 
+    function typeTimeTz( column ) {
+        return "TIME WITH TIME ZONE";
+    }
+
+    function typeTimestampTz( column ) {
+        return typeTimestamp( column ) & " WITH TIME ZONE";
+    }
+
     function typeTinyInteger( column ) {
         if ( column.getAutoIncrement() ) {
             return "SERIAL";
@@ -270,6 +294,10 @@ component extends="qb.models.Grammars.BaseGrammar" singleton {
         return "SMALLINT";
     }
 
+    private function formatPostGisType( type ) {
+        return "GEOGRAPHY(#uCase( type )#, 4326)";
+    }
+
     /*===================================
     =            Index Types            =
     ===================================*/

diff --git a/models/Schema/Blueprint.cfc b/models/Schema/Blueprint.cfc
@@ -68,6 +68,11 @@ component accessors="true" {
         return appendColumn( argumentCollection = arguments );
     }
 
+    function datetimeTz( name ) {
+        arguments.type = "datetimeTz";
+        return appendColumn( argumentCollection = arguments );
+    }
+
     function decimal( name, length = 10, precision = 0 ) {
         arguments.type = "decimal";
         return appendColumn( argumentCollection = arguments );
@@ -133,6 +138,11 @@ component accessors="true" {
         return appendColumn( argumentCollection = arguments );
     }
 
+    function lineString( name ) {
+        arguments.type = "lineString";
+        return appendColumn( argumentCollection = arguments );
+    }
+
     function morphs( name ) {
         unsignedInteger( "#name#_id" );
         string( "#name#_type" );
@@ -155,6 +165,22 @@ component accessors="true" {
         return this;
     }
 
+    function nullableTimestamps() {
+        appendColumn( name = "createdDate", type = "timestamp", nullable = true );
+        appendColumn( name = "modifiedDate", type = "timestamp", nullable = true );
+        return this;
+    }
+
+    function point( name ) {
+        arguments.type = "point";
+        return appendColumn( argumentCollection = arguments );
+    }
+
+    function polygon( name ) {
+        arguments.type = "polygon";
+        return appendColumn( argumentCollection = arguments );
+    }
+
     function raw( sql ) {
         var expression = new qb.models.Query.Expression( sql );
         variables.columns.append( expression );
@@ -173,6 +199,16 @@ component accessors="true" {
         return appendColumn( argumentCollection = arguments );
     }
 
+    function softDeletes() {
+        appendColumn( name = "deletedDate", type = "timestamp", nullable = true );
+        return this;
+    }
+
+    function softDeletesTz() {
+        appendColumn( name = "deletedDate", type = "timestampTz", nullable = true );
+        return this;
+    }
+
     function string( name, length ) {
         arguments.type = "string";
         if ( isNull( arguments.length ) ) {
@@ -204,11 +240,33 @@ component accessors="true" {
         return appendColumn( argumentCollection = arguments );
     }
 
+    function timeTz( name ) {
+        arguments.type = "timeTz";
+        return appendColumn( argumentCollection = arguments );
+    }
+
     function timestamp( name ) {
         arguments.type = "timestamp";
         return appendColumn( argumentCollection = arguments );
     }
 
+    function timestamps() {
+        appendColumn( name = "createdDate", type = "timestamp" );
+        appendColumn( name = "modifiedDate", type = "timestamp" );
+        return this;
+    }
+
+    function timestampTz( name ) {
+        arguments.type = "timestampTz";
+        return appendColumn( argumentCollection = arguments );
+    }
+
+    function timestampsTz() {
+        appendColumn( name = "createdDate", type = "timestampTz" );
+        appendColumn( name = "modifiedDate", type = "timestampTz" );
+        return this;
+    }
+
     function tinyIncrements( name, indexName ) {
         arguments.autoIncrement = true;
         arguments.indexName = isNull( indexName ) ? "pk_#getTable()#_#name#" : arguments.indexName;

diff --git a/models/Schema/Column.cfc b/models/Schema/Column.cfc
@@ -162,12 +162,22 @@ component accessors="true" {
         setUnique( true );
         return this;
     }
-    
+
     /**
     * @returns true if the object is a column
     */
     function isColumn() {
         return true;
     }
 
+    /**
+     * Sets the default equal to CURRENT_TIMESTAMP
+     *
+     * @returns Column
+     */
+    function withCurrent() {
+        setDefault( "CURRENT_TIMESTAMP" );
+        return this;
+    }
+
 }