README

Yii Database

Framework-agnostic database abstraction layer that provides a set of classes to connect and interact with various database management systems (DBMS) using a unified API, including a powerful query builder.

Available database drivers:

Optional packages that provide additional functionality:

Yii Active Record provides an object-oriented interface for working with database tables, similar to ORM frameworks such as Doctrine or Hibernate.

Requirements

PHP 8.1 - 8.4.
pdo PHP extension.

Installation

The package could be installed with Composer.

composer require yiisoft/db yiisoft/db-sqlite

Important

You must install yiisoft/db together with at least one database driver (e.g., yiisoft/db-mysql, yiisoft/db-pgsql, yiisoft/db-sqlite, etc.) to actually connect to a database.

It also depends on PSR-16: Common Interface for Caching Libraries and requires the installation of PSR-16 implementation. For example, yiisoft/cache or one of the other cache handlers.

General Usage

To connect to a database, create an instance of the appropriate driver:

use Yiisoft\Db\Sqlite\Connection;
use Yiisoft\Db\Sqlite\Driver;

/**
 * @var Psr\SimpleCache\CacheInterface $cache 
 */

// Creating a database connection
$db = new Connection(
    new Driver('sqlite:memory:'),
    new SchemaCache($cache),
);

You can then use the $db object to execute SQL queries, manage transactions, and perform other database operations. Here are some examples:

use Yiisoft\Db\Connection\ConnectionInterface;

/**
 * @var ConnectionInterface $db
 */

// Query builder
$rows = $db 
    ->select(['id', 'email'])  
    ->from('{{%user}}')  
    ->where(['last_name' => 'Smith'])  
    ->limit(10)  
    ->all();

// Insert
$db->createCommand()
    ->insert(
        '{{%user}}',
         [
            'email' => 'mike@example.com',
            'first_name' => 'Mike',
            'last_name' => 'Smith',
         ],
    )
    ->execute();

// Transaction
$db->transaction(
    static function (ConnectionInterface $db) {
        $db->createCommand()
            ->update('{{%user}}', ['status' => 'active'], ['id' => 1])
            ->execute();
        $db->createCommand()
            ->update('{{%profile}}', ['visibility' => 'public'], ['user_id' => 1])
            ->execute();
    }
)

Documentation

Guide: English, Português - Brasil
Internals

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

License

The Yii Database is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

yiisoft / db

Maintainers

Details