percas-client 0.1.2

A client for talking to the Percas server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# Percas: PERsistent CAche Service

Percas is a distributed persistent cache service optimized for high performance NMVe SSD. It aims to provide the capability to scale-out without pain and with stable performance.

## Getting Started

### Prerequisites

To get started with Percas, you can follow these steps:

1. **Install Rust**: Make sure you have Rust installed on your system. You can install it using [rustup](https://rustup.rs/).
2. **Clone the Repository**: Clone the Percas repository from GitHub:
   ```shell
   git clone https://github.com/scopedb/percas.git
   cd percas
   ```
3. **Build the Project**: Use Cargo to build the project:
   ```shell
   cargo x build
   ```

### Standalone Mode

To run a standalone instance of Percas, you can use the following command:

```shell
./target/debug/percas start --config-file dev/standalone/config.toml
```

This will start a standalone instance of Percas listening on `localhost:7654`.

### Cluster Mode

Percas is a decentralized distributed cache service. Each node in the cluster operates independently without relying on a central coordinator, allowing for excellent scalability and fault tolerance.

To quickly start a simple 3-node cluster for development or testing, you can run:

```shell
./target/debug/percas start --config-file dev/cluster/config-0.toml &
./target/debug/percas start --config-file dev/cluster/config-1.toml &
./target/debug/percas start --config-file dev/cluster/config-2.toml &
```

You can interact with the cluster through any node, in this example they are `localhost:7654`, `localhost:7656` and `localhost:7658`.

Percas will automatically handle data distribution and request routing across all nodes.

### HTTP API

Percas provides a simple HTTP API for interacting with the cache. You can use any HTTP client to send requests to the cache.

Here are some examples of how to use the HTTP API:
```shell
curl -X PUT http://localhost:7654/my/lovely/key -d 'my_lovely_value'
curl -X GET http://localhost:7654/my/lovely/key
curl -X DELETE http://localhost:7654/my/lovely/key
```

## License

This work is licensed by [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).

We're still developing a suitable license model. So far, Apache License 2.0 fits it well. Any source code and releases delivered under the current license model can be used following Apache License 2.0 from then on.