documentZTD Query Core

ZTD Query Core

Packagist Downloads PHP Version License: MIT Docs Ask DeepWiki

ZTD Query is a Zero Table Dependency testing library for PHP: it runs the SQL of an application on a real MySQL, PostgreSQL, or SQLite engine without reading or writing any physical table. Before a query reaches the database, every table it references is replaced by a CTE holding the rows the test has written, and every INSERT, UPDATE, and DELETE is turned into a SELECT whose result is kept in the session, so later queries see the change. Tests therefore need no migrations, seeding, or cleanup, and they can run in parallel against one empty database. This package is the database-independent core; use it through a connection adapter and a platform package.

Requirements

• PHP 8.1+
• MySQL 8.0–9.1, PostgreSQL 16–17, or SQLite 3.x

Installation

Install the core with the PDO adapter and the platform package of your database.

MySQL:

composer require --dev k-kinzal/ztd-query-core k-kinzal/ztd-query-pdo-adapter k-kinzal/ztd-query-mysql

PostgreSQL:

composer require --dev k-kinzal/ztd-query-core k-kinzal/ztd-query-pdo-adapter k-kinzal/ztd-query-postgres

SQLite:

composer require --dev k-kinzal/ztd-query-core k-kinzal/ztd-query-pdo-adapter k-kinzal/ztd-query-sqlite

Usage

ZtdPdo extends PDO, so it can be passed wherever the application expects a PDO connection. Tables are created and filled through the same connection; they exist only in the session.

use PDO;
use PHPUnit\Framework\TestCase;
use ZtdQuery\Adapter\Pdo\ZtdPdo;

final class UserQueryTest extends TestCase
{
    public function testSelectsActiveUsers(): void
    {
        $pdo = new ZtdPdo('mysql:host=127.0.0.1;dbname=test', 'root', 'root');
        $pdo->exec('CREATE TABLE users (id INT PRIMARY KEY, name VARCHAR(255) NOT NULL, active BOOLEAN NOT NULL)');
        $pdo->exec("INSERT INTO users (id, name, active) VALUES (1, 'Alice', TRUE), (2, 'Bob', FALSE)");

        $statement = $pdo->prepare('SELECT name FROM users WHERE active = ? ORDER BY id');
        $statement->execute([1]);

        self::assertSame(['Alice'], $statement->fetchAll(PDO::FETCH_COLUMN));
    }
}

ZtdPdo::fromPdo($pdo) wraps an existing connection instead of opening a new one, and disableZtd() and enableZtd() switch between the physical database and the session.

Configuration

use ZtdQuery\Adapter\Pdo\ZtdPdo;
use ZtdQuery\Config\UnknownSchemaBehavior;
use ZtdQuery\Config\UnsupportedSqlBehavior;
use ZtdQuery\Config\ZtdConfig;

$config = new ZtdConfig(
    // Unsupported statements: Exception (default), Notice, or Ignore
    unsupportedBehavior: UnsupportedSqlBehavior::Exception,

    // Tables the session does not know: Passthrough to the database (default), or Exception
    unknownSchemaBehavior: UnknownSchemaBehavior::Exception,

    // Per-statement overrides of unsupportedBehavior; the first matching rule wins
    behaviorRules: [
        'CREATE INDEX' => UnsupportedSqlBehavior::Ignore,       // case-insensitive prefix
        '/^SET\s+/i' => UnsupportedSqlBehavior::Notice,          // regular expression
    ],
);

$pdo = new ZtdPdo($dsn, $user, $password, config: $config);

Ignore skips the statement, Notice skips it and raises a PHP notice, and Exception throws ZtdPdoException.

SQL Support

Unsupported statements are handled as configured by unsupportedBehavior. The full specification of each database is in ztd-query-mysql, ztd-query-postgres, and ztd-query-sqlite.

License

MIT License. See LICENSE for details.