Arsse/lib/Db/Driver.php

<?php
declare(strict_types=1);
namespace JKingWeb\Arsse\Db;

interface Driver {
    const TR_PEND = 0;
    const TR_COMMIT = 1;
    const TR_ROLLBACK = 2;
    const TR_PEND_COMMIT = -1;
    const TR_PEND_ROLLBACK = -2;
    
    function __construct(bool $install = false);
    // returns a human-friendly name for the driver (for display in installer, for example)
    static function driverName(): string;
    // returns the version of the scheme of the opened database; if uninitialized should return 0
    function schemaVersion(): int;
    // return a Transaction object
    function begin(): Transaction;
    // manually begin a real or synthetic transactions, with real or synthetic nesting
    function savepointCreate(): int;
    // manually commit either the latest or all pending nested transactions
    function savepointRelease(int $index = null): bool;
    // manually rollback either the latest or all pending nested transactions
    function savepointUndo(int $index = null): bool;
    // attempt to advise other processes that they should not attempt to access the database; used during live upgrades
    function lock(): bool;
    function unlock(): bool;
    function isLocked(): bool;
    // attempt to perform an in-place upgrade of the database schema; this may be a no-op which always throws an exception
    function schemaUpdate(int $to): bool;
    // execute one or more unsanitized SQL queries and return an indication of success
    function exec(string $query): bool;
    // perform a single unsanitized query and return a result set
    function query(string $query): Result;
    // ready a prepared statement for later execution
    function prepare(string $query, ...$paramType): Statement;
}