README

Laravel Cassandra

基于Cassandra的Eloquent模型和查询构建器，用于Laravel（Casloquent）

警告：这是一个正在进行中的项目...尚未准备好使用。

安装

Laravel版本兼容性

Laravel	包
5.4.x - 5.5.x	dev-master

请确保已安装Cassandra PHP驱动（版本1.2+）。更多信息请访问http://datastax.github.io/php-driver/。

使用composer安装

composer require lroman242/laravel-cassandra

Laravel

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

lroman242\LaravelCassandra\CassandraServiceProvider::class,

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

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

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

Lumen

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

    $app->configure('database');

    $app->register(lroman242\LaravelCassandra\CassandraServiceProvider::class);

配置

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

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

并添加一个新的cassandra连接

'cassandra' => [
    'driver'          => 'cassandra',
    '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,
],

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

'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"))

关系 - 不支持

查询构建器

数据库驱动程序直接集成到原始查询构建器。当使用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之间的差异问题

fruitad / laravel-cassandra

维护者

详情