PHPackages                             a-h-abid/eloquent-cassandra - 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. [Database & ORM](/categories/database)
4. /
5. a-h-abid/eloquent-cassandra

ActiveLibrary[Database & ORM](/categories/database)

a-h-abid/eloquent-cassandra
===========================

Cassandra driver for Eloquent ORM

v0.1.9(3y ago)44315MITPHPPHP >=7.2.0

Since Mar 23Pushed 2y agoCompare

[ Source](https://github.com/a-h-abid/eloquent-cassandra)[ Packagist](https://packagist.org/packages/a-h-abid/eloquent-cassandra)[ Docs](https://github.com/a-h-abid/eloquent-cassandra)[ RSS](/packages/a-h-abid-eloquent-cassandra/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (6)Dependencies (7)Versions (13)Used By (0)

Eloquent Cassandra
==================

[](#eloquent-cassandra)

Cassandra driver for Eloquent ORM.

Installation
------------

[](#installation)

---

*Note:* Make sure you have the Cassandra PHP driver installed (version 1.3+). You can find more information at [DataStax PHP Driver](http://datastax.github.io/php-driver/).

Installation using composer:

```
composer require a-h-abid/eloquent-cassandra

```

#### Laravel

[](#laravel)

And add the service provider in `config/app.php`:

```
AHAbid\EloquentCassandra\CassandraServiceProvider::class,
```

The service provider will register a cassandra database extension with the original database manager. There is no need to register additional facades or objects. When using cassandra connections, Laravel will automatically provide you with the corresponding cassandra objects.

For usage outside Laravel, check out the [Capsule manager](https://github.com/illuminate/database/blob/master/README.md) and add:

```
$capsule->getDatabaseManager()->extend('cassandra', function($config)
{
    return new AHAbid\EloquentCassandra\Connection($config);
});
```

#### Lumen

[](#lumen)

Add next lines to your `bootstrap.php`

```
    $app->configure('database');
```

```
    $app->register(AHAbid\EloquentCassandra\CassandraServiceProvider::class);
```

Configuration
-------------

[](#configuration)

Change your default database connection name in `config/database.php`:

```
'default' => env('DB_CONNECTION', 'cassandra'),
```

And add a new cassandra connection:

```
'cassandra' => [
    'driver'          => 'cassandra',
    'scheme'          => env('DB_SCHEME', 'tcp'),
    'host'            => env('DB_HOST', 'localhost'),
    'port'            => env('DB_PORT', 9042),
    'keyspace'        => env('DB_DATABASE'),
    'username'        => env('DB_USERNAME'),
    'password'        => env('DB_PASSWORD'),
    'page_size'       => env('DB_PAGE_SIZE', 5000),
    'consistency'     => Cassandra::CONSISTENCY_LOCAL_ONE,
    'timeout'         => null,
    'connect_timeout' => 5.0,
    'request_timeout' => 12.0,
    'ssl' => [
        'verify_peer' => nv('DB_SSL_VERIFY_PEER', false),
        'trusted_cert' => nv('DB_SSL_TRUSTED_CERT_FILE', null),
        'client_cert' => nv('DB_SSL_CLIENT_CERT_FILE', null),
        'private_cert' => nv('DB_SSL_PRIVATE_CERT_FILE', null),
        'private_passphrase' => nv('DB_SSL_PRIVATE_PASSPHRASE', null),
    ],
],
```

You can connect to multiple servers with the following configuration:

```
'cassandra' => [
    'driver'          => 'cassandra',
    'host'            => ['192.168.0.1', '192.168.0.2'], //or '192.168.0.1,192.168.0.2'
    'port'            => env('DB_PORT', 9042),
    'keyspace'        => env('DB_DATABASE'),
    'username'        => env('DB_USERNAME'),
    'password'        => env('DB_PASSWORD'),
    'page_size'       => env('DB_PAGE_SIZE', 5000),
    'consistency'     => Cassandra::CONSISTENCY_LOCAL_ONE,
    'timeout'         => null,
    'connect_timeout' => 5.0,
    'request_timeout' => 12.0,
],
```

Note: you can enter all of your nodes in .env like :

```
# .env
DB_HOST=192.168.0.1,192.168.0.2,192.168.0.3

```

Note: list of available consistency levels (php constants):

```
Cassandra::CONSISTENCY_ANY
Cassandra::CONSISTENCY_ONE
Cassandra::CONSISTENCY_TWO
Cassandra::CONSISTENCY_THREE
Cassandra::CONSISTENCY_QUORUM
Cassandra::CONSISTENCY_ALL
Cassandra::CONSISTENCY_SERIAL
Cassandra::CONSISTENCY_QUORUM
Cassandra::CONSISTENCY_LOCAL_QUORUM
Cassandra::CONSISTENCY_EACH_QUORUM
Cassandra::CONSISTENCY_LOCAL_SERIAL
Cassandra::CONSISTENCY_LOCAL_ONE

```

Note: you can set specific consistency level according to the query using options

Eloquent
--------

[](#eloquent)

#### Model Usage

[](#model-usage)

Supported most of eloquent query build features, events, fields access.

```
    $users = User::all();

    $user = User::where('email', 'tester@test.com')->first();

    $user = User::find(new \Cassandra\Uuid("7e4c27e2-1991-11e8-accf-0ed5f89f718b"))
```

Relations - NOT SUPPORTED

#### Attributes casting

[](#attributes-casting)

There is ability to use UUID as model primary key

```
class Item
{
    ...

    protected $keyType = 'uuid';

    public $incrementing = true; // will automatically cast your primary key to keyType

    // OR

    protected $keyType = 'uuid';

    public $incrementing = false;

    protected $casts = [
        'id' => 'uuid',
    ];
    ...
}

```

Query Builder
-------------

[](#query-builder)

The database driver plugs right into the original query builder. When using cassandra connections, you will be able to build fluent queries to perform database operations.

```
$users = DB::table('users')->get();

$user = DB::table('users')->where('name', 'John')->first();
```

If you did not change your default database connection, you will need to specify it when querying.

```
$user = DB::connection('cassandra')->table('users')->get();
```

Default use of `get` method of query builder will call chunked fetch from database. Chunk size can be configured on config file (` 'page_size' => env('DB_PAGE_SIZE', 5000)`) or with additional query builder`s method `setPageSize`.

```
$comments = Comments::setPageSize(500)->get(); // will return all comments, not 500
```

**WARNING**: Not recomended to use `get` if there are a lot of data in table. Use `getPage` instead.

Get single page of resuts

```
$comments = Comments::setPageSize(500)->getPage(); // will return collection with 500 results
```

There is an ability to set next page token what allows to get next chunk of results

```
$comments = Comments::setPaginationStateToken($token)->getPage();
```

Get next page:

```
$comments = $comments->nextPage();
```

Get next page token:

```
$comments = $comments->getNextPageToken();
```

Append collection with next page`s result:

```
$comments->appendNextPage();
```

Check if it is last page:

```
$comments->isLastPage();
```

Get raw cassandra response for current page (\\Cassandra\\Rows):

```
$rows = $commants->getRows();
```

Read more about the query builder on

Examples
--------

[](#examples)

- store users data to csv

```
$users = User::setPageSize(1000)->getPage();
while(!$users->isLastPage()) {
    foreach($users as $user) {
        // here you can write a lines to csv file
    }

    $users = $users->nextPage();
}
```

- Simple api to make `Load more` as paggination on page

```
public function getComments(Request $request) {
    ...

    $comments = Comment::setPageSize(50)
        ->setPaginationStateToken($request->get('nextPageToken', null)
        ->getPage();

    ...

    return response()->json([
        ...
        'comments' => $comments,
        'nextPageToken' => !$comments->isLastPage() ? $comments->getNextPageToken() : null,
        ...
    ]);
}
```

- If you use cassandra materialized views you can easily use it with eloquent models

```
$users = User::from('users_by_country_view')->where('country', 'USA')->get();
```

TODO:
-----

[](#todo)

\[ \] full support of composite primary key \[ \] full test coverage \[ \] fix diff between \\Cassandra\\Date with Carbon \[ \] add schema queries support \[ \] add ability to use async queries

Docker:
-------

[](#docker)

There is docker-compose setup stored in package root. It can be used for local development and test running. Works well with PHPStorm testing tools + coverage.

Run command below inside of the "main" container to run tests and generate coverage file:

```
vendor/bin/phpunit --coverage-clover clover.xml
```

###  Health Score

29

—

LowBetter than 60% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity19

Limited adoption so far

Community13

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 56.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~59 days

Recently: every ~18 days

Total

7

Last Release

1354d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/dbe37bafa4bb2d7841d090cac27712c5ef1b8b3815cb2429174fd298c68afa48?d=identicon)[a-h-abid](/maintainers/a-h-abid)

---

Top Contributors

[![lroman242](https://avatars.githubusercontent.com/u/11349698?v=4)](https://github.com/lroman242 "lroman242 (57 commits)")[![a-h-abid](https://avatars.githubusercontent.com/u/2020773?v=4)](https://github.com/a-h-abid "a-h-abid (42 commits)")[![ahmedul-abid](https://avatars.githubusercontent.com/u/207574940?v=4)](https://github.com/ahmedul-abid "ahmedul-abid (1 commits)")[![Fuitad](https://avatars.githubusercontent.com/u/263288?v=4)](https://github.com/Fuitad "Fuitad (1 commits)")

---

Tags

laraveldatabaselumenmodeleloquentcassandracsql

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/a-h-abid-eloquent-cassandra/health.svg)

```
[![Health](https://phpackages.com/badges/a-h-abid-eloquent-cassandra/health.svg)](https://phpackages.com/packages/a-h-abid-eloquent-cassandra)
```

###  Alternatives

[mongodb/laravel-mongodb

A MongoDB based Eloquent model and Query builder for Laravel

7.1k7.2M71](/packages/mongodb-laravel-mongodb)[dyrynda/laravel-model-uuid

This package allows you to easily work with UUIDs in your Laravel models.

4802.8M8](/packages/dyrynda-laravel-model-uuid)[pdphilip/elasticsearch

An Elasticsearch implementation of Laravel's Eloquent ORM

145360.2k4](/packages/pdphilip-elasticsearch)[toponepercent/baum

Baum is an implementation of the Nested Set pattern for Eloquent models.

3154.7k](/packages/toponepercent-baum)[friendsofcat/laravel-couchbase

A Couchbase based Eloquent model and Query builder for Laravel

1430.8k](/packages/friendsofcat-laravel-couchbase)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)