Support for Laravel 9

Author: peterfox

.github/workflows/run-tests.yml

@@ -2,23 +2,25 @@ name: run-tests
 
 on:
   push:
-    branches: [main]
   pull_request:
-    branches: [main]
+    branches: [ main ]
 
 jobs:
   test:
     runs-on: ${{ matrix.os }}
 
     strategy:
+      fail-fast: false
       matrix:
-        os: [ubuntu-latest]
-        php: [8.0, 8.1]
-        laravel: [8.*]
-        stability: [prefer-stable, prefer-lowest]
+        os: [ ubuntu-latest ]
+        php: [ 8.0, 8.1 ]
+        laravel: [ 9.*, 8.* ]
+        stability: [ prefer-stable, prefer-lowest ]
         include:
+          - laravel: 9.*
+            testbench: ^7.0
           - laravel: 8.*
-            testbench: ^6.23
+            testbench: ^6.24
 
     name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 
@@ -44,8 +46,8 @@ jobs:
 
       - name: Install dependencies
         run: |
-          composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
-          composer update --${{ matrix.stability }} --prefer-dist --no-interaction
+            composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
+            composer update --${{ matrix.stability }} --prefer-dist --no-interaction
 
       - name: Configure Database
         run: |

README.md

@@ -5,8 +5,22 @@
 [![GitHub Code Style Action Status](https://img.shields.io/github/workflow/status/ylsideas/cockroachdb-laravel/Check%20&%20fix%20styling?label=code%20style)](https://github.com/ylsideas/cockroachdb-laravel/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/ylsideas/cockroachdb-laravel.svg?style=flat-square)](https://packagist.org/packages/ylsideas/cockroachdb-laravel)
 
-A driver/grammar for Laravel that works with CockroachDB. This is currently an alpha.
-All tests pass, but you may run into bugs potentially going forward.
+A driver/grammar for Laravel that works with CockroachDB. While CockroachDB is compatible with Postgresql, this support
+is not 1 to 1 meaning you may run into issues, this driver hopes to resolve those problems as much as possible.
+
+Laravel 8 and 9 are both supported and tested against CockroachDB 2.5.
+
+## Support
+
+Peter Fox here, I just want to say this project has been my hardest yet. It's been a real labour of love to make and takes
+up a lot of time trying to organise the test suite so that compatibility is maintained between Eloquent and CockroachDB.
+
+I see a lot of promise in using CockroachDB's serverless offering which is what compelled me to go down this route originally.
+You can read [an article](https://medium.com/@SlyFireFox/laravel-tip-cockroachdbs-serverless-database-322aa7f5f7ef) 
+I made about using their service.
+
+If you're using this project at all then do please consider [sponsoring me](https://github.com/sponsors/peterfox) 
+as a way of encouraging more development.
 
 ## Installation
 
@@ -40,9 +54,23 @@ To enable set `DB_CONNECTION=crdb` in your .env.
 
 ## Notes
 
+CockroachDB should work inline with the feature set of Postgresql, with some exceptions. You can look at the
+features of each CockroachDB server in the CockroachDB [Docs](https://www.cockroachlabs.com/docs/stable/sql-feature-support.html#indexes).
+
+### Deletes with Joins
 CockroachDB does not support performing deletes using joins. If you wish to
 do something like this you will need to use a sub-query instead.
 
+At current if you try to call the `delete` method of the Query builder together with a `join` then
+a `YlsIdeas\CockroachDb\Exceptions\FeatureNotSupportedException` exception will be thrown.
+
+### Fulltext Search
+Eloquent and Postgresql support Fulltext search. CockroachDB does not support any full text
+search meaning the feature cannot be used when using this driver.
+
+At current if you try to create a Fulltext index using the Schema builder or try to use the `whereFulltext`
+method of the Query builder a `YlsIdeas\CockroachDb\Exceptions\FeatureNotSupportedException` exception will be thrown.
+
 ## Testing
 
 The tests try to closely follow the same functionality of the grammar provided by Laravel

composer.json

@@ -18,13 +18,13 @@
     "require": {
         "php": "^8.0",
         "spatie/laravel-package-tools": "^1.9.2",
-        "illuminate/contracts": "8.*"
+        "illuminate/contracts": "9.*|8.*"
     },
     "require-dev": {
         "doctrine/dbal": "^3.2",
-        "nunomaduro/collision": "^5.10",
+        "nunomaduro/collision": "^6.0|^5.10",
         "nunomaduro/larastan": "^1.0",
-        "orchestra/testbench": "^6.22",
+        "orchestra/testbench": "^7.0|^6.24",
         "pestphp/pest": "^1.21",
         "pestphp/pest-plugin-laravel": "^1.1",
         "phpstan/extension-installer": "^1.1",
@@ -35,8 +35,7 @@
     },
     "autoload": {
         "psr-4": {
-            "YlsIdeas\\CockroachDb\\": "src",
-            "YlsIdeas\\CockroachDb\\Database\\Factories\\": "database/factories"
+            "YlsIdeas\\CockroachDb\\": "src"
         }
     },
     "autoload-dev": {
@@ -50,7 +49,11 @@
         "test-coverage": "vendor/bin/pest coverage"
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "phpstan/extension-installer": true,
+            "pestphp/pest-plugin": true
+        }
     },
     "extra": {
         "laravel": {

database.php

@@ -20,6 +20,17 @@
 CREATE DATABASE IF NOT EXISTS forge;
 CREATE USER IF NOT EXISTS forge;
 GRANT ALL ON DATABASE forge TO forge;
+
+SET CLUSTER SETTING kv.raft_log.disable_synchronization_unsafe = true;
+SET CLUSTER SETTING kv.range_merge.queue_interval = '50ms';
+SET CLUSTER SETTING jobs.registry.interval.gc = '30s';
+SET CLUSTER SETTING jobs.registry.interval.cancel = '180s';
+SET CLUSTER SETTING jobs.retention_time = '15s';
+SET CLUSTER SETTING schemachanger.backfiller.buffer_increment = '128 KiB';
+SET CLUSTER SETTING sql.stats.automatic_collection.enabled = false;
+SET CLUSTER SETTING kv.range_split.by_load_merge_delay = '5s';
+ALTER RANGE default CONFIGURE ZONE USING "gc.ttlseconds" = 5;
+ALTER DATABASE system CONFIGURE ZONE USING "gc.ttlseconds" = 5;
 heredoc);
 } catch (PDOException $exception) {
     exit('Failed to creating database: ' . $exception->getMessage() . PHP_EOL);

database/factories/ModelFactory.php

@@ -1,13 +1,21 @@
 version: '3'
 services:
   crdb:
-    image: cockroachdb/cockroach:v21.2.2
+    image: cockroachdb/cockroach:v21.2.5
     ports:
       - "26257:26257"
       - "8080:8080"
-    command: start-single-node --cluster-name=example-single-node --logtostderr=WARNING --log-file-verbosity=WARNING --insecure
-    volumes:
-      - crdb-volume:/cockroach/cockroach-data
+    command: start-single-node --insecure --store=type=mem,size=0.9 --advertise-addr=localhost
+#    volumes:
+#      - crdb-volume:/cockroach/cockroach-data
+    deploy:
+      resources:
+        limits:
+          cpus: '2'
+          memory: 2G
+        reservations:
+          cpus: '0.25'
+          memory: 500M
 
-volumes:
-  crdb-volume:
+#volumes:
+#  crdb-volume:

database/migrations/create_cockroachdb-laravel_table.php.stub

@@ -5,8 +5,6 @@ parameters:
     level: 4
     paths:
         - src
-        - config
-        - database
     tmpDir: build/phpstan
     checkOctaneCompatibility: true
     checkModelProperties: true

docker-compose.yml

@@ -0,0 +1,7 @@
+<?php
+
+namespace YlsIdeas\CockroachDb\Exceptions;
+
+class FeatureNotSupportedException extends \LogicException
+{
+}

phpstan.neon.dist

@@ -5,6 +5,7 @@
 use Illuminate\Database\Query\Builder;
 use Illuminate\Database\Query\Grammars\Grammar;
 use Illuminate\Database\Query\Grammars\PostgresGrammar;
+use YlsIdeas\CockroachDb\Exceptions\FeatureNotSupportedException;
 
 class CockroachGrammar extends PostgresGrammar
 {
@@ -46,7 +47,7 @@ public function compileDelete(Builder $query)
         $where = $this->compileWheres($query);
 
         if (! empty($query->joins)) {
-            throw new \LogicException(
+            throw new FeatureNotSupportedException(
                 'Joins for deletions are not supported by CockroachDB, consider using a where in sub-query instead.'
             );
         }
@@ -61,4 +62,16 @@ public function compileDelete(Builder $query)
 
         return trim($statement);
     }
+
+    /**
+     * Compile a "where fulltext" clause.
+     *
+     * @param  \Illuminate\Database\Query\Builder  $query
+     * @param  array  $where
+     * @return string
+     */
+    public function whereFullText(Builder $query, $where)
+    {
+        throw new FeatureNotSupportedException('Fulltext indexes are not supported by CockroachDB as of version 2.5');
+    }
 }

resources/views/.gitkeep

@@ -2,8 +2,36 @@
 
 namespace YlsIdeas\CockroachDb\Schema;
 
+use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Schema\Grammars\PostgresGrammar;
+use Illuminate\Support\Fluent;
+use YlsIdeas\CockroachDb\Exceptions\FeatureNotSupportedException;
 
 class CockroachGrammar extends PostgresGrammar
 {
+    /**
+     * Compile a fulltext index key command.
+     *
+     * @param  \Illuminate\Database\Schema\Blueprint  $blueprint
+     * @param  \Illuminate\Support\Fluent  $command
+     * @return string
+     *
+     * @throws \RuntimeException
+     */
+    public function compileFulltext(Blueprint $blueprint, Fluent $command)
+    {
+        throw new FeatureNotSupportedException('Fulltext indexes are not supported by CockroachDB as of version 2.5');
+    }
+
+    /**
+     * Compile a drop fulltext index command.
+     *
+     * @param  \Illuminate\Database\Schema\Blueprint  $blueprint
+     * @param  \Illuminate\Support\Fluent  $command
+     * @return string
+     */
+    public function compileDropFullText(Blueprint $blueprint, Fluent $command)
+    {
+        return $this->compileDropIndex($blueprint, $command);
+    }
 }