set_connection($connection)
set_connection 方法为所有方法设定预设 DBUtil 连线。
静态 | 是 | ||||||
---|---|---|---|---|---|---|---|
参数 |
| ||||||
回传 | 回传受影响的列数。 | ||||||
抛出 | \Database_Exception 在失败时 | ||||||
範例 |
|
DBUtil 类别能让你对资料库做管理和执行例行操作。
DBUtil 能让你建立、更名、改变和除去资料库栏位。
set_connection 方法为所有方法设定预设 DBUtil 连线。
静态 | 是 | ||||||
---|---|---|---|---|---|---|---|
参数 |
| ||||||
回传 | 回传受影响的列数。 | ||||||
抛出 | \Database_Exception 在失败时 | ||||||
範例 |
|
create_database 方法建立一个资料库,如果失败将抛出一个 Database_Exception。
静态 | 是 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||||||||
回传 | 回传受影响的列数。 | |||||||||||||||
抛出 | \Database_Exception 在失败时 | |||||||||||||||
範例 |
|
如果没有提供字符集,将退回到活动 db 群组的字符集。
drop_database 方法除去一个资料库,如果失败将抛出一个 Database_Exception。
静态 | 是 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||
回传 | 回传受影响的列数。 | |||||||||
抛出 | \Database_Exception 在失败时 | |||||||||
範例 |
|
table_exists 方法确认所给的资料表是否存在。
静态 | 是 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||
回传 | 回传 true 如果资料表存在,false 如果不存在。 | |||||||||
範例 |
|
drop_table 方法除去一张资料表,如果失败将抛出一个 Database_Exception。
静态 | 是 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||
回传 | 回传受影响的列数。 | |||||||||
抛出 | \Database_Exception 在失败时 | |||||||||
範例 |
|
rename_table 方法更名一张资料表。
静态 | 是 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||
回传 | 回传受影响的列数。 | |||||||||
抛出 | \Database_Exception 在失败时 | |||||||||
範例 |
|
create_table 方法建立一张资料表。
静态 | 是 | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||||||||||||||||||||
回传 | 回传受影响的列数。 | |||||||||||||||||||||||||||
抛出 | \Database_Exception 在失败时 | |||||||||||||||||||||||||||
範例 |
| |||||||||||||||||||||||||||
可能的参数 |
|
预设栏位值预设情况下会被转义,在一些情况下你可能不想转义此值,如果是这样,你可以使用 DB::expr。
\DBUtil::create_table('users', array(
'id' => array('constraint' => 11, 'type' => 'int', 'auto_increment' => true),
'name' => array('type' => 'text'),
'email' => array('constraint' => 50, 'type' => 'varchar'),
'title' => array('constraint' => 50, 'type' => 'varchar', 'default' => 'mr.'),
'created' => array('type' => 'timestamp', 'default' => \DB::expr('CURRENT_TIMESTAMP')),
'password' => array('constraint' => 125, 'type' => 'varchar'),
), array('id'));
转义值也同样运作在 DBUtil::add_fields 和 DBUtil::modify_fields
field_exists 方法确认是否所给的栏位(们)在所给的资料表中存在。
静态 | 是 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | 回传 true 如果栏位/行存在,否则 false | ||||||||||||
範例 |
|
add_fields 方法添加栏位到资料表。
静态 | 是 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | 回传受影响的列数。 | ||||||||||||
抛出 | \Database_Exception 在失败时 | ||||||||||||
範例 |
|
drop_fields 方法从资料表除去栏位。
静态 | 是 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | 回传受影响的列数。 | ||||||||||||
抛出 | \Database_Exception 在失败时 | ||||||||||||
範例 |
|
modify_fields 方法修改在资料表中的栏位。
静态 | 是 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | 回传受影响的列数。 | ||||||||||||
抛出 | \Database_Exception 在失败时 | ||||||||||||
範例 |
|
create_index 方法能让你在资料表建立次要索引。
静态 | 是 | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||||||||
回传 | 回传资料库操作的结果。 | ||||||||||||||||||
抛出 | \Database_Exception 在失败时 | ||||||||||||||||||
範例 |
|
drop_index 方法能让你从资料表除去次要索引。
静态 | 是 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
参数 |
| ||||||||||||
回传 | 回传资料库操作的结果。 | ||||||||||||
抛出 | \Database_Exception 在失败时 | ||||||||||||
範例 |
|
add_foreign_key 方法能让你在资料表建立后添加外键。
静态 | 是 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||
回传 | 回传资料库操作的结果。 | |||||||||
抛出 | \InvalidArgumentException 在无效输入时,\Database_Exception 在失败时 | |||||||||
範例 |
|
drop_foreign_key 方法能让你从资料表除去外键。
静态 | 是 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||
回传 | 回传资料库操作的结果。 | |||||||||
抛出 | \Database_Exception 在失败时 | |||||||||
範例 |
|
truncate_table 方法截断一张资料表。
静态 | 是 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||
回传 | 回传受影响的列数。 | |||||||||
抛出 | \Database_Exception 当不支援时 | |||||||||
範例 |
|
analyze_table 分析一张资料表。
静态 | 是 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||
回传 | True 如果资料表是 OK 的。False 当需要注意时。如果不支援它会记录错误讯息。 | |||||||||
範例 |
|
check_table 方法确认一张资料表。
静态 | 是 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||
回传 | True 如果资料表是 OK 的。False 当需要注意时。如果不支援它会记录错误讯息。 | |||||||||
範例 |
|
optimize_table 方法优化一张资料表。
静态 | 是 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||
回传 | True 如果资料表是 OK 或已优化的。False 在失败时。如果不支援或失败它会记录错误讯息。 | |||||||||
範例 |
|
repair_table 方法修复一张资料表。
静态 | 是 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
参数 |
| |||||||||
回传 | True 如果资料表是 OK 或已修复的。false 在失败时。如果不支援或失败它会记录错误讯息。 | |||||||||
範例 |
|