Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oslabs-beta/scanql
A Real-Time PostgreSQL Monitoring, Analysis, and Visualization Developer Tool
https://github.com/oslabs-beta/scanql
chartjs cypress docker express javascript nodejs open-source postgresql radix-ui react-flow react-hooks react-router tailwindcss testing-library typescript vite vitest zustand
Last synced: 25 days ago
JSON representation
A Real-Time PostgreSQL Monitoring, Analysis, and Visualization Developer Tool
- Host: GitHub
- URL: https://github.com/oslabs-beta/scanql
- Owner: oslabs-beta
- License: mit
- Created: 2023-08-12T00:53:06.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-22T04:25:44.000Z (about 1 year ago)
- Last Synced: 2024-10-14T00:21:17.457Z (25 days ago)
- Topics: chartjs, cypress, docker, express, javascript, nodejs, open-source, postgresql, radix-ui, react-flow, react-hooks, react-router, tailwindcss, testing-library, typescript, vite, vitest, zustand
- Language: TypeScript
- Homepage: https://scanql.dev
- Size: 44.6 MB
- Stars: 41
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
https://scanql.dev/
ScanQL is an elegant and effective tool designed to empower developers aiming for database and query optimization to ensure their operations run smoothly and efficiently. Beyond optimization, ScanQL offers a holistic view of a database, empowering
one to understand the intricate details and interrelations within their database.
## About The Project
## Features:
+ Database Visualization: Get a holistic view of your entire database schema, allowing for a better understanding of relations, data distribution, and table structures.
+ Query Performance Analysis: With ScanQL's testing mechanism, analyze the planning and execution times of generic SELECT and UPDATE queries, pinpointing potential bottlenecks and inefficiencies.
+ ER Diagram: Visualize intricacies of your database structure with our enhanced ER Diagram. Experience an interactive representation of your database's relationships and dependencies, making comprehension and optimization more intuitive than ever.
## Why ScanQL?
+ Holistic View: Go beyond traditional data views and understand your database from a macro and micro perspective.
+ Empowered Decision Making: Make informed decisions about schema changes, indexing, and more based on the insights ScanQL offers.
+ Automated Tests: Without writing a single line of SQL, get performance metrics on commonly used SELECT and UPDATE queries as soon as you connect your database
## How ScanQL Works
+ Visualizing the Database: Simply connect to your database by submitting your URI connection string for your Postgres database, and our tool will automatically provide you with an overview of the composition of your database, a detailed analysis of its size through various metrics, past performance analysis of quiries run on your database (Note: limited for unpaid versions of postgres databases), and also map out the database structure in the ERD tab, providing a visual representation of tables, relations, and more.
+ Performing Query Tests: ScanQL will run a series of generic SELECT and UPDATE queries on each table in your database to determine planning and execution times. This provides a baseline understanding of how optimized your current setup is.
+ Custom Query Testing: Input any query of your choice and get a comprehensive analysis of the performance of running that query. Understand metrics such as time taken, caching details, the type of scan used, and the number of rows hit. This deep dive enables fine-tuning and precise optimization of your database queries
\*\*Note\*\*
- **PostgreSQL Database Provider Access:** Ensure you have the appropriate permissions with your PostgreSQL database provider. Some metrics might be restricted depending on the access
level you have.
- **pg_stats:** If you are leveraging `pg_stats` for metrics, you may need additional privileges or access rights. Check with your PostgreSQL database provider or your system
administrator for assistance.
If you encounter any issues or need more information, consult your PostgreSQL documentation or feel free to reach out to us!
## Privacy & Security
At ScanQL, your privacy and security are paramount:
+ No Storage of URI Strings: We understand the significance of database URIs. ScanQL is designed to never store or cache your database URI strings, ensuring they remain confidential.
+ Data Privacy: Personal data and database contents remain entirely within your domain. ScanQL does not store, share, or transmit your data.
+ Secure Analysis: The metrics and insights provided by ScanQL are processed securely without any external sharing or storage. Our commitment is to offer optimization insights without compromising on security.
## Contributing
We welcome contributions! If you find a bug or want to propose a feature, feel free to open an issue or create a pull request.
## License
ScanQL is licensed under the MIT License. See LICENSE.md for more details.
## Authors
| Developed By | Github |
| :-: | :-: |
| Daniel Kim |[](https://github.com/danykdev)
| Sam Heck |[](https://github.com/Sam-Heck)
| Yahya Talab |[](https://github.com/YahyaT95)
| Danny Murcia |[](https://github.com/dm2800)
| Kurt Bulau |[](https://github.com/kbulau)
[contributors-shield]: https://img.shields.io/github/contributors/oslabs-beta/ScanQL.svg?style=for-the-badge
[contributors-url]: https://github.com/oslabs-beta/ScanQL/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/oslabs-beta/ScanQL.svg?style=for-the-badge
[forks-url]: https://github.com/oslabs-beta/ScanQL/network/members
[stars-shield]: https://img.shields.io/github/stars/oslabs-beta/ScanQL.svg?style=for-the-badge
[stars-url]: https://github.com/oslabs-beta/ScanQL/stargazers
[issues-shield]: https://img.shields.io/github/issues/oslabs-beta/ScanQL.svg?style=for-the-badge
[issues-url]: https://github.com/oslabs-beta/ScanQL/issues
[license-shield]: https://img.shields.io/github/license/oslabs-beta/ScanQL.svg?style=for-the-badge
[license-url]: https://github.com/oslabs-beta/ScanQLr/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/company/scanql/