{"id":29571882,"url":"https://github.com/oceanbase/sql-lifecycle-management","last_synced_at":"2025-07-19T04:36:29.417Z","repository":{"id":165486667,"uuid":"640851320","full_name":"oceanbase/sql-lifecycle-management","owner":"oceanbase","description":"SQL-Lifecycle-Management is an intelligent diagnosis and optimization product focusing on the SQL field.","archived":false,"fork":false,"pushed_at":"2024-05-03T20:08:22.000Z","size":8477,"stargazers_count":64,"open_issues_count":1,"forks_count":14,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-05-03T21:28:11.621Z","etag":null,"topics":["database","mysql","oceanbase","optimization","parser","python","sql"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oceanbase.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-15T09:02:44.000Z","updated_at":"2024-03-17T14:44:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"ed0eefa3-a61a-4cc6-9ce3-74ba9a94f605","html_url":"https://github.com/oceanbase/sql-lifecycle-management","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/oceanbase/sql-lifecycle-management","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Fsql-lifecycle-management","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Fsql-lifecycle-management/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Fsql-lifecycle-management/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Fsql-lifecycle-management/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oceanbase","download_url":"https://codeload.github.com/oceanbase/sql-lifecycle-management/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oceanbase%2Fsql-lifecycle-management/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265889158,"owners_count":23844539,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","mysql","oceanbase","optimization","parser","python","sql"],"created_at":"2025-07-19T04:36:28.692Z","updated_at":"2025-07-19T04:36:29.409Z","avatar_url":"https://github.com/oceanbase.png","language":"Python","readme":"# SQL-Lifecycle-Management\n\nEnglish | [简体中文](README_CN.md)\n\n![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)\n![pyversions](https://img.shields.io/badge/python%20-3.6.3%2B-blue.svg)\n[![Github stars](https://img.shields.io/github/stars/oceanbase/sql-lifecycle-management?style=flat-square)](https://github.com/oceanbase/sql-lifecycle-management)\n[![OpenIssue](https://img.shields.io/github/issues/oceanbase/sql-lifecycle-management)](https://github.com/oceanbase/sql-lifecycle-management/issues)\n\n``SQL-Lifecycle-Management`` is a SQL lifecycle management product hatched from the Ant group, providing SQL closed-loop capabilities throughout all stages of develop, integration, operation and maintenance, and continuous optimization.\n\n# Main Features\n\n- SQL Optimization：Support SQL optimization, provide index suggestion, PMD suggestion, rewrite and other capabilities\n- SQL Review：Support SQL Review of multiple ORM framework\n- Slow log Analysis：Support Slow log analysis\n- SQL Monitor：Provides SQL monitoring services of different engines, collects SQL, Plan, Catalog, Statistics and other data to help developers analyze SQL problems in real time\n\n# Currently Supported Database Engine\n\n- OceanBase(MySQL Mode)\n- MySQL\n\n# Quick Start\n\n## Local installation\n\n- prerequisites: recommended python == v3.8 (tested on 3.8)\nIt is recommended to use [conda](https://github.com/conda/conda) to create virtual environment\n\n```shell\nconda create --name slm_3.8 python=3.8\nconda activate slm_3.8\n```\n\n- install\n\n```shell\ngit clone https://github.com/oceanbase/sql-lifecycle-management.git\n\ncd sql-lifecycle-management \u0026\u0026 make install\n```\n\n- meta database config\n\n```shell\ncd sql-lifecycle-management \u0026\u0026 vim db.cfg\n```\n\n- meta database schema init\n\n```shell\nmysql -h host_ip -u user_name -p\nsource init/init.sql\n```\n\n- visit web\n\n```shell\ncd sql-lifecycle-management \u0026\u0026 sh ./start.sh\n```\n\nvisit \u003chttp://localhost:8989\u003e\n\n## Deploy with docker\n\n- build\n\n```shell\ngit clone https://github.com/oceanbase/sql-lifecycle-management.git\ncd sql-lifecycle-management\ndocker build -t \u003cyour_tag\u003e .\n```\n\n- run\n\n```shell\ndocker run -itd -p 8989:8989 \u003cimage_id\u003e /bin/bash\ndocker exec -it \u003ccontainer_id\u003e /bin/bash\n```\n\n- meta database config\n\n```shell\n# in docker\nvim db.cfg\n```\n\n- meta database init\n\n```shell\nmysql -h host_ip -u user_name -p\nsource init/init.sql\n```\n\nIf you don't have an existing metabase. you can also install mysql service locally using Docker\n\n```shell\ndocker run --name=mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=\u003cyour_password\u003e -dit mysql:latest\n```\n\n- visit web\n\n```shell\nsh ./start.sh\n```\n\nvisit \u003chttp://localhost:8989\u003e\n\n# Configuration\n\nPlease refer to the [Configuration Guide](https://github.com/oceanbase/sql-lifecycle-management/blob/main/CONTRIBUTING.md) for an overview on how to configure SQL-Lifecycle-Management.\npart guide：\n\n- [API Guide](https://github.com/oceanbase/sql-lifecycle-management/blob/main/docs/api-style-guide.md)\n- [Code Review Guide](https://github.com/oceanbase/sql-lifecycle-management/blob/main/docs/code-review-guide.md)\n- [Writing Guide](https://github.com/oceanbase/sql-lifecycle-management/blob/main/docs/writing-guide.md)\n\n# Roadmap\n\n- [ ] Database engine extension\n  - [x] OceanBase\n  - [x] MySQL\n  - [ ] PostgreSQL\n  - [ ] Oracle\n  - [ ] TiDB\n  - [ ] PolarDB\n- [x] Rule precipitation\n  - [x] SQL PMD\n  - [x] SQL Rewrite\n  - [x] Rule-Based Optimizer\n- [ ] Optimizer extension\n  - [x] Cost-Based Optimizer\n  - [ ] Support PLSQL\n  - [ ] Query-Based Workload Analysis\n  - [ ] Learning-Based Optimizer\n- [ ] ORM framework extension\n  - [x] MyBatis\n  - [ ] GORM\n  - [ ] Hibernate\n  - [ ] SQLAlchemy\n- [ ] Multi-cloud product access\n  - [ ] OceanBase Cloud\n  - [ ] Aliyun RDS\n  - [ ] TiCloud\n- [ ] SQL optimization plugin\n  - [ ] CICD product\n  - [ ] SQL Console product\n  - [ ] IDE plugin\n\n# License\n\n``SQL-Lifecycle-Management`` is licensed under [Apache - 2.0](https://github.com/oceanbase/sql-lifecycle-management/blob/main/LICENSE) License.\n\n# Contact Us\n\nDingTalk group: 33920014194\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foceanbase%2Fsql-lifecycle-management","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foceanbase%2Fsql-lifecycle-management","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foceanbase%2Fsql-lifecycle-management/lists"}