Merge pull request #2 from srdante/main

Rebase from main

Author: miguilimzero

.devcontainer/Dockerfile

@@ -8,6 +8,12 @@ FROM mcr.microsoft.com/vscode/devcontainers/php:0-${VARIANT}
 ARG NODE_VERSION="none"
 RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
 
+ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/
+RUN chmod +x /usr/local/bin/install-php-extensions && \
+    install-php-extensions gd xdebug
+
+RUN install-php-extensions pdo_mysql
+
 # [Optional] Uncomment this section to install additional OS packages.
 # RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
 #     && apt-get -y install --no-install-recommends <your-package-list-here>

.github/workflows/tests.yml

@@ -6,10 +6,10 @@ on:
       - main
 
   pull_request:
-    types: [ opened, synchronize, reopened ]
+    types: [opened, synchronize, reopened]
 
   schedule:
-    - cron: '0 0 * * *'
+    - cron: "0 0 * * *"
 
 jobs:
   test:
@@ -18,9 +18,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: [ 7.3, 7.4, 8.0, 8.1 ]
-        laravel: [ 8.*, 9.* ]
-        dependency-version: [ prefer-lowest, prefer-stable ]
+        php: [7.3, 7.4, 8.0, 8.1]
+        laravel: [8.*, 9.*]
+        dependency-version: [prefer-lowest, prefer-stable]
         include:
           - laravel: 8.*
             testbench: 6.*
@@ -45,14 +45,15 @@ jobs:
 
     services:
       singlestore:
-        # check for new versions at https://hub.docker.com/r/singlestore/cluster-in-a-box/tags
-        image: singlestore/cluster-in-a-box:alma-7.8.6-4f052c9b50-4.0.7-1.13.8
+        # check for new versions at https://github.com/singlestore-labs/singlestoredb-dev-image/pkgs/container/singlestoredb-dev/versions
+        image: ghcr.io/singlestore-labs/singlestoredb-dev:0.0.8
         ports:
           - "3306:3306"
         env:
-          LICENSE_KEY: ${{ secrets.SINGLESTORE_LICENSE }}
+          # this license key is only authorized for use in SingleStore laravel tests and is heavily restricted
+          # if you want a free SingleStore license for your own use please visit https://www.singlestore.com/cloud-trial/
+          SINGLESTORE_LICENSE: BGIxODZiYTg1YWUxYjRlODRhYzRjMGFmYTA1OTkxYzgyAAAAAAAAAAABAAAAAAAAACgwNQIZANx4NIXJ7CWvKYYb3wIyRXxBY7fdAnLeSwIYLy2Q0jA124GAkl04yuGrD59Zpv85DVYXAA==
           ROOT_PASSWORD: "test"
-          START_AFTER_INIT: "Y"
 
     steps:
       - name: Checkout code
@@ -80,24 +81,12 @@ jobs:
       - name: Execute Unit Tests
         run: vendor/bin/phpunit
 
-      - name: Wait for SingleStore to start
-        run: |
-          attempts=0
-          until mysql -h 127.0.0.1 -u root -ptest -e "select 1"; do
-            echo "waiting for mysql..."
-            ((attempts=attempts+1))
-            if [[ $attempts -gt 5 ]]; then
-              docker logs $(docker ps -ql)
-            fi
-            sleep 1
-          done
-
       - name: SingleStore Container Logs
         run: docker logs $(docker ps -ql)
 
       - name: Create Test Database
         run: |
-          mysql -h 127.0.0.1 -u root -ptest -e "create database test"        
+          mysql -h 127.0.0.1 -u root -ptest -e "create database test"
 
       - name: Execute Integration Tests
         run: vendor/bin/phpunit

README.md

@@ -1,7 +1,31 @@
-# SingleStore Driver for Laravel
+# SingleStore Driver for Laravel <!-- omit in toc -->
+
+[![Latest Stable Version](http://poser.pugx.org/singlestoredb/singlestoredb-laravel/v)](https://packagist.org/packages/singlestoredb/singlestoredb-laravel) [![Total Downloads](http://poser.pugx.org/singlestoredb/singlestoredb-laravel/downloads)](https://packagist.org/packages/singlestoredb/singlestoredb-laravel) [![License](http://poser.pugx.org/singlestoredb/singlestoredb-laravel/license)](https://packagist.org/packages/singlestoredb/singlestoredb-laravel) [![PHP Version Require](http://poser.pugx.org/singlestoredb/singlestoredb-laravel/require/php)](https://packagist.org/packages/singlestoredb/singlestoredb-laravel) [![Github Actions status image](https://github.com/singlestore-labs/singlestoredb-laravel-driver/actions/workflows/tests.yml/badge.svg)](https://github.com/singlestore-labs/singlestoredb-laravel-driver/actions)
 
 This repository contains a SingleStore Driver for Laravel.
 
+This package is currently in a pre-release beta, please use with caution and open any issues that you run into.
+
+- [Install](#install)
+- [Usage](#usage)
+- [Issues connecting to SingleStore Managed Service](#issues-connecting-to-singlestore-managed-service)
+- [PHP Versions before 8.1](#php-versions-before-81)
+- [Migrations](#migrations)
+  - [Rowstore Tables](#rowstore-tables)
+  - [Reference Tables](#reference-tables)
+  - [Global Temporary Tables](#global-temporary-tables)
+  - [Sparse Columns](#sparse-columns)
+  - [Sparse Tables](#sparse-tables)
+  - [Shard Keys](#shard-keys)
+  - [Sort Keys](#sort-keys)
+  - [Unique Keys](#unique-keys)
+  - [Series Timestamps](#series-timestamps)
+  - [Computed Columns](#computed-columns)
+- [Testing](#testing)
+- [License](#license)
+- [Resources](#resources)
+- [User agreement](#user-agreement)
+
 ## Install
 
 You can install the package via composer:
@@ -10,6 +34,8 @@ You can install the package via composer:
 composer require singlestoredb/singlestoredb-laravel
 ```
 
+**This package requires pdo_mysql** to be installed. If you aren't sure check to see if `pdo_mysql` is listed when you run `php -i`.
+
 ## Usage
 
 To enable the driver, head to your `config/database.php` file and create a new entry for SingleStore in your `connections`, and update your `default` to point to that new connection:
@@ -55,6 +81,20 @@ In case you want to store failed jobs in SingleStore, then make sure you also se
 ],
 ```
 
+## Issues connecting to SingleStore Managed Service
+
+If you are encountering issues connecting to the SingleStore Managed Service, it may be due to your environment not being able to verify the SSL certificate used to secure connections. You can fix this by downloading and manually specifying the SingleStore certificate file.
+
+* [Download the file here](https://portal.singlestore.com/static/ca/singlestore_bundle.pem)
+* In the Laravel SingleStore connection configuration, point the variable `PDO::MYSQL_ATTR_SSL_CA` at `singlestore_bundle.pem`:
+
+```php
+'options' => extension_loaded('pdo_mysql') ? array_filter([
+    PDO::MYSQL_ATTR_SSL_CA => 'path/to/singlestore_bundle.pem',
+    PDO::ATTR_EMULATE_PREPARES => true,
+]) : [],
+```
+
 ## PHP Versions before 8.1
 
 In PHP versions before 8.1, the flag `PDO::ATTR_EMULATE_PREPARES` results in a bug by which all attributes returned by MySQL (and
@@ -192,7 +232,42 @@ Schema::create('table', function (Blueprint $table) {
 
     $table->sortKey(['f_name', 'l_name']);
 });
+```
+
+Sort keys by default works only for `asc` sort queries. If you would like to create a sort key with `desc` order, you can set the key direction.
+
+```php
+Schema::create('table', function (Blueprint $table) {
+    $table->string('name');
+
+    $table->sortKey('name', 'desc');
+});
+
+Schema::create('table', function (Blueprint $table) {
+    $table->string('name')->sortKey('desc');
+});
+```
+
+### Unique Keys
+
+You can add an `unique key` to your tables using the standalone `unique` method, or fluently by appending `unique` to the column definition.
+
+> **Note**
+> SingleStore requires that the shard key is contained within an unique key. This means that in most cases you can't use the fluent api as you will likely need to specify more than one column. This restriction does not apply to reference tables.
+
+```php
+Schema::create('table', function (Blueprint $table) {
+    $table->string('key');
+    $table->string('val');
+
+    $table->shardKey('key');
+    $table->unique(['key', 'val']);
+});
 
+Schema::create('table', function (Blueprint $table) {
+    $table->reference();
+    $table->string('name')->unique();
+});
 ```
 
 ### Series Timestamps

src/Schema/Blueprint/InlinesIndexes.php

@@ -81,7 +81,8 @@ protected function inlineCreateIndexStatements($statements)
     protected function indexCommands()
     {
         return $this->commandsNamed(array_merge(
-            $this->singleStoreIndexes, $this->mysqlIndexes
+            $this->singleStoreIndexes,
+            $this->mysqlIndexes
         ));
     }
 
@@ -116,7 +117,12 @@ protected function addFluentSingleStoreIndexes()
         foreach ($this->columns as $column) {
             foreach ($this->singleStoreIndexes as $index) {
                 if (isset($column->{$index})) {
-                    $this->{$index}($column->name, ($column->{$index} === true ? null : $column->{$index}));
+                    if ($column->{$index} === true) {
+                        $this->{$index}($column->name);
+                    } else {
+                        $this->{$index}($column->name, $column->{$index});
+                    }
+
                     $column->{$index} = false;
                 }
             }

src/Schema/Blueprint/ModifiesIndexes.php

@@ -11,22 +11,24 @@ trait ModifiesIndexes
 {
     /**
      * @param $columns
-     * @param $name
      * @return \Illuminate\Support\Fluent
      */
-    public function shardKey($columns, $name = null)
+    public function shardKey($columns)
     {
-        return $this->indexCommand('shardKey', $columns, $name);
+        return $this->indexCommand('shardKey', $columns, null);
     }
 
     /**
      * @param $columns
-     * @param $name
+     * @param $direction
      * @return \Illuminate\Support\Fluent
      */
-    public function sortKey($columns, $name = null)
+    public function sortKey($columns, $direction = 'asc')
     {
-        return $this->indexCommand('sortKey', $columns, $name);
+        $command = $this->indexCommand('sortKey', $columns, null);
+        $command->direction = $direction;
+
+        return $command;
     }
 
     /**

src/Schema/Grammar/CompilesKeys.php

@@ -17,7 +17,7 @@ public function compileShardKey(Blueprint $blueprint, Fluent $command)
 
     public function compileSortKey(Blueprint $blueprint, Fluent $command)
     {
-        return "sort key({$this->columnize($command->columns)})";
+        return "sort key({$this->columnize($command->columns)} {$command->direction})";
     }
 
     public function compileSpatialIndex(Blueprint $blueprint, Fluent $command)

tests/BaseTest.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * @author Aaron Francis <aaron@hammerstone.dev|https://twitter.com/aarondfrancis>
  */

tests/Hybrid/CreateTable/SortKeysTest.php

@@ -23,7 +23,21 @@ public function it_adds_a_sort_key_standalone()
 
         $this->assertCreateStatement(
             $blueprint,
-            'create table `test` (`name` varchar(255) not null, sort key(`name`))'
+            'create table `test` (`name` varchar(255) not null, sort key(`name` asc))'
+        );
+    }
+
+    /** @test */
+    public function it_adds_a_sort_key_with_desc_direction_standalone()
+    {
+        $blueprint = $this->createTable(function (Blueprint $table) {
+            $table->string('name');
+            $table->sortKey('name', 'desc');
+        });
+
+        $this->assertCreateStatement(
+            $blueprint,
+            'create table `test` (`name` varchar(255) not null, sort key(`name` desc))'
         );
     }
 
@@ -36,7 +50,20 @@ public function it_adds_a_sort_key_fluent()
 
         $this->assertCreateStatement(
             $blueprint,
-            'create table `test` (`name` varchar(255) not null, sort key(`name`))'
+            'create table `test` (`name` varchar(255) not null, sort key(`name` asc))'
+        );
+    }
+
+    /** @test */
+    public function it_adds_a_sort_key_with_desc_direction_fluent()
+    {
+        $blueprint = $this->createTable(function (Blueprint $table) {
+            $table->string('name')->sortKey('desc');
+        });
+
+        $this->assertCreateStatement(
+            $blueprint,
+            'create table `test` (`name` varchar(255) not null, sort key(`name` desc))'
         );
     }
 
@@ -51,7 +78,7 @@ public function it_adds_a_dual_sort_key()
 
         $this->assertCreateStatement(
             $blueprint,
-            'create table `test` (`f_name` varchar(255) not null, `l_name` varchar(255) not null, sort key(`f_name`, `l_name`))'
+            'create table `test` (`f_name` varchar(255) not null, `l_name` varchar(255) not null, sort key(`f_name`, `l_name` asc))'
         );
     }
 
@@ -64,7 +91,7 @@ public function shard_and_sort_keys()
 
         $this->assertCreateStatement(
             $blueprint,
-            'create table `test` (`name` varchar(255) not null, shard key(`name`), sort key(`name`))'
+            'create table `test` (`name` varchar(255) not null, shard key(`name`), sort key(`name` asc))'
         );
     }
 }

tests/Hybrid/CreateTable/UniqueKeysTest.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * @author Aaron Francis <aarondfrancis@gmail.com|https://twitter.com/aarondfrancis>
+ */
+
+namespace SingleStore\Laravel\Tests\Hybrid\CreateTable;
+
+use SingleStore\Laravel\Schema\Blueprint;
+use SingleStore\Laravel\Tests\BaseTest;
+use SingleStore\Laravel\Tests\Hybrid\HybridTestHelpers;
+
+class UniqueKeysTest extends BaseTest
+{
+    use HybridTestHelpers;
+
+    /** @test */
+    public function it_adds_a_unique_key()
+    {
+        $blueprint = $this->createTable(function (Blueprint $table) {
+            $table->string('key');
+            $table->string('val');
+
+            $table->shardKey('key');
+            $table->unique(['key', 'val']);
+        });
+
+        $this->assertCreateStatement(
+            $blueprint,
+            'create table `test` (`key` varchar(255) not null, `val` varchar(255) not null, shard key(`key`), unique `test_key_val_unique`(`key`, `val`))'
+        );
+    }
+
+    /** @test */
+    public function it_adds_a_unique_key_reference_fluent()
+    {
+        $blueprint = $this->createTable(function (Blueprint $table) {
+            $table->reference();
+            $table->string('name')->unique();
+        });
+
+        $this->assertCreateStatement(
+            $blueprint,
+            'create reference table `test` (`name` varchar(255) not null, unique `test_name_unique`(`name`))'
+        );
+    }
+}