{"id":18010803,"url":"https://github.com/guanguans/think-soar","last_synced_at":"2025-03-26T14:32:14.933Z","repository":{"id":35002573,"uuid":"195521139","full_name":"guanguans/think-soar","owner":"guanguans","description":"SQL optimizer and rewriter extension package for thinkphp5/6 framework.","archived":false,"fork":false,"pushed_at":"2022-05-25T10:17:36.000Z","size":1503,"stargazers_count":80,"open_issues_count":1,"forks_count":16,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-18T07:47:51.283Z","etag":null,"topics":["debug","mysql","soar","sql"],"latest_commit_sha":null,"homepage":"https://www.guanguans.cn/think-soar","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/guanguans.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"patreon":"guanguans","custom":"https://www.guanguans.cn/images/wechat.jpeg"}},"created_at":"2019-07-06T09:21:55.000Z","updated_at":"2024-02-16T17:17:33.000Z","dependencies_parsed_at":"2022-08-19T09:11:44.767Z","dependency_job_id":null,"html_url":"https://github.com/guanguans/think-soar","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guanguans%2Fthink-soar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guanguans%2Fthink-soar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guanguans%2Fthink-soar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guanguans%2Fthink-soar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guanguans","download_url":"https://codeload.github.com/guanguans/think-soar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245670895,"owners_count":20653447,"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":["debug","mysql","soar","sql"],"created_at":"2024-10-30T02:15:23.994Z","updated_at":"2025-03-26T14:32:14.592Z","avatar_url":"https://github.com/guanguans.png","language":"PHP","funding_links":["https://patreon.com/guanguans","https://www.guanguans.cn/images/wechat.jpeg"],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003ethink-soar\u003c/h1\u003e\n\n\u003e ！本项目不再维护，如果有人愿意接手维护可以联系我。\n\n\u003cp align=\"center\"\u003eSQL 语句优化器和重写器\u003c/p\u003e\n\n![](docs/usage.gif)\n\n\u003e 适用于 thinkphp5 SQL 语句优化器扩展包，基于 **[guanguans/soar-php](https://github.com/guanguans/soar-php)**\n\n[![Build Status](https://travis-ci.org/guanguans/think-soar.svg?branch=master)](https://travis-ci.org/guanguans/think-soar)\n[![Build Status](https://scrutinizer-ci.com/g/guanguans/think-soar/badges/build.png?b=master)](https://scrutinizer-ci.com/g/guanguans/think-soar/build-status/master)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/guanguans/think-soar/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/guanguans/think-soar/?branch=master)\n[![StyleCI](https://github.styleci.io/repos/195521139/shield?branch=master)](https://github.styleci.io/repos/195521139)\n[![Latest Stable Version](https://poser.pugx.org/guanguans/think-soar/v/stable)](https://packagist.org/packages/guanguans/think-soar)\n[![Total Downloads](https://poser.pugx.org/guanguans/think-soar/downloads)](https://packagist.org/packages/guanguans/think-soar)\n[![License](https://poser.pugx.org/guanguans/think-soar/license)](https://packagist.org/packages/guanguans/think-soar)\n\n## 环境要求\n\n* [topthink/framework \u003e= 5.1](https://github.com/top-think/framework)\n\n## 安装\n\n``` shell\n$ composer require guanguans/think-soar --dev\n```\n\n## 使用\n\n### 下载 [XiaoMi](https://github.com/XiaoMi/) 开源的 SQL 优化器 [soar](https://github.com/XiaoMi/soar/releases)，更多详细安装请参考 [soar install](https://github.com/XiaoMi/soar/blob/master/doc/install.md)\n\n``` bash\n# macOS\n$ wget https://github.com/XiaoMi/soar/releases/download/0.11.0/soar.darwin-amd64\n# linux\n$ wget https://github.com/XiaoMi/soar/releases/download/0.11.0/soar.linux-amd64\n# windows\n$ wget https://github.com/XiaoMi/soar/releases/download/0.11.0/soar.windows-amd64\n# 用其他命令或下载器下载均可以\n```\n\n### 配置，更多详细配置请参考 [soar config](https://github.com/XiaoMi/soar/blob/master/doc/config.md)\n\n拷贝 `config\\soar.php` 到 `thinkphp` 配置目录下，修改对应的配置，并设置 `thinkphp` 的 `app_debug`、`trace` 配置为 true 。\n\n### SQL 评分\n\n**方法调用示例：**\n\n``` php\n\u003c?php\nnamespace app\\index\\controller;\n\nuse think\\Db;\n\nclass Index\n{\n    public function tests()\n    {\n        $user = Db::table('fa_user')-\u003ewhere('id', 1)-\u003eselect();\n        $sql = Db::table('fa_user')-\u003efetchSql()-\u003eselect();\n        // 最后一条sql语句评分\n        echo soar_score();\n        // 指定sql语句评分\n        echo soar_score($sql);\n        echo soar()-\u003escore($sql);\n    }\n}\n```\n\n**输出结果：**\n\n![](docs/score.png)\n\n### explain 信息解读\n\n**方法调用示例：**\n\n``` php\n\u003c?php\nnamespace app\\index\\controller;\n\nuse think\\Db;\n\nclass Index\n{\n    public function tests()\n    {\n        $user = Db::table('fa_user')-\u003ewhere('id', 1)-\u003eselect();\n        $sql = Db::table('fa_user')-\u003efetchSql()-\u003eselect();\n        // 最后一条sql语句explain信息解读\n        echo soar_html_explain();\n        echo soar_md_explain();\n        // 指定sql语句评分explain信息解读\n        echo soar_html_explain($sql);\n        echo soar_md_explain($sql);\n        echo soar()-\u003ehtmlExplain($sql);\n        echo soar()-\u003emdExplain($sql);\n    }\n}\n```\n\n**输出结果：**\n\n![](docs/explain.png)\n\n### 语法检查\n\n**方法调用示例：**\n\n``` php\n$sql = 'selec * from fa_user';\necho soar_syntax_check();\necho soar_syntax_check($sql);\necho soar()-\u003esyntaxCheck($sql);\n```\n\n**输出结果：**\n\n``` sql\nAt SQL 1 : line 1 column 5 near \"selec * from fa_user\" (total length 20)\n```\n\n### SQL 指纹\n\n**方法调用示例：**\n\n``` php\n$sql = 'select * from fa_user where id=1';\necho soar_finger_print();\necho soar_finger_print($sql);\necho soar()-\u003efingerPrint($sql);\n```\n\n**输出结果：**\n\n``` sql\nselect * from fa_user where id = ?\n```\n\n### SQL 美化\n\n**方法调用示例：**\n\n``` php\n$sql = 'select * from fa_user where id=1';\nvar_dump(soar_pretty());\nvar_dump(soar_pretty($sql));\nvar_dump(soar()-\u003epretty($sql));\n```\n\n**输出结果：**\n\n``` sql\nSELECT  \n  * \nFROM  \n  fa_user  \nWHERE  \n  id  = 1;\n```\n\n### markdown 转化为 html\n\n**方法调用示例：**\n\n``` php\necho soar_md2html(\"## 这是一个测试\");\necho soar()-\u003emd2html(\"## 这是一个测试\");\n```\n\n**输出结果：**\n\n``` html\n...\n\u003ch2\u003e这是一个测试\u003c/h2\u003e\n...\n```\n\n### soar 帮助\n\n**方法调用示例：**\n\n``` php\nvar_dump(soar_help());\nvar_dump(soar()-\u003ehelp());\n```\n\n**输出结果：**\n\n``` yaml\n···\n'Usage of /Users/yaozm/Documents/wwwroot/soar-php/soar:\n  -allow-charsets string\n    \tAllowCharsets (default \"utf8,utf8mb4\")\n  -allow-collates string\n    \tAllowCollates\n  -allow-drop-index\n    \tAllowDropIndex, 允许输出删除重复索引的建议\n  -allow-engines string\n    \tAllowEngines (default \"innodb\")\n  -allow-online-as-test\n    \tAllowOnlineAsTest, 允许线上环境也可以当作测试环境\n  -blacklist string\n    \t指定 blacklist 配置文件的位置，文件中的 SQL 不会被评审。\n···    \n```\n\n### 执行任意 soar 命令\n\n**方法调用示例：**\n\n``` php\n$command = \"echo '## 这是另一个测试' | /Users/yaozm/Documents/wwwroot/soar-php/soar.darwin-amd64 -report-type md2html\";\necho soar_exec($command);\necho soar()-\u003eexec($command);\n```\n\n**输出结果：**\n\n``` html\n...\n\u003ch2\u003e这是另一个测试\u003c/h2\u003e\n...\n```\n\n## License\n\n[MIT](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguanguans%2Fthink-soar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguanguans%2Fthink-soar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguanguans%2Fthink-soar/lists"}