資料庫

由於大部分插件都會安裝 webman-admin，所以建議直接重用 webman-admin 的資料庫配置。

模型基類使用 plugin\admin\app\model\Base 則會自動使用 webman-admin 的資料庫配置。

<?php

namespace plugin\foo\app\model;

use plugin\admin\app\model\Base;

class Orders extends Base
{
    /**
     * 與模型關聯的資料表。
     *
     * @var string
     */
    protected $table = 'foo_orders';

    /**
     * 與資料表關聯的主鍵。
     *
     * @var string
     */
    protected $primaryKey = 'id';

}

也可以通過 plugin.admin.mysql 操作 webman-admin 的資料庫，例如

Db::connection('plugin.admin.mysql')->table('user')->first();

使用自己的資料庫

插件也可以選擇使用自己的資料庫，例如 plugin/foo/config/database.php 內容如下

return  [
    'default' => 'mysql',
    'connections' => [
        'mysql' => [ // mysql 為連接名
            'driver'      => 'mysql',
            'host'        => '127.0.0.1',
            'port'        => 3306,
            'database'    => '資料庫',
            'username'    => '用戶名',
            'password'    => '密碼',
            'charset'     => 'utf8mb4',
            'collation'   => 'utf8mb4_general_ci',
        ],
        'admin' => [ // admin 為連接名
            'driver'      => 'mysql',
            'host'        => '127.0.0.1',
            'port'        => 3306,
            'database'    => '資料庫',
            'username'    => '用戶名',
            'password'    => '密碼',
            'charset'     => 'utf8mb4',
            'collation'   => 'utf8mb4_general_ci',
        ],
    ],
];

引用方式為 Db::connection('plugin.{插件}.{連接名}');，例如

use support\Db;
Db::connection('plugin.foo.mysql')->table('user')->first();
Db::connection('plugin.foo.admin')->table('admin')->first();

如果想使用主項目的資料庫，則直接使用即可，例如

use support\Db;
Db::table('user')->first();
// 假設主項目還配置了一個 admin 連接
Db::connection('admin')->table('admin')->first();

給 Model 配置資料庫

我們可以為 Model 創建一個 Base 類，Base 類用 $connection 指定插件自己的資料庫連接，例如

<?php

namespace plugin\foo\app\model;

use DateTimeInterface;
use support\Model;

class Base extends Model
{
    /**
     * @var string
     */
    protected $connection = 'plugin.foo.mysql';

}

這樣插件裡所有的 Model 繼承自 Base，就自動使用了插件自己的資料庫。

自動導入資料庫

運行 php webman app-plugin:create foo 會自動創建 foo 插件，其中包含 plugin/foo/api/Install.php 和 plugin/foo/install.sql。

提示
如果沒有生成 install.sql 文件請嘗試升級 webman/console，命令為 composer require webman/console ^1.3.6

插件安裝時導入資料庫

安裝插件時會執行 Install.php 裡的 install 方法，該方法會自動導入 install.sql 裡的 sql 語句，從而實現自動導入資料庫表的目的。

install.sql 文件內容是創建資料庫表以及對表歷史修改 sql 語句，注意每個語句必須用 ; 結束，例如

CREATE TABLE `foo_orders` (
  `id` int NOT NULL AUTO_INCREMENT COMMENT '主鍵',
  `order_id` varchar(50) NOT NULL COMMENT '訂單 id',
  `user_id` int NOT NULL COMMENT '用戶 id',
  `total_amount` decimal(10,2) NOT NULL COMMENT '須支付金額',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB COMMENT='訂單';

CREATE TABLE `foo_goods` (
  `id` int NOT NULL AUTO_INCREMENT COMMENT '主鍵',
  `name` varchar(50) NOT NULL COMMENT '名稱',
  `price` int NOT NULL COMMENT '價格',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB COMMENT='商品';

更改資料庫連接

install.sql 導入的目標資料庫默認為 webman-admin 的資料庫，如果想導入到其它資料庫，可以修改 Install.php 裡的 $connection 屬性，例如

<?php

class Install
{
    // 指定插件自己的資料庫
    protected static $connection = 'plugin.admin.mysql';

    // ...
}

測試

執行 php webman app-plugin:install foo 安裝插件，然後查看資料庫，會發現 foo_orders 和 foo_goods 表已經創建了。

插件升級時更改表結構

有時候插件升級需要新建表或更改表結構，可以直接在 install.sql 後面追加對應的語句即可，注意每個語句後面用 ; 結束，例如追加一個 foo_user 表以及給 foo_orders 表增加一個 status 欄位

CREATE TABLE `foo_orders` (
  `id` int NOT NULL AUTO_INCREMENT COMMENT '主鍵',
  `order_id` varchar(50) NOT NULL COMMENT '訂單 id',
  `user_id` int NOT NULL COMMENT '用戶 id',
  `total_amount` decimal(10,2) NOT NULL COMMENT '須支付金額',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB COMMENT='訂單';

CREATE TABLE `foo_goods` (
 `id` int NOT NULL AUTO_INCREMENT COMMENT '主鍵',
 `name` varchar(50) NOT NULL COMMENT '名稱',
 `price` int NOT NULL COMMENT '價格',
 PRIMARY KEY (`id`)
) ENGINE=InnoDB COMMENT='商品';

CREATE TABLE `foo_user` (
 `id` int NOT NULL AUTO_INCREMENT COMMENT '主鍵',
 `name` varchar(50) NOT NULL COMMENT '名字'
 PRIMARY KEY (`id`)
) ENGINE=InnoDB COMMENT='用戶';

ALTER TABLE `foo_orders` ADD `status` tinyint NOT NULL DEFAULT 0 COMMENT '狀態';

升級時會執行 Install.php 裡的 update 方法，該方法同樣會執行 install.sql 裡的語句，如果有新的語句會執行新的語句，如果是舊的語句會跳過，從而實現升級對資料庫的修改。

卸載插件時刪除資料庫

卸載插件時 Install.php 的 uninstall 方法會被調用，它會自動分析 install.sql 裡有哪些建表語句，並自動刪除這些表，達到卸載插件時刪除資料庫表的目的。
如果想卸載時只想執行自己的 uninstall.sql，不執行自動的刪表操作，則只需要創建 plugin/插件名/uninstall.sql 即可，這樣 uninstall 方法只會執行 uninstall.sql 文件裡的語句。