Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/guanguans/think-soar

SQL optimizer and rewriter extension package for thinkphp5/6 framework.
https://github.com/guanguans/think-soar

debug mysql soar sql

Last synced: 14 days ago
JSON representation

SQL optimizer and rewriter extension package for thinkphp5/6 framework.

Host: GitHub
URL: https://github.com/guanguans/think-soar
Owner: guanguans
License: mit
Created: 2019-07-06T09:21:55.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2022-05-25T10:17:36.000Z (over 2 years ago)
Last Synced: 2024-07-19T01:01:42.516Z (4 months ago)
Topics: debug, mysql, soar, sql
Language: PHP
Homepage: https://www.guanguans.cn/think-soar
Size: 1.43 MB
Stars: 80
Watchers: 3
Forks: 16
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        
think-soar


> ！本项目不再维护，如果有人愿意接手维护可以联系我。

SQL 语句优化器和重写器


![](docs/usage.gif)

> 适用于 thinkphp5 SQL 语句优化器扩展包，基于 **[guanguans/soar-php](https://github.com/guanguans/soar-php)**

[![Build Status](https://travis-ci.org/guanguans/think-soar.svg?branch=master)](https://travis-ci.org/guanguans/think-soar)

[![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)

[![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)

[![StyleCI](https://github.styleci.io/repos/195521139/shield?branch=master)](https://github.styleci.io/repos/195521139)

[![Latest Stable Version](https://poser.pugx.org/guanguans/think-soar/v/stable)](https://packagist.org/packages/guanguans/think-soar)

[![Total Downloads](https://poser.pugx.org/guanguans/think-soar/downloads)](https://packagist.org/packages/guanguans/think-soar)

[![License](https://poser.pugx.org/guanguans/think-soar/license)](https://packagist.org/packages/guanguans/think-soar)

## 环境要求

* [topthink/framework >= 5.1](https://github.com/top-think/framework)

## 安装

``` shell

$ composer require guanguans/think-soar --dev

```

## 使用

### 下载 [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)

``` bash

# macOS

$ wget https://github.com/XiaoMi/soar/releases/download/0.11.0/soar.darwin-amd64

# linux

$ wget https://github.com/XiaoMi/soar/releases/download/0.11.0/soar.linux-amd64

# windows

$ wget https://github.com/XiaoMi/soar/releases/download/0.11.0/soar.windows-amd64

# 用其他命令或下载器下载均可以

```

### 配置，更多详细配置请参考 [soar config](https://github.com/XiaoMi/soar/blob/master/doc/config.md)

拷贝 `config\soar.php` 到 `thinkphp` 配置目录下，修改对应的配置，并设置 `thinkphp` 的 `app_debug`、`trace` 配置为 true 。

### SQL 评分

**方法调用示例：**

``` php

where('id', 1)->select();

        $sql = Db::table('fa_user')->fetchSql()->select();

        // 最后一条sql语句评分

        echo soar_score();

        // 指定sql语句评分

        echo soar_score($sql);

        echo soar()->score($sql);

    }

}

```

**输出结果：**

![](docs/score.png)

### explain 信息解读

**方法调用示例：**

``` php

where('id', 1)->select();

        $sql = Db::table('fa_user')->fetchSql()->select();

        // 最后一条sql语句explain信息解读

        echo soar_html_explain();

        echo soar_md_explain();

        // 指定sql语句评分explain信息解读

        echo soar_html_explain($sql);

        echo soar_md_explain($sql);

        echo soar()->htmlExplain($sql);

        echo soar()->mdExplain($sql);

    }

}

```

**输出结果：**

![](docs/explain.png)

### 语法检查

**方法调用示例：**

``` php

$sql = 'selec * from fa_user';

echo soar_syntax_check();

echo soar_syntax_check($sql);

echo soar()->syntaxCheck($sql);

```

**输出结果：**

``` sql

At SQL 1 : line 1 column 5 near "selec * from fa_user" (total length 20)

```

### SQL 指纹

**方法调用示例：**

``` php

$sql = 'select * from fa_user where id=1';

echo soar_finger_print();

echo soar_finger_print($sql);

echo soar()->fingerPrint($sql);

```

**输出结果：**

``` sql

select * from fa_user where id = ?

```

### SQL 美化

**方法调用示例：**

``` php

$sql = 'select * from fa_user where id=1';

var_dump(soar_pretty());

var_dump(soar_pretty($sql));

var_dump(soar()->pretty($sql));

```

**输出结果：**

``` sql

SELECT  

  * 

FROM  

  fa_user  

WHERE  

  id  = 1;

```

### markdown 转化为 html

**方法调用示例：**

``` php

echo soar_md2html("## 这是一个测试");

echo soar()->md2html("## 这是一个测试");

```

**输出结果：**

``` html

...

这是一个测试

...

```

### soar 帮助

**方法调用示例：**

``` php

var_dump(soar_help());

var_dump(soar()->help());

```

**输出结果：**

``` yaml

···

'Usage of /Users/yaozm/Documents/wwwroot/soar-php/soar:

  -allow-charsets string

    	AllowCharsets (default "utf8,utf8mb4")

  -allow-collates string

    	AllowCollates

  -allow-drop-index

    	AllowDropIndex, 允许输出删除重复索引的建议

  -allow-engines string

    	AllowEngines (default "innodb")

  -allow-online-as-test

    	AllowOnlineAsTest, 允许线上环境也可以当作测试环境

  -blacklist string

    	指定 blacklist 配置文件的位置，文件中的 SQL 不会被评审。

···    

```

### 执行任意 soar 命令

**方法调用示例：**

``` php

$command = "echo '## 这是另一个测试' | /Users/yaozm/Documents/wwwroot/soar-php/soar.darwin-amd64 -report-type md2html";

echo soar_exec($command);

echo soar()->exec($command);

```

**输出结果：**

``` html

...

这是另一个测试

...

```

## License

[MIT](LICENSE)