PHPackages                             hackerboy/laravel-cockroachdb - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. hackerboy/laravel-cockroachdb

ActivePackage

hackerboy/laravel-cockroachdb
=============================

CockroachDB driver for Laravel

0.0.8-alpha(6y ago)097MITPHP

Since Sep 10Pushed 6y agoCompare

[ Source](https://github.com/hackerboydotcom/laravel-cockroachdb)[ Packagist](https://packagist.org/packages/hackerboy/laravel-cockroachdb)[ RSS](/packages/hackerboy-laravel-cockroachdb/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (2)DependenciesVersions (4)Used By (0)

laravel-cockroachdb
===================

[](#laravel-cockroachdb)

CockroachDB database driver for Laravel 5

Usage
-----

[](#usage)

### Step 1: Install Through Composer

[](#step-1-install-through-composer)

```
composer require hackerboy/laravel-cockroachdb

```

### Step 2: Add the Service Provider (This happens automatically in Laravel 5.5)

[](#step-2-add-the-service-provider-this-happens-automatically-in-laravel-55)

Open `config/app.php` and, to your "providers" array, add:

```
HackerBoy\LaravelCockroachDB\CockroachServiceProvider::class
```

### Step 3: Add Database Driver Configuration

[](#step-3-add-database-driver-configuration)

Open `config/datbase.php` and, to your "connections" array, add:

```
'cockroach' => [
    'driver' => 'cockroach',
    'host' => env('DB_HOST', 'HOSTNAME-OF-COCKROACH-SERVER'),
    'port' => env('DB_PORT', '26257'),
    'database' => env('DB_DATABASE', 'DATABASE-NAME'),
    'username' => env('DB_USERNAME', 'root'),
    'password' => env('DB_PASSWORD', ''),
    'charset' => 'utf8',
    'prefix' => '',
    'schema' => 'public',
    'sslmode' => 'prefer',

    // Only set these keys if you want to run en secure mode
    // otherwise you can them out of the configuration array
    'sslcert' => env('DB_SSLCERT', 'client.crt'),
    'sslkey' => env('DB_SSLKEY', 'client.key'),
    'sslrootcert' => env('DB_SSLROOTCERT', 'ca.crt'),
],
```

Make sure to update **host**, **port**, **database**, **username**, **password** and **schema** to your configuration. Note the **database** and **schema** fields should be the same.

(Blueprint) primary() method won't work!
----------------------------------------

[](#blueprint-primary-method-wont-work)

Add a primary key after table creation is currently NOT supported [Source](https://forum.cockroachlabs.com/t/primary-key-error-when-running-laravel-migrations/1968/6). So Blueprint method `$table->primary()` wont take any effects.

In case you want to set a column as primary key, use `addColumn` method instead. For example, if you want to make an UUID column as primary key:

```
// Blueprint $table
$table->addColumn('uuid', 'id', [
    'primary' => true, // Set this column as primary
    'gen_random_uuid' => true // Set default value as gen_random_uuid() (https://www.cockroachlabs.com/docs/stable/uuid.html)
]);
```

Secure Mode
-----------

[](#secure-mode)

Update **sslcert**, **sslkey** and **sslrootcert** with your path configuration.

CockroachDB 2
-------------

[](#cockroachdb-2)

Changes made to CockroachDB handles schemas slightly different when using the PHP Postgres driver. So instead of using:

```
'schema' => 'DATABASE-NAME'

```

We need to use the Postgres default of `public` so change your config to:

```
'schema' => 'public'

```

And everything should work as expected.

Known issues
------------

[](#known-issues)

- Constraints cannot be in the same migration as the creation of a table. The workaround is to add your constraints to its own migration after the table has been created.

Usage without laravel
---------------------

[](#usage-without-laravel)

It is entirely possible to use this driver without the entire Laravel framework. Laravel's database components are neatly packaged in its own composer package called `illuminate/database` Simply require this package into your project, and you are ready to go.

```
composer require illuminate/database
composer require hackerboylaravel-cockroachdb

```

To set up a database connection you need to create a new `Capsule` and register it.

```