feat: Checks Constraints Support for CockroachDB

lib/dialects/cockroachdb/crdb-tablecompiler.js

@@ -7,6 +7,68 @@ class TableCompiler_CRDB extends TableCompiler {
     super(client, tableBuilder);
   }
 
+  addColumns(columns, prefix, colCompilers) {
+    if (prefix === this.alterColumnsPrefix) {
+      // alter columns
+      for (const col of colCompilers) {
+        const quotedTableName = this.tableName();
+        const type = col.getColumnType();
+        // We'd prefer to call this.formatter.wrapAsIdentifier here instead, however the context passed to
+        // `this` instance is not that of the column, but of the table. Thus, we unfortunately have to call
+        // `wrapIdentifier` here as well (it is already called once on the initial column operation) to give
+        // our `alter` operation the correct `queryContext`. Refer to issue #2606 and PR #2612.
+        const colName = this.client.wrapIdentifier(
+          col.getColumnName(),
+          col.columnBuilder.queryContext()
+        );
+
+        // To alter enum columns they must be cast to text first
+        const isEnum = col.type === 'enu';
+        this.client.logger.warn(
+          'Experimental alter column in use, see issue: https://github.com/cockroachdb/cockroach/issues/49329'
+        );
+        this.pushQuery({
+          sql: 'SET enable_experimental_alter_column_type_general = true',
+          bindings: [],
+        });
+        this.pushQuery({
+          sql: `alter table ${quotedTableName} alter column ${colName} drop default`,
+          bindings: [],
+        });
+        this.pushQuery({
+          sql: `alter table ${quotedTableName} alter column ${colName} drop not null`,
+          bindings: [],
+        });
+        this.pushQuery({
+          sql: `alter table ${quotedTableName} alter column ${colName} type ${type} using (${colName}${
+            isEnum ? '::text::' : '::'
+          }${type})`,
+          bindings: [],
+        });
+
+        const defaultTo = col.modified['defaultTo'];
+        if (defaultTo) {
+          const modifier = col.defaultTo.apply(col, defaultTo);
+          this.pushQuery({
+            sql: `alter table ${quotedTableName} alter column ${colName} set ${modifier}`,
+            bindings: [],
+          });
+        }
+
+        const nullable = col.modified['nullable'];
+        if (nullable && nullable[0] === false) {
+          this.pushQuery({
+            sql: `alter table ${quotedTableName} alter column ${colName} set not null`,
+            bindings: [],
+          });
+        }
+      }
+    } else {
+      // base class implementation for normal add
+      super.addColumns(columns, prefix);
+    }
+  }
+
   dropUnique(columns, indexName) {
     indexName = indexName
       ? this.formatter.wrap(indexName)

scripts/docker-compose.yml

@@ -85,7 +85,7 @@ services:
       - 'until /usr/local/bin/psql postgres://testuser:knextest@postgres/knex_test -c "SELECT 1"; do sleep 5; done'
 
   cockroachdb:
-    image: cockroachdb/cockroach:latest-v21.1
+    image: cockroachdb/cockroach:latest-v21.2
     container_name: crdb
     hostname: crdb
     command: start-single-node --cluster-name=example-single-node --insecure

test/integration2/schema/checks.spec.js

@@ -403,7 +403,6 @@ describe.only('Checks', () => {
           table.integer('price');
         });
         expect(await knex('check_test').insert([{ price: -5 }])).to.not.throw;
-
         // Alter table with check constraint fail, we have row that violated the constraint
         let error;
         try {
@@ -417,21 +416,27 @@ describe.only('Checks', () => {
 
         // empty the table to add the constraint
         await knex('check_test').truncate();
-
         await knex.schema
           .table('check_test', (table) => {
             table.integer('price').checkPositive().alter();
           })
           .testSql((tester) => {
             tester(
-              ['pg', 'pg-redshift', 'cockroachdb'],
+              ['pg', 'pg-redshift'],
               [
                 'alter table "check_test" alter column "price" drop default',
                 'alter table "check_test" alter column "price" drop not null',
                 'alter table "check_test" alter column "price" type integer using ("price"::integer)',
                 'alter table "check_test" add constraint check_test_price_1 check("price" > 0)',
               ]
             );
+            tester('cockroachdb', [
+              'SET enable_experimental_alter_column_type_general = true',
+              'alter table "check_test" alter column "price" drop default',
+              'alter table "check_test" alter column "price" drop not null',
+              'alter table "check_test" alter column "price" type integer using ("price"::integer)',
+              'alter table "check_test" add constraint check_test_price_1 check("price" > 0)',
+            ]);
             tester('oracledb', [
               'alter table "check_test" modify "price" integer',
               'alter table "check_test" add constraint check_test_price_1 check("price" > 0)',