basho/riak-pb

PHP官方Riak协议缓冲区客户端

1.3.0 2016-12-15 22:04 UTC

README

  • Packagist
  • 构建状态: Build Status

Riak PHP PB客户端 是一个客户端,可以轻松与 Riak 通信,Riak 是一个开源的、分布式数据库,专注于高可用性、水平可扩展性和 可预测的延迟。Riak 和此代码均由 Basho 维护。

要查看可用于与 Riak 一起使用的其他客户端,请访问我们的 文档站点

安装

依赖项

此库需要 PHP 5.4+ 和 allegro/protobuf PHP 扩展(下面有说明)。

Composer 安装

运行以下 composer 命令

$ composer require "basho/riak-pb": "1.2.*"

或者,手动将以下内容添加到您的 composer.json 文件中,在 require 部分

"require": {
    "basho/riak-pb": "1.2.*"
}

然后运行 composer update 确保模块已安装并检索了所有依赖项。

接下来,您需要运行以下命令安装支持 PB 的所需扩展

make install-protobuf

最后,您需要确保通过 php.ini 或 PHP 配置文件(*.conf)将新安装的扩展包含在您的 PHP 环境中。

extension=protobuf.so

您可以使用以下命令确认它已为命令行环境启用。

php -m | fgrep protobuf

文档

该库 API 文档的完整可遍历版本可在 Github Pages 上找到。

示例用法

以下是一个使用客户端的简短示例。更详细的示例代码可在 此处 找到。

// lib classes are included via the Composer autoloader files
use Basho\Riak;
use Basho\Riak\Api\Pb;
use Basho\Riak\Node;
use Basho\Riak\Command;

// define the connection info to our Riak nodes
$nodes = (new Node\Builder)
    ->onPort(10018)
    ->buildCluster(['riak1.company.com', 'riak2.company.com', 'riak3.company.com',]);

// instantiate the Riak client
$riak = new Riak($nodes, [], new Pb());

// build a command to be executed against Riak
$command = (new Command\Builder\StoreObject($riak))
    ->buildObject('some_data')
    ->buildBucket('users')
    ->build();

// Receive a response object
$response = $command->execute($command);

// Retrieve the Location of our newly stored object from the Response object
$object_location = $response->getLocation();

贡献

此存储库的维护者是 Basho 的工程师,我们欢迎您为此项目做出贡献!您可以首先通过查看 CONTRIBUTING.md 了解有关测试到编码标准的所有信息。

一个诚实的声明

由于我们对稳定性的执着以及我们丰富的用户生态系统,此存储库的社区更新可能需要更长的时间进行审查。

最有助于贡献的方式是通过问题报告您的经验。在我们内部审查时,问题可能不会更新,但我们仍然非常感激。

感谢您成为社区的一部分!我们因此而爱您。

许可证和作者

版权(c)2015 Basho Technologies, Inc. 根据 Apache License,版本 2.0(“许可证”)许可。有关详细信息,请参阅 许可证