quantaforge/database

The QuantaForge Database package.

v1.0.0 2023-10-14 14:41 UTC

Requires

• php: ^8.1
• ext-pdo: *
• brick/math: ^0.9.3|^0.10.2|^0.11
• quantaforge/collections: ^1.0.0
• quantaforge/container: ^1.0.0
• quantaforge/contracts: ^1.0.0
• quantaforge/macroable: ^1.0.0
• quantaforge/support: ^1.0.0

Suggests

• ext-filter: Required to use the Postgres database driver.
• doctrine/dbal: Required to rename columns and drop SQLite columns (^3.5.1).
• fakerphp/faker: Required to use the eloquent factory builder (^1.21).
• quantaforge/console: Required to use the database commands (^10.0).
• quantaforge/events: Required to use the observers with Eloquent (^10.0).
• quantaforge/filesystem: Required to use the migrations (^10.0).
• quantaforge/pagination: Required to paginate the result set (^10.0).
• symfony/finder: Required to use Eloquent model factories (^6.2).

MIT

• Taylor Otwell

• database
• orm
• sql
• quantaforge

README

The QuantaForge Database component is a full database toolkit for PHP, providing an expressive query builder, ActiveRecord style ORM, and schema builder. It currently supports MySQL, Postgres, SQL Server, and SQLite. It also serves as the database layer of the QuantaForge PHP framework.

Usage Instructions

First, create a new "Capsule" manager instance. Capsule aims to make configuring the library for usage outside of the QuantaForge framework as easy as possible.

use QuantaForge\Database\Capsule\Manager as Capsule;

$capsule = new Capsule;

$capsule->addConnection([
    'driver' => 'mysql',
    'host' => 'localhost',
    'database' => 'database',
    'username' => 'root',
    'password' => 'password',
    'charset' => 'utf8',
    'collation' => 'utf8_unicode_ci',
    'prefix' => '',
]);

// Set the event dispatcher used by Eloquent models... (optional)
use QuantaForge\Events\Dispatcher;
use QuantaForge\Container\Container;
$capsule->setEventDispatcher(new Dispatcher(new Container));

// Make this Capsule instance available globally via static methods... (optional)
$capsule->setAsGlobal();

// Setup the Eloquent ORM... (optional; unless you've used setEventDispatcher())
$capsule->bootEloquent();

composer require "quantaforge/events" required when you need to use observers with Eloquent.

Once the Capsule instance has been registered. You may use it like so:

Using The Query Builder

$users = Capsule::table('users')->where('votes', '>', 100)->get();

Other core methods may be accessed directly from the Capsule in the same manner as from the DB facade:

$results = Capsule::select('select * from users where id = ?', [1]);

Using The Schema Builder

Capsule::schema()->create('users', function ($table) {
    $table->increments('id');
    $table->string('email')->unique();
    $table->timestamps();
});

Using The Eloquent ORM

class User extends QuantaForge\Database\Eloquent\Model {}

$users = User::where('votes', '>', 1)->get();

For further documentation on using the various database facilities this library provides, consult the QuantaForge framework documentation.