sqlweb

README

sqlweb

About The Tool

This is a DB web client that enables users to seamlessly connect to relational databases via a user-friendly web interface. It offers a comprehensive set of features designed to enhance your database management experience.

✨ Features

• Connect to relational databases, whether hosted locally or remotely.
• A built-in SQL editor.
• Export table data in CSV or JSON formats.
• Generate raw SQL for database schema objects.
• Editable table cells
• Save connection info locally
• Relatively small and efficient executable < 15MB
• Memory usage < 25MB
• Rely on minimal external dependencies, mostly utilizing the standard library.

⭐️ Screenshots

📦 Installation

You can grab your executable from the releases page

Using the install script (mac/linux)

curl -s https://raw.githubusercontent.com/Yazeed1s/sqlweb/master/install.sh | sudo bash

build and install from source

Dependencies:

1- go 
2- vite
3- yarn
4- git

1- clone the repo

git clone https://github.com/Yazeed1s/sqlweb.git

2- cd into sqlweb/ui and install the ui dependencies

cd sqlweb/ui && yarn install

3- go back to the parent dir and run make build

cd .. && make build

4- install the binary

sudo make install

for windows users, you can download the executable from the releases page.

TODO: brew, yay

🚀 Usage

• Just run sqlweb from the terminal, then open the browser on localhost:3000

$ sqlweb
2023/09/01 13:41:04 Listening...3000

• There are some flags that can be passed to sqlweb

$ sqlweb -h
  Help information:
  USAGE: sqlweb [OPTION]
     OPTION:
	   -p <port>   	Set the port number (default: 3000)
	   -h          	Display help information
	   -v          	Display version

✅ TODO:

• Add support for MySQL
• Add support for PostgreSQL
• Add support for SQLite
• Add support for MariaDB
• Editable cells
• Table pagination
• Display columns info (field name, key, type, referenced column, referenced table, constraints name)
• Export table to csv
• Export table to json
• Export schema objects to raw sql (for those ORM users who didn't design/write the schema)
• Data visualization
• Support multiple sessions
• Add -o flag to open up the browser on localhost:port
• Display database constraints, size, number of tables... etc
• Manage/add/remove users and their permissions
• Query history

🔥 Contributing

If you would like to add a feature or to fix a bug please feel free to send a PR.