README

Cassandra ORM驱动程序。

安装

注意：请确保您已安装Cassandra PHP驱动程序（版本1.3+）。更多信息请访问DataStax PHP Driver。

使用Composer安装

composer require a-h-abid/eloquent-cassandra

Laravel

在config/app.php中添加服务提供者

AHAbid\EloquentCassandra\CassandraServiceProvider::class,

服务提供者将注册一个与原始数据库管理器对应的cassandra数据库扩展。无需注册额外的外观或对象。当使用cassandra连接时，Laravel将自动为您提供相应的cassandra对象。

对于Laravel之外的使用，请查看Capsule manager并添加

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

Lumen

将以下行添加到您的bootstrap.php

    $app->configure('database');

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

配置

在config/database.php中更改默认数据库连接名称

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

并添加一个新的cassandra连接

'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),
    ],
],

您可以使用以下配置连接到多个服务器

'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,
],

注意：您可以在.env中输入所有节点，例如

# .env
DB_HOST=192.168.0.1,192.168.0.2,192.168.0.3

注意：可用的一致性级别列表（PHP常量）

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

注意：您可以使用选项根据查询设置特定的一致性级别

Eloquent

模型使用

支持大多数eloquent查询构建功能、事件、字段访问。

    $users = User::all();

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

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

关系 - 不支持

属性转换

可以使用UUID作为模型主键

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',
    ];
    ...
}

查询构建器

数据库驱动程序直接集成到原始查询构建器。当使用cassandra连接时，您将能够构建流畅的查询以执行数据库操作。

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

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

如果您没有更改默认数据库连接，您需要在查询时指定它。

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

查询构建器的默认get方法将调用从数据库的批量获取。批量大小可以在配置文件中配置（'page_size' => env('DB_PAGE_SIZE', 5000)）或使用额外的查询构建器方法setPageSize。

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

警告：不建议在表中数据量很大时使用get。请改用getPage。

获取单页结果

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

可以设置下一页令牌，允许获取下一批结果

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

获取下一页

$comments = $comments->nextPage();

获取下一页令牌

$comments = $comments->getNextPageToken();

将下一页的结果添加到集合中

$comments->appendNextPage();

检查是否是最后一页

$comments->isLastPage();

获取当前页面的原始cassandra响应（\Cassandra\Rows）

$rows = $commants->getRows();

有关查询构建器的更多信息，请访问https://laravel.net.cn/docs/queries

示例

将用户数据存储到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();
}

简单的API，用于在页面上实现分页的“加载更多”功能

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,
        ...
    ]);
}

如果您使用cassandra物化视图，可以轻松地与eloquent模型一起使用

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

待办事项

[ ] 完全支持复合主键 [ ] 完全测试覆盖率 [ ] 修复 \Cassandra\Date 与 Carbon 之间的差异 [ ] 添加模式查询支持 [ ] 添加异步查询能力

Docker

在包根目录中存储了docker-compose设置。它可以用于本地开发和测试运行。与PHPStorm测试工具和覆盖率配合良好。

在“main”容器中运行以下命令以运行测试和生成覆盖率文件

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

a-h-abid / eloquent-cassandra

维护者

详细信息