https://github.com/wmitsuda/mdbx-navigator
A simple UI for browsing libmdbx databases
https://github.com/wmitsuda/mdbx-navigator
Last synced: 2 months ago
JSON representation
A simple UI for browsing libmdbx databases
- Host: GitHub
- URL: https://github.com/wmitsuda/mdbx-navigator
- Owner: wmitsuda
- License: mit
- Created: 2024-07-14T21:19:25.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-07T21:18:33.000Z (8 months ago)
- Last Synced: 2025-03-28T12:21:13.314Z (3 months ago)
- Language: TypeScript
- Size: 1.52 MB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MDBX Navigator
This is an UI for the KV database [libmdbx](https://github.com/erthink/libmdbx).
The goal is to provide a simple UI for browsing the DB contents, like similar tools that exist for full SQL databases.
## Install
This software is split into 2 parts:
- a backend which reads the DB from the local filesystem and exposes the raw data through a set of REST APIs.
- an UI that consumes those APIs and allows read-only interactions using a regular web browser.
- The UI is now embedded and served from the backend binary, but it can be run separately during development.
### Build
Make sure you have installed:
- Go toolchain + goreleaser
- [nvm](https://github.com/nvm-sh/nvm)
Once `nvm` is installed, inside the `web` directory, run:
```shell
nvm install
```
This will install and select the proper `nodejs` version.
Now build the go binary for your platform/architecture by running at the root of this repo:
```shell
goreleaser build --snapshot --clean --single-target
```
The binary will be available at `./dist/mdbx-navigator_` dir.
From inside that directory, run:
```shell
./mdbx-navigator --data
```
It will open the database as read-only in exclusive mode. The frontend will be available at `http://127.0.0.1:56516`.
> No special reason to open it in exclusive mode, I just found it more practical to ensure I don't have to deal with concurrent modifications.
### Trying it
If everything is correct, opening that URL in your preferred browser should display an initial page listing all the tables contained inside the informed mdbx database.