fjall-cli 1.0.0

CLI for Fjall database
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

<!-- DO NOT EDIT -->
<!-- This file is automatically generated by README.ts. -->
<!-- Edit README.ts if you want to make changes. -->

# CLI for Fjall database

[![Build](https://github.com/DenisGorbachev/fjall-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/DenisGorbachev/fjall-cli)

<!-- crate documentation start -->
## Command

The command requires `--db <PATH>` or `FJALL_DB`.

## Subcommands

* `keyspace <KEYSPACE> <SUBCOMMAND>` runs keyspace-scoped operations:
  `iter`, `get`, `insert`, `contains`, `len`, `clear`, `delete`.
* `list-keyspace-names` lists keyspace names (one per line).
* `keyspace-count` prints the number of keyspaces.

Exit codes for `keyspace <KEYSPACE> contains <KEY>`:

* `0` - key exists
* `1` - error occurred
* `127` - key does not exist

## Byte encodings

Commands that accept key/value bytes support `--*-encoding` with:

* `string` (default)
* `hex`
* `path`
* `empty` (argument must be exactly `-`)

## Example

```bash
DB_DIR="$(mktemp -d)"
export FJALL_DB="$DB_DIR"

fjall keyspace items insert key value
fjall keyspace items len
# 1

fjall keyspace-count
# 1

fjall keyspace items contains key
# exit code: 0
fjall keyspace items contains missing
# exit code: 127

fjall keyspace items get key
# value

fjall keyspace items iter --key-suffix ":" --value-suffix $'\n'
# key:value

fjall list-keyspace-names
# items

fjall keyspace items delete
fjall keyspace-count
# 0
```

## Known bugs

* `clear` may not persistently clear a keyspace in fjall v3.0.1 due to
  [fjall-rs/fjall#241](https://github.com/fjall-rs/fjall/issues/241).
<!-- crate documentation end -->

## Installation

Install as executable:

```shell
cargo install --locked fjall-cli
```

Install as library dependency in your package:

```shell
cargo add fjall-cli
```

## Usage

```shell
CLI for Fjall database

Usage: fjall --db <DB> <COMMAND>

Commands:
  keyspace             
  list-keyspace-names  
  keyspace-count       
  help                 Print this message or the help of the given subcommand(s)

Options:
      --db <DB>  [env: FJALL_DB=]
  -h, --help     Print help
  -V, --version  Print version
```

## Gratitude

Like the project? [⭐ Star this repo](https://github.com/DenisGorbachev/fjall-cli) on GitHub!

## License

[Apache-2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT).

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, shall be licensed as above, without any additional terms or conditions.