Documentation

数据库抽象层(Database Abstraction Layer)

Phalcon\DbPhalcon\Mvc\Model 背后的一个组件,它为框架提供了强大的model层。它是一个完全由C语言写的独立的高级抽象层的数据库系统。

这个组件提供了比传统模式的更容易上手的数据库操作。

这个指引不是一个完整的包含所有方法和它们的参数的文档。 查看完整的文档参考,请访问 API

数据库适配器(Database Adapters)

这个组件利用了这些适配器去封装特定的数据库的详细操作。Phalcon使用 PDO 去连接这些数据库。下面这些是我们支持的数据库引擎:

名称 描述 API
MySQL MySQL是这个世界上最多人使用的关系数据库,它作为服务器运行为多用户提供了访问多个数据库的功能。 Phalcon\Db\Adapter\Pdo\Mysql
PostgreSQL PostgreSQL是一个强大,开源的关系数据库。它拥有超过15年的积极发展和经过验证的架构,这些已经为它赢得了可靠性、数据完整性、正确性的良好的声誉 Phalcon\Db\Adapter\Pdo\Postgresql
SQLite SQLite是一个实现一个自包含的,无服务器,零配置,支持事务的SQL数据库引擎的软件库 | Phalcon\Db\Adapter\Pdo\Sqlite

自定义适配器(Implementing your own adapters)

如果你想创建自己的适配器或者扩展现有的适配器,这个 Phalcon\Db\AdapterInterface 接口必须被实现。

数据库“方言”

Phalcon 把每个数据库引擎的具体操作封装成“方言”,这些“方言”提供了提供通用的功能和SQL生成的适配器。 (译者注:这里的“方言”是指Phalcon把一些常用的数据库操作封装成类的方法,例如检查数据库中表是否存在,不再需要麻烦的手动写SQL,可以把调用tableExists方法去查询)

名称 描述 API
MySQL MySQL的具体“方言” Phalcon\Db\Dialect\Mysql
PostgreSQL PostgreSQL的具体“方言” Phalcon\Db\Dialect\Postgresql
SQLite SQLite的具体“方言” Phalcon\Db\Dialect\Sqlite

自定义“方言”(Implementing your own dialects)

如果你想创建自己的“方言”或者扩展现有的“方言”,你需要实现这个接口: Phalcon\Db\DialectInterface

连接数据库(Connecting to Databases)

为了建立连接,实例化适配器类是必须的。它只接收一个包含连接参数的数组。 下面的例子展示了,传递必要参数和可选项的参数去连接数据库:

<?php

// 必要参数
$config = array(
    "host"     => "127.0.0.1",
    "username" => "mike",
    "password" => "sigma",
    "dbname"   => "test_db"
);

// 可选参数
$config["persistent"] = false;

// 创建连接
$connection = new \Phalcon\DB\Adapter\Pdo\Mysql($config);
<?php

// 必要参数
$config = array(
    "host"     => "localhost",
    "username" => "postgres",
    "password" => "secret1",
    "dbname"   => "template"
);

// 可选参数
$config["schema"] = "public";

// 创建连接
$connection = new \Phalcon\DB\Adapter\Pdo\Postgresql($config);
<?php

// 必要参数
$config = array(
    "dbname" => "/path/to/database.db"
);

// 创建连接
$connection = new \Phalcon\DB\Adapter\Pdo\Sqlite($config);

使用 DSN 连接数据库

<?php

// 基本配置信息
$config = array(
    'dsn' => 'mysql:dbname=testdb;host=127.0.0.1'
);

// 创建连接
$connection = new \Phalcon\DB\Adapter\Pdo\Mysql($config);

设置额外的 PDO 选项(Setting up additional PDO options)

你可以在连接的时候,通过传递’options’参数,设置PDO选项:

<?php

// 带PDO options参数的创建连接
$connection = new \Phalcon\DB\Adapter\Pdo\Mysql(
    array(
        "host"     => "localhost",
        "username" => "root",
        "password" => "sigma",
        "dbname"   => "test_db",
        "options"  => array(
            PDO::MYSQL_ATTR_INIT_COMMAND => "SET NAMES \'UTF8\'",
            PDO::ATTR_CASE               => PDO::CASE_LOWER
        )
    )
);

查找行(Finding Rows)

文档 Phalcon\Db 提供了几种方法去查询行。在这个例子中,SQL语句是必须符合数据库的SQL语法的:

<?php

$sql = "SELECT id, name FROM robots ORDER BY name";

// 发送SQL语句到数据库
$result = $connection->query($sql);

// 打印每个robot名称
while ($robot = $result->fetch()) {
   echo $robot["name"];
}

// 返回一个包含返回结果的数组
$robots = $connection->fetchAll($sql);
foreach ($robots as $robot) {
   echo $robot["name"];
}

// 只返回查询结果的第一条数据
$robot = $connection->fetchOne($sql);

默认情况下,这些调用会建立一个数组,数组中包含以字段名和以数字下标为key的值。你可以改变这种行为通过使用 Phalcon\DB\Result::setFetchMode() 。这个方法接受一个常量值,确定哪些类型的指标是被要求的。

常量 描述
Phalcon\DB::FETCH_NUM 返回一个包含数字下标的数组
Phalcon\DB::FETCH_ASSOC 返回一个包含字段名的数组
Phalcon\DB::FETCH_BOTH 返回一个包含字段名和数字下标的数组
Phalcon\DB::FETCH_OBJ 返回一个对象而不是一个数组
<?php

$sql = "SELECT id, name FROM robots ORDER BY name";
$result = $connection->query($sql);

$result->setFetchMode(Phalcon\DB::FETCH_NUM);
while ($robot = $result->fetch()) {
   echo $robot[0];
}

这个 Phalcon\DB::query() 方法返回一个 Phalcon\Db\Result\Pdo 实例。这些对象封装了凡是涉及到返回的结果集的功能,例如遍历,寻找特定行,计算总行数等等

<?php

$sql = "SELECT id, name FROM robots";
$result = $connection->query($sql);

// 遍历结果集
while ($robot = $result->fetch()) {
   echo $robot["name"];
}

// 获取第三条记录
$result->seek(2);
$robot = $result->fetch();

// 计算结果集的记录数
echo $result->numRows();

绑定参数(Binding Parameters)

Phalcon\Db 中支持绑定参数。虽然使用绑定参数会有很少性能的损失,但是我们鼓励你使用这个方法 去消除(译者注:是消除,不是减少,因为使用参数绑定可以彻底解决SQL注入问题)SQL注入攻击的可能性。 字符串和占位符都支持,就像下面展示的那样,绑定参数可以简单地实现:

<?php

// 用数字占位符绑定参数
$sql    = "SELECT * FROM robots WHERE name = ? ORDER BY name";
$result = $connection->query($sql, array("Wall-E"));

// 用指定的占位符绑定参数
$sql     = "INSERT INTO `robots`(name`, year) VALUES (:name, :year)";
$success = $connection->query($sql, array("name" => "Astro Boy", "year" => 1952));

When using numeric placeholders, you will need to define them as integers i.e. 1 or 2. In this case “1” or “2” are considered strings and not numbers, so the placeholder could not be successfully replaced. With any adapter data are automatically escaped using PDO Quote.

This function takes into account the connection charset, so its recommended to define the correct charset in the connection parameters or in your database server configuration, as a wrong charset will produce undesired effects when storing or retrieving data.

Also, you can pass your parameters directly to the execute/query methods. In this case bound parameters are directly passed to PDO:

<?php

// Binding with PDO placeholders
$sql    = "SELECT * FROM robots WHERE name = ? ORDER BY name";
$result = $connection->query($sql, array(1 => "Wall-E"));

插入、更新、删除行(Inserting/Updating/Deleting Rows)

去插入,更新或者删除行,你可以使用原生SQL操作,或者使用类中预设的方法

<?php

// 使用原生SQL插入行
$sql     = "INSERT INTO `robots`(`name`, `year`) VALUES ('Astro Boy', 1952)";
$success = $connection->execute($sql);

// 使用带占位符的SQL插入行
$sql     = "INSERT INTO `robots`(`name`, `year`) VALUES (?, ?)";
$success = $connection->execute($sql, array('Astro Boy', 1952));

// 使用类中预设的方法插入行
$success = $connection->insert(
   "robots",
   array("Astro Boy", 1952),
   array("name", "year")
);

// 插入数据的另外一种方法
$success = $connection->insertAsDict(
   "robots",
   array(
      "name" => "Astro Boy",
      "year" => 1952
   )
);

// 使用原生SQL更新行
$sql     = "UPDATE `robots` SET `name` = 'Astro boy' WHERE `id` = 101";
$success = $connection->execute($sql);

// 使用带占位符的SQL更新行
$sql     = "UPDATE `robots` SET `name` = ? WHERE `id` = ?";
$success = $connection->execute($sql, array('Astro Boy', 101));

// 使用类中预设的方法更新行
$success = $connection->update(
   "robots",
   array("name"),
   array("New Astro Boy"),
   "id = 101" // Warning! In this case values are not escaped
);

// 更新数据的另外一种方法
$success = $connection->updateAsDict(
   "robots",
   array(
      "name" => "New Astro Boy"
   ),
   "id = 101" // Warning! In this case values are not escaped
);

// With escaping conditions
$success = $connection->update(
   "robots",
   array("name"),
   array("New Astro Boy"),
   array(
      'conditions' => 'id = ?',
      'bind' => array(101),
      'bindTypes' => array(PDO::PARAM_INT) // Optional parameter
   )
);
$success = $connection->updateAsDict(
   "robots",
   array(
      "name" => "New Astro Boy"
   ),
   array(
      'conditions' => 'id = ?',
      'bind' => array(101),
      'bindTypes' => array(PDO::PARAM_INT) // Optional parameter
   )
);

// 使用原生SQL删除数据
$sql     = "DELETE `robots` WHERE `id` = 101";
$success = $connection->execute($sql);

// 使用带占位符的SQL删除行
$sql     = "DELETE `robots` WHERE `id` = ?";
$success = $connection->execute($sql, array(101));

// 使用类中预设的方法删除行
$success = $connection->delete("robots", "id = ?", array(101));

事务与嵌套事务(Transactions and Nested Transactions)

PDO支持事务工作。在事务里面执行数据操作, 在大多数数据库系统上, 往往可以提高数据库的性能:

<?php

try {

    // 开始一个事务
    $connection->begin();

    // 执行一些操作
    $connection->execute("DELETE `robots` WHERE `id` = 101");
    $connection->execute("DELETE `robots` WHERE `id` = 102");
    $connection->execute("DELETE `robots` WHERE `id` = 103");

    // 提交操作,如果一切正常
    $connection->commit();

} catch (Exception $e) {
    // 如果发现异常,回滚操作
    $connection->rollback();
}

除了标准的事务, Phalcon\Db 提供了内置支持`嵌套事务`_(如果数据库系统支持的话)。 当你第二次调用begin()方法,一个嵌套的事务就被创建了:

<?php

try {

    // 开始一个事务
    $connection->begin();

    // 执行某些SQL操作
    $connection->execute("DELETE `robots` WHERE `id` = 101");

    try {

        // 开始一个嵌套事务
        $connection->begin();

        // 在嵌套事务中执行这些SQL
        $connection->execute("DELETE `robots` WHERE `id` = 102");
        $connection->execute("DELETE `robots` WHERE `id` = 103");

        // 创建一个保存的点
        $connection->commit();

    } catch (Exception $e) {
        // 发生错误,释放嵌套的事务
        $connection->rollback();
    }

    // 继续,执行更多SQL操作
    $connection->execute("DELETE `robots` WHERE `id` = 104");

    // 如果一切正常,提交
    $connection->commit();

} catch (Exception $e) {
    // 发生错误,回滚操作
    $connection->rollback();
}

数据库事件(Database Events)

Phalcon\Db 可以发送事件到一个 EventsManager 中,如果它存在的话。 一些事件当返回布尔值false可以停止操作。我们支持下面这些事件:

事件名 何时触发 可以停止操作吗?
afterConnect 当成功连接数据库之后触发 No
beforeQuery 在发送SQL到数据库前触发 Yes
afterQuery 在发送SQL到数据库执行后触发 No
beforeDisconnect 在关闭一个暂存的数据库连接前触发 No
beginTransaction 事务启动前触发 No
rollbackTransaction 事务回滚前触发 No
commitTransaction 事务提交前触发 No

绑定一个EventsManager给一个连接是很简单的, Phalcon\Db 将触发这些类型为“db”的事件:

<?php

use Phalcon\Events\Manager as EventsManager;
use Phalcon\DB\Adapter\Pdo\Mysql as Connection;

$eventsManager = new EventsManager();

// 监听所有数据库事件
$eventsManager->attach('db', $dbListener);

$connection = new Connection(
    array(
        "host"     => "localhost",
        "username" => "root",
        "password" => "secret",
        "dbname"   => "invo"
    )
);

// 把eventsManager分配给适配器实例
$connection->setEventsManager($eventsManager);

数据库事件中,停止操作是非常有用的,例如:如果你想要实现一个注入检查器,在发送SQL到数据库前触发:

<?php

$eventsManager->attach('db:beforeQuery', function ($event, $connection) {

    // 检查是否有恶意关键词
    if (preg_match('/DROP|ALTER/i', $connection->getSQLStatement())) {
        // DROP/ALTER 操作是不允许的, 这肯定是一个注入!
        // 返回false中断此操作
        return false;
    }

    // 一切正常
    return true;
});

记录 SQL 语句(Logging SQL Statements)

使用例如 Phalcon\Db 的高级抽象组件操作数据库,被发送到数据库中执行的原生SQL语句是难以获知的。使用 Phalcon\LoggerPhalcon\Db 来配合使用,可以在数据库抽象层上提供记录的功能。

<?php

use Phalcon\Logger;
use Phalcon\Events\Manager as EventsManager;
use Phalcon\Logger\Adapter\File as FileLogger;

$eventsManager = new EventsManager();

$logger = new FileLogger("app/logs/db.log");

// 监听所有数据库事件
$eventsManager->attach('db', function ($event, $connection) use ($logger) {
    if ($event->getType() == 'beforeQuery') {
        $logger->log(\Phalcon\Logger::INFO, $connection->getSQLStatement());
    }
});

// 设置事件管理器
$connection->setEventsManager($eventsManager);

// 执行一些SQL
$connection->insert(
    "products",
    array("Hot pepper", 3.50),
    array("name", "price")
);

如上操作,文件 app/logs/db.log 将包含像下面这样的信息:

[Sun, 29 Apr 12 22:35:26 -0500][DEBUG][Resource Id #77] INSERT INTO products
(name, price) VALUES ('Hot pepper', 3.50)

自定义日志记录器(Implementing your own Logger)

你可以实现你自己的日志类来记录数据库的所有操作,通过创建一个实现了”log”方法的类。 这个方法需要接受一个字符串作为第一个参数。你可以把日志类的对象传递给 Phalcon\DB::setLogger(), 这样执行SQL时将调用这个对象的log方法去记录。

获取数据库表与视图信息(Describing Tables/Views)

Phalcon\Db 也提供了方法去检索详细的表和视图信息:

<?php

// 获取test_db数据库的所有表
$tables = $connection->listTables("test_db");

// 在数据库中是否存在'robots'这个表
$exists = $connection->tableExists("robots");

// 获取'robots'字段名称,数据类型,特殊特征
$fields = $connection->describeColumns("robots");
foreach ($fields as $field) {
    echo "Column Type: ", $field["Type"];
}

// 获取'robots'表的所有索引
$indexes = $connection->describeIndexes("robots");
foreach ($indexes as $index) {
    print_r($index->getColumns());
}

// 获取'robots'表的所有外键
$references = $connection->describeReferences("robots");
foreach ($references as $reference) {
    // 打印引用的列
    print_r($reference->getReferencedColumns());
}

一个表的详细描述信息和MYSQL的describe命令返回的信息非常相似,它包含以下信息:

下标 描述
Field 字段名称
Type 字段类型
Key 是否是主键或者索引
Null 是否允许为空

对于被支持的数据库系统,获取视图的信息的方法也被实现了:

<?php

// 获取test_db数据库的视图
$tables = $connection->listViews("test_db");

// 'robots'视图是否存在数据库中
$exists = $connection->viewExists("robots");

创建/修改/删除表

不同的数据库系统(MySQL,Postgresql等)通过了CREATE, ALTER 或 DROP命令提供了用于创建,修改或删除表的功能。但是不同的数据库语法不同。 Phalcon\Db 提供了统一的接口来改变表,而不需要区分基于目标存储系统上的SQL语法。

创建数据库表(Creating Tables)

下面这个例子展示了怎么建立一个表:

<?php

use \Phalcon\DB\Column as Column;

$connection->createTable(
    "robots",
    null,
    array(
       "columns" => array(
            new Column(
                "id",
                array(
                    "type"          => Column::TYPE_INTEGER,
                    "size"          => 10,
                    "notNull"       => true,
                    "autoIncrement" => true,
                    "primary"       => true,
                )
            ),
            new Column(
                "name",
                array(
                    "type"    => Column::TYPE_VARCHAR,
                    "size"    => 70,
                    "notNull" => true,
                )
            ),
            new Column(
                "year",
                array(
                    "type"    => Column::TYPE_INTEGER,
                    "size"    => 11,
                    "notNull" => true,
                )
            )
        )
    )
);

Phalcon\DB::createTable() 接受一个描述数据库表相关的数组。字段被定义成class Phalcon\Db\Column 。 下表列出了可用于定义字段的选项:

选项 描述 是否可选
“type” 字段类型,传入的值必须是 Phalcon\Db\Column 的常量值(看下面的列表)
“primary” True的话表示列是表主键的一部分
“size” 字段的大小,像VARCHAR或者INTEGER类型需要用到
“scale” 指定字段存放多少位小数,DECIMAL或者NUMBER类型时需要用到
“unsigned” 是否有符号,INTEGER列可能需要设置是否有符号,该选项不适用于其他类型的列
“notNull” 字段是否可以储存null值(即是否为空)
“default” Default value (when used with "notNull" => true).
“autoIncrement” 字段是否自增,设置了这个属性将自动填充自增整数,一个表只能设置一个列为自增属性
“bind” 字段类型绑定, BIND_TYPE_* 常量告诉数据库在保存数据前怎么绑定数据类型
“first” 把字段设置为表的第一位
“after” 设置字段放在指定字段的后面

Phalcon\Db 支持下面的数据库字段类型:

  • Phalcon\DB\Column::TYPE_INTEGER
  • Phalcon\DB\Column::TYPE_DATE
  • Phalcon\DB\Column::TYPE_VARCHAR
  • Phalcon\DB\Column::TYPE_DECIMAL
  • Phalcon\DB\Column::TYPE_DATETIME
  • Phalcon\DB\Column::TYPE_CHAR
  • Phalcon\DB\Column::TYPE_TEXT

传入 Phalcon\DB::createTable() 的相关数组可能含有的下标:

下标 描述 是否可选
“columns” 一个数组包含表的所有字段,字段要定义成 Phalcon\Db\Column
“indexes” 一个数组包含表的所有索引,索引要定义成 Phalcon\Db\Index
“references” 一个数组包含表的所有外键,外键要定义成 Phalcon\Db\Reference
“options” 一个表包含所有创建的选项. 这些选项常常和数据库迁移有关.

修改数据库表(Altering Tables)

随着你的应用的增长,作为一个重构的一部分,或者增加新功能,你也许需要修改你的数据库。 因为不是所有的数据库允许你修改已存在的字段或者添加字段在2个已存在的字段之间。所以 Phalcon\Db 会受到数据库系统的这些限制。

<?php

use Phalcon\DB\Column as Column;

// 添加一个新的字段
$connection->addColumn(
    "robots",
    null,
    new Column(
        "robot_type",
        array(
            "type"    => Column::TYPE_VARCHAR,
            "size"    => 32,
            "notNull" => true,
            "after"   => "name"
        )
    )
);

// 修改一个已存在的字段
$connection->modifyColumn(
    "robots",
    null,
    new Column(
        "name",
        array(
            "type"    => Column::TYPE_VARCHAR,
            "size"    => 40,
            "notNull" => true
        )
    )
);

// 删除名为"name"的字段
$connection->dropColumn(
    "robots",
    null,
    "name"
);

删除数据库表(Dropping Tables)

删除数据库表的例子:

<?php

// 删除'robots'表
$connection->dropTable("robots");

// 删除数据库'machines'中的'robots'表
$connection->dropTable("robots", "machines");