Universal DB Access

dev-main 2022-07-07 19:16 UTC

This package is auto-updated.

Last update: 2024-05-07 23:32:51 UTC


Unified DB Access


Basic example

// Setup table structure and driver
$udb = new UniDb(
    new SqliteDriver(new \PDO("sqlite::memory:")),
    new Schema(
            "User" => [
                "indexes" => ["user_name"]

// Create the schema (if it does not already exist)
echo $udb->createSchema();

// Select the 'User' Table
$userTbl = $udb->with("User");

// Insert two entities
$userTbl->insert(["user_id"=>"user1", "user_name" => "Bob"]);
$userTbl->insert(["user_id"=>"user2", "user_name" => "Alice"]);

// Query all datasets with user_name='Bob' OR user_name='Alice'
foreach ($userTbl->query(stmt: new OrStmt(["user_id", "=", "Bob"], ["user_id", "=", "Alice"])) as $data) {
    print_R ($data);


composer require phore/unidb
Driver Class Features
SqliteDriver SqliteDriver Schema create

Defining the schema

UniDb requires basic information about the schema to run queries against.

Querying data

public  UniDb::query(
    $stmt = null, 
    string $table = null, 
    int $page = null, 
    int $limit = null,
    string $orderBy = null, 
    string $orderType="ASC",
    bool $cast = false
) : \Generator
Named Argument Description
stmt The Statement: either class AndStmt or OrStmt. If null, all data will be queried
table Override the default table setting defined using UniDb::with()
cast If true it will cast the structure into the Object defined

Accessing the data using generators

The easies way to access the data is to use generators:

foreach ($odb->query(table: "User") as $user) {
    print_r ($user); // Will output

Accessing full Result Set / Limit results / Page offsets

$odb->query(table: "User", limit: 10, page: 1);
print_r ($odb->result->getResult());

See output / full example

Using Object Casting / Entities

UniDb can work with Objects and therefor uses phore/hydrator to cast the result set into objects. Activate this feature by specifying cast: SomeClass::class in Argument list.

To use casting functionality you have to add package phore/hydrator to your composer.json requirements

foreach ($odb->query(table: "User", cast: User::class) as $obj) {
    print_r ($obj); // Instance of User class

See details manual page for Object casting

Quering all data of a table

$odb->query(table: "User")

Sorting the data


To be compatible to as well SQL and NoSql Databases, UniDb uses Statements to query data. By default statements will be chained by AND statements.

AND Statement

new AndStmt(["name", "=", "Bob"], ["user_name", "=", "bob1"]);
// => SELECT ... WHERE name='Bob' AND name='Alice'

OR Statement

new OrStmt(["name", "=", "Bob"], ["name", "=", "Alice"]);
// => SELECT ... WHERE name='Bob' OR name='Alice'

Nested Statements

new AndStmt(["name", "=", "Bob"], new OrStmt(["name", "=", "Bob"], ["name", "=", "Alice"]));
// => SELECT ... WHERE name='Bob' AND ( name='Bob' OR name='Alice' )


Operator Expected Value Description
= string int
<> string int
> string int
< string int
~ string Like operator
IN array

CRUD Operations

Batch Update

UniDb comes with buildin syncronisation methods to initialize and update records