Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 5 days 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 (about 7 years ago)
Default Branch: next
Last Pushed: 2024-10-28T06:06:37.000Z (about 2 months ago)
Last Synced: 2024-10-29T10:51:29.365Z (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,501
Watchers: 233
Forks: 1,989
Open Issues: 132
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        




    Yearning






 A robust, locally deployed platform designed for seamless SQL detection and query auditing, tailored specifically for DBAs and developers. Focused on privacy and efficiency, it provides an intuitive and secure environment for MYSQL auditing.

---

[![OSCS Status](https://www.oscs1024.com/platform/badge/cookieY/Yearning.svg?size=small)](https://www.murphysec.com/dr/nDuoncnUbuFMdrZsh7)

![Platform Support](https://img.shields.io/badge/-x86_x64%20ARM%20Supports%20%E2%86%92-rgb(84,56,255)?style=flat-square&logoColor=white&logo=linux)

[![][github-license-shield]][github-license-link]

![GitHub top language](https://img.shields.io/github/languages/top/cookieY/Yearning?color=369eff&label=golang&labelColor=black&logo=golang&logoColor=white&style=flat-square)

[![][github-forks-shield]][github-forks-link]

[![][github-stars-shield]][github-stars-link]

[![Downloads](https://img.shields.io/github/downloads/cookieY/Yearning/total?labelColor=black&logo=download&logoColor=white&style=flat-square)](https://github.com/cookieY/Yearning/releases/latest)

English | [简体中文](README.zh-CN.md)

## ✨ Features

- **AI Assistant**: Our AI assistant offers real-time SQL optimization suggestions, enhancing SQL performance. It also supports text-to-SQL conversion, allowing users to input natural language and receive optimized SQL statements.

  

- **SQL Audit**: Create SQL audit tickets with approval workflows and automated syntax checks. Validate SQL statements for correctness, security, and compliance. Rollback statements are automatically generated for DDL/DML operations, with a comprehensive history log for traceability.

- **Query Audit**: Audit user queries, restrict data sources and databases, and anonymize sensitive fields. Query records are saved for future reference.

- **Check Rules**: Our automated syntax checker supports a wide range of check rules, suitable for most automatic checking scenarios.

- **Privacy Focused**: Yearning is a locally deployable, open-source solution that ensures the security of your database and SQL statements. It includes encryption mechanisms to protect sensitive data, ensuring it remains secure even if unauthorized access occurs.

- **RBAC (Role-Based Access Control)**: Create and manage roles with specific permissions, restricting access to query work orders, auditing functions, and other sensitive operations based on user roles.

> \[!TIP]

> For more detailed information, visit our [Yearning Guide](https://next.yearning.io)

## ⚙️ Installation

Download the [latest release](https://github.com/cookieY/Yearning/releases/latest) and extract it. Ensure you have configured `./config.toml` before proceeding.

### Manual Installation

```bash

## Initialize the database

./Yearning install

## Start Yearning

./Yearning run

## Help

./Yearning --help

```

### 🚀 Deploying with Docker

[![][docker-release-shield]][docker-release-link]

[![][docker-size-shield]][docker-size-link]

[![][docker-pulls-shield]][docker-pulls-link]

```bash

## Initialize the 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 -e Y_LANG=zh_CN yeelabs/yearning "/opt/Yearning install"

## Start Yearning

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 -e Y_LANG=zh_CN yeelabs/yearning

```

## 🤖 AI Assistance

Our AI Assistant leverages a large language model to provide SQL optimization suggestions and text-to-SQL conversion. Whether using default or custom prompts, the AI Assistant enhances SQL performance by optimizing statements and converting natural language inputs into SQL queries.

![Text to SQL](img/text2sql.jpg)

## 🔖 Automatic SQL Checker

The automatic SQL checker evaluates SQL statements against predefined rules and syntax. It ensures that statements adhere to specific coding standards, best practices, and security requirements, providing a robust layer of validation.

![SQL Audit](img/audit.png)

## 💡 SQL Syntax Highlighting and Auto-completion

Enhance your query writing efficiency with SQL syntax highlighting and auto-completion. These features help users visually distinguish different components of a SQL query, such as keywords, table names, column names, and operators, making it easier to read and understand the query structure.

![SQL Query](img/query.png)

## ⏺️ Order/Query Record

Our platform supports the auditing of user order and query statements. This feature allows you to track and record all query operations, including data sources, databases, and the handling of sensitive fields, ensuring compliance with regulations and providing traceability for query history.

![Order/Query Record](img/record.png)

By focusing on these key features, Yearning enhances user experience, optimizes SQL performance, and ensures robust compliance and traceability in database operations.

## 🛠️ Recommended Tools

- [Spug - Open Source Lightweight Automation Operations Platform](https://github.com/openspug/spug)

## ☎️ Contact

For inquiries, please email us at: [email protected]

## 📋 License

Yearning is licensed under the AGPL license. See [LICENSE](LICENSE) for details.

2024 © Henry Yee

---

With Yearning, experience a streamlined, secure, and efficient approach to SQL auditing and optimization.

[docker-pulls-link]: https://hub.docker.com/r/yeelabs/yearning

[docker-pulls-shield]: https://img.shields.io/docker/pulls/yeelabs/yearning?color=45cc11&labelColor=black&style=flat-square

[docker-release-link]: https://hub.docker.com/r/yeelabs/yearning

[docker-release-shield]: https://img.shields.io/docker/v/yeelabs/yearning?color=369eff&label=docker&labelColor=black&logo=docker&logoColor=white&style=flat-square

[docker-size-link]: https://hub.docker.com/r/yeelabs/yearning

[docker-size-shield]: https://img.shields.io/docker/image-size/yeelabs/yearning?color=369eff&labelColor=black&style=flat-square

[github-forks-shield]: https://img.shields.io/github/forks/cookieY/Yearning?color=8ae8ff&labelColor=black&style=flat-square

[github-forks-link]: https://github.com/cookieY/Yearning/network/members

[github-stars-link]: https://github.com/cookieY/Yearning/network/stargazers

[github-stars-shield]: https://img.shields.io/github/stars/cookieY/Yearning?color=ffcb47&labelColor=black&style=flat-square

[github-license-link]: https://github.com/cookieY/Yearning/blob/main/LICENSE

[github-license-shield]: https://img.shields.io/badge/AGPL%203.0-white?labelColor=black&style=flat-square