michaelrushton/db

A library to extend https://github.com/MichaelRushton/php-sql with a PDO wrapper.

dev-main 2025-06-20 14:34 UTC

Requires

• php: ^8.2
• michaelrushton/sql: dev-main

Requires (Dev)

• pestphp/pest: ^3.8

MIT

README

A PHP library to extend https://github.com/MichaelRushton/php-sql with a PDO wrapper.

Installation

composer require michaelrushton/db

Documentation

Connecting to a database

The configuration

$config = [
  "username" => $username,
  "password" => $password,
  "options" => [
    PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
  ],
  // ... Driver-specific DSN options
]);

MariaDB

See https://www.php.net/manual/en/ref.pdo-mysql.connection.php

use MichaelRushton\DB\Driver;

$connection = Driver::MariaDB->connect($config);

MySQL

See https://www.php.net/manual/en/ref.pdo-mysql.connection.php

use MichaelRushton\DB\Driver;

$connection = Driver::MySQL->connect($config);

PostgreSQL

https://www.php.net/manual/en/ref.pdo-pgsql.connection.php

use MichaelRushton\DB\Driver;

$connection = Driver::PostgreSQL->connect($config);

SQLite

https://www.php.net/manual/en/ref.pdo-sqlite.connection.php

use MichaelRushton\DB\Driver;

$connection = Driver::SQLite->connect($config);

SQLServer

https://www.php.net/manual/en/ref.pdo-sqlsrv.connection.php

use MichaelRushton\DB\Driver;

$connection = Driver::SQLServer->connect($config);

Lazily connect to a database

A lazy connection will only connect to the database when first needed

$connection = Driver::SQLite->lazyConnect($config); // Not connected

$connection->query("SELECT * FROM users"); // Connected

Querying the database

exec

See https://www.php.net/manual/en/pdo.exec.php.

$count = $connection->exec("UPDATE users SET active = 1");

query

See https://www.php.net/manual/en/pdo.query.php.

$pdo_stmt = $connection->query("SELECT * FROM users");
$pdo_stmt = $connection->query("SELECT * FROM users", $fetchMode, ...$args);

prepare

See https://www.php.net/manual/en/pdo.prepare.php.

$pdo_stmt = $connection->prepare("SELECT * FROM users WHERE id = ?");

execute

See https://www.php.net/manual/en/pdostatement.execute.php.

$pdo_stmt = $connection->execute("SELECT * FROM users WHERE id = ?", [1]);

fetch

See https://www.php.net/manual/en/pdostatement.fetch.php.

$user = $connection->fetch("SELECT * FROM users WHERE id = ?", [1]);
$user = $connection->fetch("SELECT * FROM users WHERE id = ?", [1], $mode);

fetchAll

See https://www.php.net/manual/en/pdostatement.fetchall.php.

$users = $connection->fetchAll("SELECT * FROM users WHERE active = ?", [1]);
$users = $connection->fetchAll("SELECT * FROM users WHERE active = ?", [1], $mode, ...$args);

fetchColumn

See https://www.php.net/manual/en/pdostatement.fetchcolumn.php

$id = $connection->fetchColumn("SELECT * FROM users WHERE active = ?", [1]);
$id = $connection->fetchColumn("SELECT * FROM users WHERE active = ?", [1], $column);

fetchObject

See https://www.php.net/manual/en/pdostatement.fetchobject.php

$user = $connection->fetchObject("SELECT * FROM users WHERE active = ?", [1]);
$user = $connection->fetchObject("SELECT * FROM users WHERE active = ?", [1], $class, $constructorArgs);

transaction

Begins a transaction, rolls back if an exception is thrown (rethrowing the exception), else commits.

use MichaelRushton\DB\Connection;

$connection->transaction(function (Connection $connection)
{
  $connection->query("INSERT INTO users (id) VALUES (1)");
  $connection->query("INSERT INTO users (id) VALUES (2)");
});

Using the query builder

See https://github.com/MichaelRushton/php-sql for documentation on the query builder APIs.

$delete = $connection->delete();
$insert = $connection->insert();
$select = $connection->select();
$update = $connection->update();

// MariaDB, MySQL, and SQLite only
$replace = $connection->replace();

exec

$count = $connection->insert()
->into("users")
->exec();

query

$pdo_stmt = $connection->select()
->from("users")
->query();

prepare

$pdo_stmt = $connection->select()
->from("users")
->where("id = ?")
->prepare();

execute

$pdo_stmt = $connection->select()
->from("users")
->where("id", 1)
->execute();

fetch

$user = $connection->select()
->from("users")
->where("id", 1)
->fetch();

fetchAll

$users = $connection->select()
->from("users")
->fetchAll();

fetchColumn

$id = $connection->select()
->from("users")
->where("id", 1)
->fetchColumn();

fetchObject

$user = $connection->select()
->from("users")
->where("id", 1)
->fetchObject();