termdbms

TODO CLEANUP REFACTOR FORMAT

A TUI for viewing and editing databases, written in pure Go

Database Support

SQLite
MySQL (for implementation reasons, all queryies executed against a MySQL DB cannot be rolled back.

made with modernc.org/sqlite, charmbracelet/bubbletea, and charmbracelet/lipgloss

Works with keyboard and mouse!

Navigate tables with any number of columns!

Navigate tables with any number of rows!

Serialize your changes as a copy or over the database original! (SQLite only)

Other Features

• Automatic JSON formatting in selection mode
• Undo/Redo stack

Roadmap

• Run SQL queries and display results
• Add/remove rows/columns/cells
• Filter tables by fuzzy search
• MySQL/ PostgreSQL support
• Better editing

How To Build

Linux

GOOS=linux GOARCH=amd64/386 go build

ARM (runs kind of slow depending on the specs of the system)

GOOS=linux GOARCH=arm GOARM=7 go build

Windows

GOOS=windows GOARCH=amd64/386 go build

OSX

GOOS=darwin GOARCH=amd64 go build

Terminal settings

Whatever terminal emulator used should support ANSI escape sequences. If there is an option for 256 color mode, enable it.

Known Issues

• The headers wig out sometimes in selection mode
• Possible race conditions with getting data initialized, only happens when debugging?
• Serializing a numeric string change (like "1234") sometimes appends a decimal at the end, even though go recognizes it as a string when serializing. This is likely a bug at the database driver level, or I am not good at this.
• Mouse down does not work in Windows Terminal, but it does work in Command Prompt.

Help:

-p	database path (absolute)
-d  specifies which database driver to use (sqlite/mysql)
-a  enable ascii mode
-h	prints this message

Controls:

MOUSE

Scroll up + down to navigate table
Move cursor to select cells for full screen viewing

KEYBOARD

[WASD] to move around cells, and also move columns if close to edge
[ENTER] to select selected cell for full screen view
[UP/K and DOWN/J] to navigate schemas
[LEFT/H and RIGHT/L] to navigate columns if there are more than the screen allows.
    Also to control the cursor of the text editor in edit mode
[BACKSPACE] to delete text before cursor in edit mode
[M(scroll up) and N(scroll down)] to scroll manually
[Q or CTRL+C] to quit program
[B] to toggle borders!
[C] to expand column
[P] in selection mode to write cell to file
[ESC] to exit full screen view, or to enter edit mode
[PGDOWN] to scroll down one views worth of rows
[PGUP] to scroll up one views worth of rows

EDIT MODE

[ESC] to enter edit mode with no pre-loaded text input from selection
When a cell is selected, press [:] to enter edit mode with selection pre-loaded
The text field in the header will be populated with the selected cells text. Modifications can be made freely
[ESC] to clear text field in edit mode
[ENTER] to save text. Anything besides one of the reserved strings below will overwrite the current cell
[R] to redo actions, if applicable
[U] to undo actions, if applicable
[:q] to exit edit mode
[:s] to save database to a new file (SQLite only)
[:s!] to overwrite original database file (SQLite only). A confirmation dialog will be added soon
[:h] to display help text
[HOME] to set cursor to end of the text
[END] to set cursor to the end of the text