README

RocksDB Client PHP

A PHP client for interacting with RocksDB server.

Overview

This package is a part of the RocksDBFusion project. Before integrating this client into your application, you need to run the RocksDB server provided by RocksDBFusion.

Installation

You can install the package via Composer:

composer require s00d/rocksdb-client-php

Workflow

Below is the diagram illustrating how the client interacts with the RocksDB server:

Configuration

Laravel Integration

Add the service provider:

In your config/app.php file, add the service provider to the providers array:

'providers' => [
    // Other Service Providers

    s00d\RocksDB\RocksDBServiceProvider::class,
],

And the alias to the aliases array:

'aliases' => [
    // Other Facades

    'RocksDB' => s00d\RocksDB\Facades\RocksDB::class,
],

Publish the configuration file:
```
php artisan vendor:publish --provider="s00d\RocksDB\RocksDBServiceProvider"
```
This will create a config/rocksdb.php configuration file where you can set the connection details.
Update your .env file:

Add your RocksDB connection details to the .env file:
```
ROCKSDB_HOST=127.0.0.1
ROCKSDB_PORT=12345
ROCKSDB_TOKEN=null
```

Usage:

Now you can use the RocksDB client in your Laravel application:

use RocksDB;

// Put a value
RocksDB::put('key', 'value');

// Get a value
$value = RocksDB::get('key');

// Delete a key
RocksDB::delete('key');

// Other available methods...

Direct Usage (Without Laravel)

If you want to use the client without Laravel, you can directly instantiate the RocksDBClient class.

Create an instance:

use s00d\RocksDB\RocksDBClient;

$client = new RocksDBClient('127.0.0.1', 12345);

// If you have a token
// $client = new RocksDBClient('127.0.0.1', 12345, 'your-token');

Usage:

// Put a value
$client->put('key', 'value');

// Get a value
$value = $client->get('key');

// Delete a key
$client->delete('key');

// Other available methods...

Server Setup

This package is a client for the RocksDB server, which is part of the RocksDBFusion project. Before using this client, ensure the RocksDB server is running. You can set up and run the server by following the instructions in the RocksDBFusion repository.

Methods

put

Stores a key-value pair in the database.

RocksDB::put('key', 'value', 'optional_column_family');

get

Retrieves the value of a key from the database.

$value = RocksDB::get('key', 'optional_column_family', 'default_value');

delete

Deletes a key from the database.

RocksDB::delete('key', 'optional_column_family');

merge

Merges a value with an existing key.

RocksDB::merge('key', 'value', 'optional_column_family');

listColumnFamilies

Lists all column families in the database.

$columnFamilies = RocksDB::listColumnFamilies('path_to_db');

createColumnFamily

Creates a new column family.

RocksDB::createColumnFamily('new_column_family');

dropColumnFamily

Drops an existing column family.

RocksDB::dropColumnFamily('column_family');

compactRange

Compacts the database within a range.

RocksDB::compactRange('start_key', 'end_key', 'optional_column_family');

Transactions

Begin Transaction

Begins a new transaction.

$txnId = RocksDB::beginTransaction();

Commit Transaction

Commits a transaction.

RocksDB::commitTransaction($txnId);

Rollback Transaction

Rolls back a transaction.

RocksDB::rollbackTransaction($txnId);

License

This project is licensed under the MIT License - see the LICENSE file for details.

s00d / rocksdb-client-php

Maintainers

Details