You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**EDMA: Embedded Database Management for All** is an open source project made to manage embedded key-value storages. EDMA is a TUI (Terminal User Interface) that is easy to install and configure. It allows engineer to traverse the embedded database and deserialize byte data with provided byte layout. This enhances the experience of working with low level database system like RocksDB or Redb.
@@ -42,9 +41,44 @@ Embedded Database Management for All
42
41
- Custom byte layout deserialization
43
42
- Execute database command directly in terminal
44
43
- Interactive terminal interface with keyboard only control
45
-
-Iterate key-value pairs from column family and table
44
+
- Iterate key-value pairs from column family and table
45
+
46
+
## Getting Started
47
+
48
+
### Installation
49
+
50
+
#### With Homebrew (Linux, macOS)
51
+
52
+
If you’re using Homebrew or Linuxbrew, install the edma formula:
53
+
54
+
```
55
+
brew install nomadiz/tap/edma
56
+
```
57
+
58
+
#### With Cargo (Linux, macOS, Windows)
59
+
60
+
If you already have a Rust environment set up, you can use the `cargo install` command:
61
+
62
+
```
63
+
cargo install --version 0.1.0-beta.3 edma
64
+
```
46
65
47
-
## Usage
66
+
#### From binaries (Linux, macOS, Windows)
67
+
68
+
- Download the [latest release binary](https://github.com/nomadiz/edma/releases) for your system
69
+
- Set the `PATH` environment variable
70
+
71
+
### Set a config path
72
+
73
+
Configuration file is where you identify path to databases and EDMA byte templates. To set a config path, using a CLI command
74
+
75
+
```
76
+
$ edma --config-path [PATH_TO_FILE]
77
+
```
78
+
79
+
Please view [EDMA Configuration file](https://github.com/nomadiz/edma#configuration) to learn more how configuration file works.
80
+
81
+
### Usage
48
82
49
83
Run EDMA terminal application
50
84
@@ -55,7 +89,7 @@ $ edma
55
89
Set a config file path
56
90
57
91
```shell
58
-
$ edma --config-file [PATH]
92
+
$ edma --config-path [PATH]
59
93
```
60
94
61
95
Using `help` command
@@ -77,6 +111,52 @@ OPTIONS:
77
111
-c, --config-path <config-path> Set the config file
**EDMA** is a very first database management tool designed for embedded databases. Applying adapter design pattern into database storage implementation, it makes integration with databases become easier. EDMA supports two databases by default: `RocksDB` and `ReDB`. To integrate with other embedded databases, you can add the implementation in [EDMA storage layer](https://github.com/nomadiz/edma/tree/master/db/src/storage/kvs)
EDMA is built using Rust library `tui-rs` which makes it to be an app that can be run directly on your terminal. No startup time needed and it's extremely light weight. Run every where, every time, all at once
Data in embedded database is different from data presented in relational databases. While relational databases label data with specific type and attributes when it is created, embedded database can't do that. The only data type that embedded database displays is byte array. For example, `[0 0 0 1 50 32 20]`. It is not human readable.
145
+
146
+
Using EDMA, byte data can be converted into human readable data using EDMA byte template system.
147
+
148
+
Instruction on how EDMA byte deserializer works: [What is EDMA templates?](https://github.com/nomadiz/edma#templates)
149
+
150
+
### Command editor
151
+
152
+
Command editor is one core feature of EDMA, it allows you to manage byte data using advanced commands. The image below shows how a database column family can iterated using command editor
0 commit comments