Db
Yii Database Library
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. The project is written primarily in PHP, distributed under the BSD 3-Clause "New" or "Revised" License license, first published in 2018. Key topics include: database, dbal, query-builder, sql, yii3.
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:
- Yii DB MSSQL
- Yii DB MySQL (also supports MariaDB)
- Yii DB Oracle
- Yii DB PostgreSQL
- Yii DB SQLite
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. - Yii DB Migration allows you to manage database schema using migrations.
Requirements
- PHP 8.1 - 8.5.
pdoPHP extension.
Installation
To install yiisoft/db you must install at least one database driver:
[!IMPORTANT]
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:
phpuse 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:
phpuse 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.
Support the project
Follow updates
Contributors
Showing top 12 contributors by commit count.
