# kv-rs

**Repository Path**: rust_us/kv-rs

## Basic Information

- **Project Name**: kv-rs
- **Description**: kv 文件存储
- **Primary Language**: Rust
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-02-15
- **Last Updated**: 2025-03-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: KV, KV-Storage

## README

# kv
KV Storage in Rust

## Components
[kv](./kv): KV Storage

[kv-cli](./kv-cli): KV CLI

## Platforms

Our current goal is that the following platforms will be able to run kv db.

* Linux x86 (`x86_64-unknown-linux-gnu`)
* Darwin x86 (`x86_64-apple-darwin`)
* Darwin arm (`aarch64-apple-darwin`)


## Installation for
### Cargo
> cargo install kvcli

## Usage

### kvcli
```doc
❯ ./kvcli

██  ██  █        █
██ ██   ██      ██
███      ██    ██
██ ██     ██  ██
██  ██     ████  KV Storage CLI

Welcome to kvcli.
Connecting to Client.

kvcli > 
```

### kvcli help
```doc
❯ ./kvcli --help

██  ██  █        █
██ ██   ██      ██
███      ██    ██
██ ██     ██  ██
██  ██     ████  KV Storage CLI

A distributed kv storage CLI

Usage: kvcli [OPTIONS] [COMMAND]

Commands:
  login  👤  login sys and check user account!
  help   Print this message or the help of the given subcommand(s)

Options:
  -d, --debug                  debug model
      --help                   Print help information
  -c, --config <CONFIG>        Configuration file path [default: config/kvdb.yaml]
  -q, --quiet                  quiet model, No output printed to stdout
  -l, --log-level <LOG_LEVEL>  [default: info]
  -n, --non-interactive        Force non-interactive mode
      --query=<QUERY>          Query to execute
  -V, --version                Print version
```

### kvcli debug

```doc
> ./kvcli -d
> ./kvcli --debug

██  ██  █        █
██ ██   ██      ██
███      ██    ██
██ ██     ██  ██
██  ██     ████  KV Storage CLI

Args { debug: true, help: false, config: "config/kvdb.yaml", cmd: None, quiet: false, log_level: "info", non_interactive: false, query: None }
ConfigLoad { version: 1, api_key: "abcd", data_dir: "/media/fengyang/App-1T/workspace/kv/storage", compact_threshold: 0.2, prompt: Some("kvcli"), show_stats: Some(false), auto_append_part_cmd: Some(false), multi_line: Some(true), replace_newline: Some(true), show_affected: Some(false), progress_color: None, show_progress: Some(false) }

Welcome to kvcli.
Connecting to Client.

kvcli > 
```

### Grammar

| 语法     | CMD                | Desc                                        | DEMO                           |
|--------|--------------------|---------------------------------------------|--------------------------------|
| INFO   | INFO               | 查看服务状态和相关信息                                 | INFO                           |
| TIME   | TIME               | 返回当前服务器时间                                   | TIME                           |
| KSIZE  | KSIZE              | 返回当前库文件的 key 的数量                            | KSIZE                          |
| EXIT   | exit               | 关闭当前连接                                      | exit                           |
| SHOW   | SHOW DB            | 显示当前使用的库文件                                  | SHOW DB                        |
| SELECT | SELECT <db>        | 切换到指定的库文件                                   |                                |
| SET    | SET <KEY> <VALUE>  | 设置指定 key 的值。                                | SET ob "redis" <br/> SET key 1 |
| GET    | GET <KEY>          | 获取指定 key 的值                                 | GET ob                         |
| KEYS   | KEYS               | key list                                    | KEYS                           |
| DEL    | DEL <KEY>          |                                             | DEL ob                         |
| DELETE | DELETE <KEY>       |                                             | DELETE ob                      |
| GETSET | GETSET key value   | 将给定 key 的值设为 value ，并返回 key 的旧值(old value)。 |                                |
| MGET   | MGET key1 [key2..] | 获取所有(一个或多个)给定 key 的值。                       |                                |
| SETEX  | SETNX key value    | 只有在 key 不存在时设置 key 的值。                      |                                |


```doc
❯ ./kvcli

██  ██  █        █
██ ██   ██      ██
███      ██    ██
██ ██     ██  ██
██  ██     ████  KV Storage CLI

Welcome to kvcli.
Connecting to Client.

kvcli > SET order_key xxx
OK

kvcli > keys
order_key

kvcli > ksize
1

kvcli > GET order_key
xxx

kvcli > DEL order_key
OK

kvcli > GET order_key
N/A

```

### Config

### 在 terminal 终端模式下， Refresh Config
| CMD                               | Desc                                        |
|-----------------------------------|---------------------------------------------|
| .show_progress 【true, false】      | Show progress [bar] when executing queries.  Default false   |
| .show_stats 【true, false】 | Show stats after executing queries.  Only works with non-interactive mode.  |
| .show_affected 【true, false】 | Show rows affected |
| .auto_append_part_cmd 【true, false】 | fix part cmd options. default false  |
| .multi_line 【true, false】 | Multi line mode, default is true. |
| .replace_newline 【true, false】 | whether replace '\n' with '\\n', default true. |