Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cookiey/yearning
🐳 A most popular sql audit platform for mysql
https://github.com/cookiey/yearning
devops go golang mysql mysql-web-sql sql sql-audit yearning
Last synced: about 2 months ago
JSON representation
🐳 A most popular sql audit platform for mysql
- Host: GitHub
- URL: https://github.com/cookiey/yearning
- Owner: cookieY
- License: agpl-3.0
- Created: 2017-10-18T14:08:50.000Z (almost 7 years ago)
- Default Branch: next
- Last Pushed: 2024-07-29T07:11:15.000Z (about 2 months ago)
- Last Synced: 2024-07-31T22:35:04.027Z (about 2 months ago)
- Topics: devops, go, golang, mysql, mysql-web-sql, sql, sql-audit, yearning
- Language: Go
- Homepage: http://next.yearning.io/
- Size: 427 MB
- Stars: 8,403
- Watchers: 239
- Forks: 1,979
- Open Issues: 120
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Yearning
Simple, Efficient and MYSQL-Like
Seamlessly integrates SQL detection and query auditing, tailored for the use of DBAs and developers.
A locally deployed, privacy-focused, simple and efficient for MYSQL audit platform.
?style=flat-square&logoColor=white&logo=linux)
[](https://www.murphysec.com/dr/nDuoncnUbuFMdrZsh7)
[](https://github.com/cookieY/Yearning/releases/latest)
English | [简体中文](README.zh-CN.md)
## Feature
- **AI Assistant** — Our AI assistant provides real-time SQL optimization suggestions, helping users to optimize SQL
statements for better performance. The AI assistant also provides text to SQL conversion, allowing users to input
- **SQL Audit** — Support the creation of SQL audit tickets with approval workflows and automated syntax checkers to
validate submitted SQL statements for correctness, security, and compliance. Automatically generate rollback
statements corresponding to the submitted DDL/DML operations for easy recovery when needed. Maintain a comprehensive
history log of all SQL audit operations for traceability and auditing purposes.
- **Query Audit** — Our solution supports auditing of user query statements, including restrictions on data sources and
databases, as well as anonymization of sensitive fields. Query records are also saved for future reference.
- **Check Rules** — The automated syntax checker supports dozens of check rules, catering to most of the automatic
checking scenarios.
- **Privacy focussed** - Locally deployable and open-source solution ensures the security of your database and SQL
statements. In addition to providing control over the infrastructure, the solution also includes encryption mechanisms
to protect sensitive data before storing it in your database. This ensures that even if there is unauthorized access
to the database, the encrypted data remains secure and unreadable. By combining local deployment, open-source
transparency, and data encryption, we prioritize the privacy and security of your database and SQL statements.
- **RBAC** - In our platform, you can create and manage different roles and assign specific permissions to each role.
This allows you to restrict users' access to query work orders, auditing functions, and other sensitive operations
based on their assigned roles.
## Docs
[Yearning Docs](https://next.yearning.io) only Chinese
## Install
[Download](https://github.com/cookieY/Yearning/releases/latest) the latest release and extract it.
**First make sure you have configured ./config.toml**
#### Manual
```bash
## init database
./Yearning install
## start
./Yearning run
## help
./Yearning --help
```
**Yes, it's that simple**
#### Docker
```bash
## init database
docker run --rm -it -p8000:8000 -e SECRET_KEY=$SECRET_KEY -e MYSQL_USER=$MYSQL_USER -e MYSQL_ADDR=$MYSQL_ADDR -e MYSQL_PASSWORD=$MYSQL_PASSWORD -e MYSQL_DB=$Yearning_DB yeelabs/yearning "/opt/Yearning install"
## You must initialize your database in the startup container
docker run -d -it -p8000:8000 -e SECRET_KEY=$SECRET_KEY -e MYSQL_USER=$MYSQL_USER -e MYSQL_ADDR=$MYSQL_ADDR -e MYSQL_PASSWORD=$MYSQL_PASSWORD -e MYSQL_DB=$Yearning_DB yeelabs/yearning
```
## Recommend
[Spug - 开源轻量自动化运维平台](https://github.com/openspug/spug)
AI Advise
Implementation of SQL statement optimization suggestions and Text 2 SQL features based on a large language model
By default or custom prompt words, AI Assistant can help users optimize SQL statements for better performance. At the same time, the AI assistant also provides text to SQL conversion feat.
Automatic SQL Checker
The SQL statement detection function tests against predefined rules and syntax
we can set predefined rules to check whether the SQL statement conforms to specific coding standards, best practices or security requirements.
SQL syntax highlighting and Auto-completion
SQL syntax highlighting and auto-completion features to enhance the user experience and improve query writing efficiency.
SQL syntax highlighting helps users visually distinguish different parts of the SQL query, such as keywords, table names, column names, and operators. This makes it easier to read and understand the query structure.
Order/Query record
Supports auditing of user order/query statements
Through the auditing feature, you can track and record all query operations, including the data source, database, and handling of sensitive fields. This ensures that query operations comply with regulations and allows for tracing query history.
## Ecosystem
[Gemini](https://github.com/cookieY/gemini-next) Yearning front-end Project
[Yee](https://github.com/cookieY/yee) Yearning web framework
## Contact Us
E-mail: [email protected]
## License
See [LICENSE](LICENSE) for details.
2023 © Henry Yee