/includes/database.inc

Description
Functions
db_add_field (line 356)

添加字段

void db_add_field ( $table,  $field,  $spec, [ $keys_new = array()], [ $target = 'default'])
  • $table
  • $field
  • $spec
  • $keys_new
  • $target
db_add_foreign (line 416)

添加外键

void db_add_foreign ( $table,  $field,  $foreign, [ $target = 'default'])
  • $table
  • $field
  • $foreign
  • $target
db_add_index (line 452)

添加索引

void db_add_index ( $table,  $name,  $fields, [ $target = 'default'])
  • $table
  • $name
  • $fields
  • $target
db_add_primary (line 398)

添加主键

void db_add_primary ( $table,  $fields, [ $target = 'default'])
  • $table
  • $fields
  • $target
db_add_unique (line 434)

添加唯一值

void db_add_unique ( $table,  $name,  $fields, [ $target = 'default'])
  • $table
  • $name
  • $fields
  • $target
db_args_filter (line 99)

将参数中的数组分拆解析

  • access: public
void db_args_filter ( &$sql,  &$args, string $sql, array $args)
  • string $sql
  • array $args
  • &$sql
  • &$args
db_change_field (line 470)

更新字段

void db_change_field ( $table,  $field,  $field_new,  $spec, [ $keys_new = array()], [ $target = 'default'])
  • $table
  • $field
  • $field_new
  • $spec
  • $keys_new
  • $target
db_connect (line 32)

数据库连接

  • return: 根据连接参数调用相应的扩展文件,如:database.mysql.inc 连接成功,返回true,并将连接对象写入全局变量 $db。失败则返回 false
(bool) db_connect ([(string) $target = 'default'])
  • (string) $target: 连接参数,默认为 $database['default'] 中提供的信息
db_create_database (line 760)

创建一个数据库

  • global: $dbc $dbc:
  • access: public
bool db_create_database (string $database, [string $target = 'default'])
  • string $database: 数据库名称
  • string $target: 连接名称
db_create_table (line 282)

创建表

string|false db_create_table (string $name, string $table, [ $target = 'default'])
  • string $name: 数据表名称
  • string $table: 字段名称
  • $target
db_create_user (line 834)

创建一个数据库用户,并分配一个数据库全部权限

  • access: public
bool db_create_user (string $username, string $password, string $database, [string $host = '%'], [string $target = 'default'])
  • string $username: 用户名
  • string $password: 密码
  • string $target: 连接名称
  • string $database: 赋予指定数据库的全部权限
  • string $host: 允许的来源主机,默认为所有主机
db_debug (line 661)

在页脚显示查询语句

void db_debug ( $time)
  • $time
db_default_options (line 231)

检查属性中是否有链接信息

void db_default_options ([ $opt = array()])
  • array $opt
db_drop_database (line 787)

删除一个数据库

  • global: $dbc $dbc:
  • access: public
bool db_drop_database (string $database, [string $target = 'default'])
  • string $database: 表名
  • string $target: 连接名称
db_drop_field (line 365)

删除字段

void db_drop_field ( $table,  $field, [ $target = 'default'])
  • $table
  • $field
  • $target
db_drop_foreign (line 425)

删除外键

void db_drop_foreign ( $table,  $field,  $parent_table,  $parent_field, [ $target = 'default'])
  • $table
  • $field
  • $parent_table
  • $parent_field
  • $target
db_drop_index (line 461)

删除索引

void db_drop_index ( $table,  $name, [ $target = 'default'])
  • $table
  • $name
  • $target
db_drop_primary (line 407)

删除主键

void db_drop_primary ( $table, [ $target = 'default'])
  • $table
  • $target
db_drop_table (line 337)

删除数据表

  • global: $dbc $dbc:
  • access: public
bool db_drop_table (string $table, [string $target = 'default'])
  • string $table: 表名
  • string $target: 连接名称
db_drop_unique (line 443)

删除唯一值

void db_drop_unique ( $table,  $name, [ $target = 'default'])
  • $table
  • $name
  • $target
db_drop_user (line 861)

取消用户所有权限,并删除其帐号

  • access: public
bool db_drop_user (string $username, [string $target = 'default'])
  • string $username: 用户名
  • string $target: 连接名称
db_error (line 259)
void db_error ($code:错误代码 $code, $info:错误描述 $info)
  • $code:错误代码 $code
  • $info:错误描述 $info
db_exec (line 129)

insert、update、delete 推荐使用

  • return: 影响的列数
(int) db_exec ( $sql, [ $args = array()], [ $opt = array()], (string) $sql:语句,参数使用占位符, (array) $args:参数,对应语句中的占位符, (array) $opt:属性设置)
  • (string) $sql:语句,参数使用占位符
  • (array) $args:参数,对应语句中的占位符
  • (array) $opt:属性设置
  • $sql
  • $args
  • array $opt
db_field_drop_default (line 389)

删除字段默认值

void db_field_drop_default ( $table,  $field, [ $target = 'default'])
  • $table
  • $field
  • $target
db_field_set_default (line 380)

设置字段默认值

void db_field_set_default ($table $table, $field $field, $value $value, [ $target = 'default'])
  • $table $table: 表名
  • $field $field: 字段名
  • $value $value: 默认值
  • $target
db_get_placeholder (line 479)

数组解析为占位符

void db_get_placeholder ([ $array = array()])
  • $array
db_get_version (line 221)

获取数据库版本

void db_get_version ([ $target = 'default'])
  • $target
db_info (line 7)

数据库信息,扩展文件必须实现此接口

void db_info ()
db_is_database (line 742)

检查数据库是否存在

  • global: $dbc $dbc:
  • access: public
bool db_is_database (string $database, [string $target = 'default'])
  • string $database: 数据库名称
  • string $target: 连接名称
db_is_field (line 200)

检查字段是否存在

void db_is_field ( $table,  $field, [ $target = 'default'])
  • $table
  • $field
  • $target
db_is_table (line 187)

检查表是否存在

  • global: $dbc $dbc:
  • access: public
bool db_is_table (string $table, [string $target = 'default'])
  • string $table: 表名
  • string $target: 连接名称
db_is_user (line 811)

检查数据库用户是否存在

  • access: public
bool db_is_user (string $username, [string $target = 'default'])
  • string $username
  • string $target
db_last_insert_id (line 251)

获取最后一个自增主键

void db_last_insert_id ([ $target = 'default'])
  • $target
db_prefix_tables (line 242)

为查询语句中的表名加上前缀

void db_prefix_tables ( $sql,  $opt)
  • $sql
  • $opt
db_query (line 72)

select 推荐使用

  • return: array or string
object or db_query ( $sql, [ $args = array()], [ $opt = array()], (string) $sql:语句,参数使用占位符, (array) $args:参数,对应语句中的占位符, (array) $opt:属性设置)
  • (string) $sql:语句,参数使用占位符
  • (array) $args:参数,对应语句中的占位符
  • (array) $opt:属性设置:

    $opt['target']:选择数据库连接 $opt['fetch']:返回类型 object - PDO::FETCH_OBJ,默认 array - PDO::FETCH_ASSOC 或其它 PDOStatement::setFetchMode() 允许的参数

    $opt['return']:返回结果 object - PDOStatement->fetchAll(),默认 array - PDOStatement->fetch() column - PDOStatement->fetchColumn() result - PDOStatement

    $opt['limit']:查询起始,array(0, 10) or 10

  • $sql
  • $args
  • $opt
db_rename_table (line 307)

表更名

void db_rename_table ((string)$name $name, (string)$new_name $new_name, [(string)$target $target = 'default'])
  • (string)$name $name: 原表名
  • (string)$new_name $new_name: 新表名
  • (string)$target $target: 数据库
db_replace (line 160)

插入或替换记录,对应 mysql REPLACE INTO 用法,其它数据库类型,根据自身特性实现

影响的列数 db_replace ((string)$table $table, (object $args, [ $opt = array()])
  • (array) $opt: 数据库属性设置
  • (string)$table $table: 数据表名
  • (object $args: or array) $args 待写入的数据,可以是 object 或 array。其单元对应字段名称
db_show_tables (line 211)

列出所有表

void db_show_tables ([ $target = 'default'])
  • $target
db_write_record (line 498)

快捷的数据库 insert、update 操作接口,适合较多字段的表写入、更新操作,可为模块开发者减少 sql 代码量

  • return: true,update 时影响的列数,将赋给 _db_write_record 单元,失败返回 false。
成功返回 db_write_record ((string)$table $table, (object &$o, [(array) $wheres = array()], [ $opt = array()], [string|array $table_field = NULL])
  • (array) $wheres: 如果是更新操作,应当传递做为条件的字段名称,字段之间的关系只能是 AND
  • (array) $opt: db_exec() 接口 $opt 参数
  • string|array $table_field: 指定待操作的表字段(array),或表名(string),这将跳过检查表是否存,通常用在向其它库插入内容
  • (string)$table $table: 数据表名
  • (object &$o: or array) &$o 待写入的数据,可以是 object 或 array。其单元对应字段名称。若成功,将附加一个 _db_write_record 单元

Documentation generated on Wed, 04 Jul 2012 14:35:56 +0800 by phpDocumentor 1.4.3