Laravel database driver for Google Cloud Spanner

v3.4.0 2019-07-02 03:10 UTC


Laravel database driver for Google Cloud Spanner

License Latest Stable Version Minimum PHP Version

CI Status on master



Put JSON credential file path to env variable: GOOGLE_APPLICATION_CREDENTIALS


Install via composer

composer require colopl/laravel-spanner

Add connection config to config/database.php

    'connections' => [
        'spanner' => [
            'driver' => 'spanner',
            'instance' => '<Cloud Spanner instanceId here>',
            'database' => '<Cloud Spanner database name here>',

That's all. You can use database connection as usual.

$conn = DB::conection('spanner');

Additional Configurations

You can pass SpannerClient config and CacheSessionPool options as below. For more information, please see Google Client Library docs

    'connections' => [
        'spanner' => [
            'driver' => 'spanner',
            'instance' => '<Cloud Spanner instanceId here>',
            'database' => '<Cloud Spanner database name here>',
            // Spanner Client configurations
            'client' => [
                'projectId' => 'xxx',
            // CacheSessionPool options
            'session_pool' => [
                'minSessions' => 10,
                'maxSessions' => 500,

Unsupported features

  • STRUCT data types
  • Explicit Read-only transaction (snapshot)



Most functions of SchemaBuilder (eg, Schema facade, and Blueprint) can be used. However, artisan migrate command does not work since AUTO_INCREMENT does not exist in Google Cloud Spanner.


Most functions of Eloquent can be used. However, some functions are not available. For example, belongsToMany relationship is not available.

If you use interleaved keys, you MUST define them in the interleaveKeys property or you won't be able to save. For more detailed instructions, see Colopl\Spanner\Tests\Eloquent\ModelTest.

Additional Information


Google Cloud Spanner sometimes requests transaction retries (e.g. UNAVAILABLE, and ABORTED), even if the logic is correct. For that reason, please do not manage transactions manually.

You should always use the transaction method which handles retry requests internally.

// BAD: Do not use transactions manually!!
try {
} catch (\Throwable $ex) {

// GOOD: You should always use transaction method
DB::transaction(function() {

Google Cloud Spanner creates transactions for all data operations even if you do not explicitly create transactions.

In particular, in the SELECT statement, the type of transaction varies depending on whether it is explicit or implicit.

// implicit transaction (Read-only transaction)
$conn->select('SELECT ...');

// explicit transaction (Read-write transaction)
$conn->transaction(function() {
    $conn->select('SELECT ...');

// implicit transaction (Read-write transaction)
$conn->insert('INSERT ...');

// explicit transaction (Read-write transaction)
$conn->transaction(function() {
    $conn->insert('INSERT ...');
Transaction type SELECT statement INSERT/UPDATE/DELETE statement
implicit transaction Read-only transaction with singleUse option Read-write transaction with singleUse option
explicit transaction Read-write transaction Read-write transaction

For more information, see Cloud Spanner Documentation about transactions

Stale reads

You can use Stale reads (timestamp bounds) as below.

// There are four types of timestamp bounds: ExactStaleness, MaxStaleness, MinReadTimestamp and ReadTimestamp.
$timestampBound = new ExactStaleness(10);

// by Connection
$connection->selectWithTimestampBound('SELECT ...', $bindings, $timestampBound);

// by Query Builder

Stale reads always runs as read-only transaction with singleUse option. So you can not run as read-write transaction.

Data Types

Some data types of Google Cloud Spanner does not have corresponding built-in type of PHP. You can use following classes by Google Cloud PHP Client

  • DATE: Google\Cloud\Spanner\Date
  • BYTES: Google\Cloud\Spanner\Bytes

Partitioned DML

You can run partitioned DML as below.

// by Connection
$connection->runPartitionedDml('UPDATE ...');

// by Query Builder

However, Partitioned DML has some limitations. See Cloud Spanner Documentation about Partitioned DML for more information.


You can define interleaved tables as below.

$schemaBuilder->create('user_items', function (Blueprint $table) {

    $table->primary(['user_id', 'id']);
    // interleaved table
    // interleaved index
    $table->index(['userId', 'created_at'])->interleave('users');


You can insert, update, and delete data using mutations to modify data instead of using DML to improve performance.


Please note that mutation api does not work the same way as DML. All mutations calls within a transaction are queued and sent as batch at the time you commit. This means that if you make any modifications through the above functions and then try to SELECT the same records before committing, the returned results will not include any of the modifications you've made inside the transaction.

SessionPool and AuthCache

In order to improve the performance of the first connection per request, we use AuthCache and CacheSessionPool.

By default, laravel-spanner uses Filesystem Cache Adapter as the caching pool. If you want to use your own caching pool, you can extend ServiceProvider and inject it into the constructor of Colopl\Spanner\Connection.



You can run tests on docker by the following command. Note that some environment variables must be set. In order to set the variables, rename .env.sample to .env and edit the values of the defined variables.

Name Value
GOOGLE_APPLICATION_CREDENTIALS The path of the service account key file with access privilege to Google Cloud Spanner instance
DB_SPANNER_INSTANCE_ID Instance ID of your Google Cloud Spanner
DB_SPANNER_DATABASE_ID Name of the database with in the Google Cloud Spanner instance
DB_SPANNER_PROJECT_ID Not required if your credential includes the project ID
make test


Apache 2.0 - See LICENSE for more information.