Skip to content

Commit 8a454a8

Browse files
committed
doc: add roadmap
1 parent de66882 commit 8a454a8

File tree

1 file changed

+76
-20
lines changed

1 file changed

+76
-20
lines changed

README.md

Lines changed: 76 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,88 @@
33
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=invisal_query-master&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=invisal_query-master) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=invisal_query-master&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=invisal_query-master)
44
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=invisal_query-master&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=invisal_query-master)
55

6-
QueryMaster is a simple and yet another database graphical client. It is free and cross platform. Currently, only support MySQL but with future plan to support many other SQL-like database.
6+
Query Master is a free, open-source, and cross-platform GUI tool for databases. Although this project is relatively young, we are ambitious in our goal to create one of the best tools available. Currently, it only supports MySQL, but we plan to add support for other relational databases by 2024.
77

88

99
![QueryMaster](https://i.ibb.co/6ybwWYy/animated2.gif)
1010

11-
## Features and Roadmap
11+
## Roadmap and Features
1212

13-
- [x] Multiple query result
14-
- [x] Basic auto complete
15-
- [x] Connect to MySQL database without specified database
16-
- [x] 3 protection modes
17-
- [x] Support Dark mode
18-
- [x] Inline editing query result
19-
- [x] Inline editing query result with JSON editor
20-
- [x] Beautify SQL code
21-
- [x] Insert new record
22-
- [x] Delete record
23-
- [x] Export to CSV, SQL, and Excel file.
24-
- [ ] Saved query
25-
- [ ] Query history
13+
These are the features that we have either completed or plan to complete. Currently, we have finished approximately 20% of our initial roadmap.
2614

27-
We are trying to caching up with other databsae GUI client in term of feature.
15+
### Writing SQL
2816

29-
## Contributing
17+
QueryMaster aims to provide the best experience for writing SQL, which includes the following features:
3018

31-
There are many ways that you can contribute to this project.
19+
- Smart autocomplete
20+
- ✅ Automatically completes database, table, and column names.
21+
- ✅ Detects ENUM columns and provides auto-completion.
22+
- ❌ Auto-completes aliased tables.
23+
- ❌ Analyzes sub-queries and provides auto-completion for their columns.
24+
- ❌ Provides hints and function usage.
25+
- Code formatter
26+
- ✅ Beautifies your SQL code.
27+
- ❌ Allows customization of the beautify style.
28+
- Support for variables
29+
- ❌ Allows developers to bind values to variables, making queries more reusable.
3230

33-
- Spread the word: This project is very young and we need more people to use it so that we can get feedback. By spread the word about this project, it will provide us more motivation to keep this project going.
34-
- If you found any bug, submit the issue and we will get it fixed as soon as possible.
31+
### Running Queries
32+
33+
- Protection and Review
34+
- ✅ QueryMaster offers three levels of protection mode. Review your SQL before running any query that can greatly impact your database.
35+
- Kill query
36+
- ✅ Terminate the query before it finishes running. It is good for canceling long-running queries.
37+
- Multiple queries result
38+
- ✅ Run multiple queries and see all of their results in separate tabs.
39+
- Saved Queries
40+
- ❌ Save your queries with a name to use later.
41+
- Query History
42+
- ❌ Record the browser queries that you used to run.
43+
44+
### Data Editor
45+
46+
- ✅ Edit data within the data editor.
47+
- ✅ Edit data even if it is a result of an INNER JOIN.
48+
- ✅ Add rows.
49+
- ✅ Remove rows.
50+
- ✅ We provide a JSON editor.
51+
- ❌ Preview geometry data visually on a map.
52+
- ✅ Preview changes before committing them.
53+
- ✅ You can discard any changes made.
54+
55+
### Export and Import Data
56+
57+
- ✅ Export to CSV
58+
- ✅ Export to Microsoft Excel
59+
- ❌ Export to JSON
60+
- ❌ Export to SQL
61+
- ❌ Export to XML
62+
- ❌ Export to Clipboard
63+
- ❌ Import from CSV
64+
- ❌ Import from Excel
65+
- ❌ Import from SQL
66+
67+
### Connection Management
68+
69+
- ✅ Manage your connections in nested folders.
70+
71+
### Editing Schema
72+
73+
- ❌ Create and drop database
74+
- ❌ Create/Edit/Remove table
75+
- ❌ Create/Edit/Remove stored procedure
76+
- ❌ Create/Edit/Remove trigger
77+
- ❌ Create/Edit/Remove event
78+
79+
### Monitor and Management
80+
81+
- ❌ Manage users
82+
- ❌ Monitor and kill process
83+
84+
### Visualization
85+
- ❌ Visualize data in a chart.
86+
87+
### Cloud Feature
88+
- ❌ Add E2E password encryption
89+
- ❌ Store your connections in the cloud
90+
- ❌ Store your saved queries

0 commit comments

Comments
 (0)