數據庫
由于大部分插件都會安裝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
{
/**
* The table associated with the model.
*
* @var string
*/
protected $table = 'foo_orders';
/**
* The primary key associated with the table.
*
* @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創(chuàng)建一個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
會自動創(chuàng)建foo插件,其中包含 plugin/foo/api/Install.php
和 plugin/foo/install.sql
。
提示
如果沒有生成install.sql文件請嘗試升級webman/console
,命令為composer require webman/console ^1.3.6
插件安裝時導入數據庫
安裝插件時會執(zhí)行Install.php里的install
方法,該方法會自動導入install.sql
里的sql語句,從而實現(xiàn)自動導入數據庫表的目的。
install.sql
文件內容是創(chuàng)建數據庫表以及對表歷史修改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';
// ...
}
測試
執(zhí)行php webman app-plugin:install foo
安裝插件,然后查看數據庫,會發(fā)現(xiàn)foo_orders
和foo_goods
表已經創(chuàng)建了。
插件升級時更改表結構
有時候插件升級需要新建表或更改表結構,可以直接在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 '狀態(tài)';
升級時會執(zhí)行Install.php里的update
方法,該方法同樣會執(zhí)行install.sql
里的語句,如果有新的語句會執(zhí)行新的語句,如果是舊的語句會跳過,從而實現(xiàn)升級對數據庫的修改。
卸載插件時刪除數據庫
卸載插件時Install.php
的uninstall
方法會被調用,它會自動分析install.sql
里有哪些建表語句,并自動刪除這些表,達到卸載插件時刪除數據庫表的目的。
如果想卸載時只想執(zhí)行自己的uninstall.sql
,不執(zhí)行自動的刪表操作,則只需要創(chuàng)建plugin/插件名/uninstall.sql
即可,這樣uninstall
方法只會執(zhí)行uninstall.sql
文件里的語句。