transactd/orm

Transactd ORM

TransactdORMPHP

The TransactdORMPHP is PHP ORM library using the Transactd plugin for MySQL/MariaDB. It is a fastest ORM for PHP., _(*1)

Description

• High-speed database access.
• A Model is possible to high speed access to properties.
• It can be used as the ActiveRecord.
• Easy to migrate from the Laravel in similar interface to Laravel5.
• It does not depend on any framework. Also available on any PHP framework.

Execution environment

Database

• MySQL 5.6/MariaDB 5.5 or later
• Transactd Plugin 3.7.2 or later

Client

• Transactd PHP Clinet

Install

Composer

• Install via the composer.

$ cd [yourProjectDirectory]
$ composer require Trnasactd/orm

• Add the following to the beginning of your code.(If not added.)

<?php
require __DIR__ . '/vendor/autoload.php'

Manual

1. Download form the GitHub., _(*2)

2. Extruct to your project directry., _(*3)

3. Add the following to the beginning of your code.

<?php
require __DIR__ . '/TransactdORMPHP-master/src/Require.php'

Connect to databases

Master and Slave host, these are possible to same host. If you specify a different host, the write operation is the master and the read operation is processed by the slave., _(*4)

Laravel 5.1 above

• Add the following class to your config/app.php service providers list.

Transactd\boot\Laravel\TransactdLaravelServiceProvider::class,

• Add following parameters to your .env file.

// Master and Slave. These are possible to same host.
TRANSACTD_MASTER=tdap://yousername@your_master_host/your_database?&pwd=xxxx
TRANSACTD_SLAVE=tdap://yousername@your_slave_host/your_database?&pwd=xxxx

Otherwise

• Add the following code to your application code at beggining.

class_alias('Transactd\DatabaseManager', 'DB');
$masterUri = 'tdap://yousername@your_master_host/your_database?&pwd=xxxx';
$slaveUri = 'tdap://yousername@your_slave_host/your_database?&pwd=xxxx';
DB::connect($masterUri, $slaveUri);

Usage example

Table names and field names follow the rules of ActiveRecord., _(*5)

```php: <?php require DIR . '/TransactdORMPHP-master/src/Require.php', <sub>(*6)</sub>

use BizStation\Transactd\Transactd; use BizStation\Transactd\Database; use Transactd\Model;, <sub>(*7)</sub>

class Group extends Model { public function customers() { this->hasMany('Customer', 'group') } }, <sub>(*8)</sub>

class Customer extends Model { public function group() { return $this->belongsTo('Group', 'group', 'id'); } }, <sub>(*9)</sub>

// Connect to databases (Master and Slave. These are possible to same host.) class_alias('Transactd\DatabaseManager', 'DB'); $masterUri = 'tdap://root@masterhost/test?pwd=xxxx'; $slaveUri = 'tdap://root@slavehost/test?pwd=xxxx'; DB::connect($masterUri, $slaveUri);, <sub>(*10)</sub>

// Get all customers $customers = Customer::all(); echo 'The first customer's id = '. $customers[0]->id;, <sub>(*11)</sub>

// Get all customers with group relationship in a snapshot. DB::beginSnapshot(); $customers = Customer::with('group')->all(); DB::endSnapshot();, <sub>(*12)</sub>

// Find a customer id = 1 $customer = Customer::find(1); echo 'The customer name is '. $customer->name;, <sub>(*13)</sub>

// Find customers that group number is 3. // Transactd query are required that index number and keyValue for start of search. $customers = Customer::index(1)->keyValue(3)->where('group','=', 3)->get(); echo 'There are '.count($customers).' customers in Group 3.';, <sub>(*14)</sub>

// Get a group ralationship from a customer. (belongsTo) $customer = Customer::find(1); $group = $customer->group;, <sub>(*15)</sub>

// Get customers ralationship from a group. (hasMany) $group = Group::find(1); $customers = $group->customers;, <sub>(*16)</sub>

// Save a new customer. $customer = new Customer(); $customer->id = 0; //autoincrement $customer->group = 1; $customer->save();, <sub>(*17)</sub>

// Delete a customer in a transaction. DB::beginTransaction(); $customer->delete(); DB::commit();, <sub>(*18)</sub>

// Using native API $db = DB::master(); $tb = $db->openTable('customrs'); ..., <sub>(*19)</sub>

```, <sub>(*20)</sub>

Documents

1. Tutorial
2. Trnasactd ORM for PHP API
3. Trnasactd Client PHP API

Bug reporting, requests and questions

If you have any bug-reporting, requests or questions, please send it to Issues tracker on github., <sub>(*21)</sub>

License

This package is licensed under the MIT license., <sub>(*22)</sub>