Database Abstraction Layer
AnyDataset-DB provides a relational database abstraction layer. It is part of the Anydataset project, an agnostic data source abstraction layer for PHP.
Learn more about Anydataset here.
Features
- Connection based on URI
- Handles compatibility and code optimization across multiple databases (e.g., MySQL, PostgreSQL, MS SQL Server)
- Built-in Query Cache support using a PSR-16 compliant interface
- Enables connection routing based on regular expressions for queries (e.g., directing queries to different databases for specific tables)
Connection Based on URI
Database connections are defined using URL-based connection strings.
Supported drivers are listed below:
| Database | Connection String | Factory Method |
|---|---|---|
| SQLite | sqlite:///path/to/file | getDbInstance() |
| DuckDB | duckdb:///path/to/file (duckdb:// for in-memory) | getDbInstance() |
| MySQL/MariaDB | mysql://username:password@hostname:port/database | getDbInstance() |
| PostgreSQL | pgsql://username:password@hostname:port/database | getDbInstance() |
| SQL Server (DbLib) | dblib://username:password@hostname:port/database | getDbInstance() |
| SQL Server (Sqlsrv) | sqlsrv://username:password@hostname:port/database | getDbInstance() |
| Oracle (OCI8) | oci8://username:password@hostname:port/database | getDbInstance() |
| Oracle (PDO OCI) | oci://username:password@hostname:port/database | getDbInstance() |
| Generic PDO | pdo://username:password@pdo_driver?PDO_PARAMETERS | getDbInstance() |
| Cloudflare D1 | d1://account_id:api_token@api.cloudflare.com/database_id | getDbInstance() |
Example usage:
<?php
$conn = \ByJG\AnyDataset\Db\Factory::getDbInstance("mysql://root:password@10.0.1.10/myschema");
Examples
- Getting Started
- Basic Query and Update
- Sql Statement Object
- Cache results
- Database Transaction
- Load Balance and Connection Pooling
- Database Helper
- Filtering the Query
- Entity Mapping
Advanced Topics
- Database Driver Interface
- DatabaseExecutor - Recommended API
- Executor Observers
- Journal (Record and Restore Changes)
- Passing Parameters to PDODriver
- Generic PDO Driver
- Driver: DuckDB
- Running Tests
- Installing the PHP database extensions
- Getting an Iterator from an existing PDO Statement
- Pre Fetch records
- Logging
- Deprecated Features
Database Specifics
Installation
Just type:
composer require "byjg/anydataset-db"
Running Tests
docker compose up -d
vendor/bin/phpunit
More details, including the database suites, are in Running Unit tests.