LazyRecord: The Fast PHP ORM

LazyRecord
The Fast PHP ORM
林佑安
Yo-An Lin (c9s)
12年4月22⽇日星期⽇日

View Slide

.metadata
• 林佑安 (c9s)
• 190 repo/projects on GitHub
• Perl programming since 2008
• PHP programming since last year
• c, c++, javascript, obj-c, ruby, python,
haskell, java, c#, VB .NET ...

View Slide

Why another PHP
ORM ?

View Slide

PHP ORMs
• Doctrine

View Slide

PHP ORMs
• Doctrine
• Propel

View Slide

PHP ORMs
• Doctrine
• Propel
• Idiorm / Paris

View Slide

Propel / Doctrine
• Propel uses XML Schema ﬁle.

View Slide

Propel / Doctrine
• Doctrine uses XML/YAML/Annotations.

View Slide

Propel / Doctrine
• Slow & Fat.

View Slide

Propel / Doctrine
• Slow & Fat.
• Doctrine is too complicated.

View Slide

Common characteristic

View Slide

• XML for configuration file.
• XML for schema file.
• XML for everything.
• Concepts are from Java, too complicated.

View Slide

Propel XML
runtime.conf

View Slide

propel-bookstore
console
7

sqlite

DebugPDO
mysql:host=localhost;dbname=bookstore
testuser
password

false

true

utf8

set search_path myschema, public
INSERT INTO BAR ('hey', 'there')

mysql:host=slave-server1; dbname=bookstore


true

true
3

true
1


View Slide

sqlite

DebugPDO
mysql:host=localhost;dbname=bookstore
testuser
password

false

true

utf8

set search_path myschema, public
INSERT INTO BAR ('hey', 'there')



true

true
3

true
1


View Slide


View Slide

It should be simpler

View Slide

Inspirations
• JiftyDBI / Perl
• KiokuDB / Perl
• ActiveRecord / Ruby
• Propel / PHP

View Slide

ActiveRecord Pattern

View Slide

client = Client.find(10)
client = Client.first
Client.where("orders_count = ?", params[:orders])
Client.where("created_at >= :start_date AND created_at <= :end_date",
{:start_date => params[:start_date], :end_date => params[:end_date]})
Client.order("created_at DESC")
Client.limit(5).offset(30)

View Slide

Object::Declare
Audrey Tang
唐鳳
use Object::Declare ['MyApp::Column', 'MyApp::Param'];
my %objects = declare {
param foo =>
!is global,
is immutable,
valid_values are qw( more values );
column bar =>
field1 is 'value',
field2 is 'some_other_value',
sub_params are param( is happy ), param ( is sad );
};
print $objects{foo}; # a MyApp::Param object
print $objects{bar}; # a MyApp::Column object
# Assuming that MyApp::Column::new simply blesses into a hash...
print $objects{bar}{sub_params}[0]; # a MyApp::Param object
print $objects{bar}{sub_params}[1]; # a MyApp::Param object
2006

View Slide

Jifty::DBI
package Simple;
use Jifty::DBI::Schema;
use Jifty::DBI::Record schema {
column foo => type is 'text';
column bar => type is 'text';
};

View Slide

Jifty::DBI
package TestApp::Model::Phone;
use Jifty::DBI::Schema;
use Jifty::DBI::Record schema {
column user => references TestApp::Model::User by 'id',
is mandatory;
column type => ...;
column value =>
validator is sub { ... },
default is sub { }
;
};

View Slide

Jifty
Model Schema

View Slide

Jifty
Model Schema ⇛ Action

View Slide

Jifty
Model Schema ⇛ Action ⇛
CRUD

View Slide

Jifty
App::Model::Phone ☚ write once

View Slide

Jifty
App::Model::Phone
App::Model::PhoneCollection

View Slide

Jifty
App::Model::Phone
App::Action::CreatePhone

View Slide

Jifty
App::Model::Phone
App::Action::UpdatePhone

View Slide

Jifty
App::Model::Phone
App::Action::DeletePhone

View Slide

Jifty
App::Model::Phone
App::Action::DeletePhone
$phone->as_create_action()->render();

View Slide


View Slide

What we need
• Can use PHP closures for validation, default value,
completion ..etc.
• Everything should be lazy.
• Simple API
• No overdesign.
• Mixin schema
• CRUD generation.
• Front-end CRUD integration.

View Slide

PHP 5.3 Characteristic
• APC is fast.
• require / include is slow.
• json_encode / json_decode are slower than
require.
• method is slower than properties.
• magic method is slower than normal method.
• array is always faster than object.

View Slide

$array[] vs array_push
https://github.com/c9s/SimpleBench

View Slide

Function calls
https://github.com/c9s/SimpleBench

View Slide

PHP ORM v1

View Slide

EteDB
• Initialize model schema in runtime.
• Schema is deﬁned in Model (in
__constructor).
• MySQL only.
• dynamic class generator (using eval)
• too slow.

View Slide

PHP ORM v2

View Slide

LazyRecord
• Lazy schema
loader
• Lazy attribute
• Lazy class loader
• Lazy connection
• Static class
generator
• SQL Generator
for MySQL,
PgSQL, SQLite
• SplClassLoader
• ... etc

View Slide

Based on SQLBuilder

View Slide

SQLBuilder
• A Simple SQL Generator.
• Prevent Injection.
• Migration generator. (index, alter table...etc)
• Support SQLite, Pgsql, Mysql syntax.
• Pure SQL or with named-parameters.

View Slide

$sqlbuilder = new SQLBuilder\QueryBuilder( $driver );
$sql = $sqlbuilder->table('authors')->insert([
'name' => 'Mary',
'address' => 'Paris',
])->build();

View Slide

-- General syntax
INSERT INTO authors ( name , address ) VALUES ( 'Name' , 'Address' );
-- PgSQL
INSERT INTO "Authors" ( "Name" , "Address" ) VALUES ( 'Name' , 'Address' );
-- MySQL
INSERT INTO `Authors` ( `Name` , `Address` ) VALUES ( 'Name' , 'Address' );
-- PDO
INSERT INTO authors ( name , address ) VALUES ( ? , ? );
INSERT INTO authors ( name , address ) VALUES ( :name , :address );

View Slide

$sql = $builder->table('Member')->select('*')
->where()
->equal( 'a' , 'bar' ) // a = 'bar'
->notEqual( 'a' , 'bar' ) // a != 'bar'
->is( 'a' , 'null' ) // a is null
->isNot( 'a' , 'null' ) // a is not equal
->greater( 'a' , '2011-01-01' );
->greater( 'a' , ['date(2011-01-01)'] ); // do not escape
->or()->less( 'a' , 123 )
->and()->like( 'content' , '%content%' );
->group() // and ( a = 123 or b != 123 )
->is( 'a' , 123 )
->isNot( 'b', 123 )
->ungroup()
->build();

View Slide

Overview

View Slide

Model Overview

View Slide

$author = new Author;
$ret = $author->create([
'name' => "Deflator Test $i",
'country' => 'Tokyo',
'confirmed' => true,
'date' => new DateTime('2011-01-01 00:00:00'),
]);
if( $ret->success ) {
echo "Created!";
}

View Slide

$ret = $author->update(array( 'name' => 'Bar' ));
echo "Updated!";
}
else {
echo $ret; // __toString support
}

View Slide

$record = Author::load(array( 'name' => 'Foo' ));
// To find a record with primary key:
$record = Author::load( 1 );
// To update a record (static):
$ret = Author::update( array(
'name' => 'Author'
))->where()
->equal('id',3)
->execute();

View Slide

$author->toJson();
$author->toArray();
$author->toXml();
$author->toYaml();

View Slide

Collection Overview

View Slide

$authors = new AuthorCollection;
foreach( $authors as $author ) {
echo $author->name , "\n"
}
Iterator

View Slide

$names = new NameCollection;
$names->where()
->equal('name','Foo')
->groupBy('name','address');
?>
SQLBuilder Mix-In

View Slide

$newCollection = $names->filter(function($item) {
// do something else
})->filter(function($item) {
return $item->confirmed;
});
?>
Filter

View Slide

$names->each(function($item) {
$item->update([ .... ]);
});
?>
Each

View Slide

/* page 1, 10 per page */
$authors = new AuthorCollection;
$pager = $authors->pager(1,10);
$pager = $authors->pager();
$items = $pager->items();
$pager->next(); // next page
?>
Integrate with OFFSET & LIMIT
Collection Pager

View Slide

Relationship
// has many
$address = $author->addresses->create([
'address' => 'farfaraway'
]);
// create related address
$author->addresses[] = [
'address' => 'Harvard'
];
$addresses = $author->addresses->items();
foreach( $author->addresses as $address ) {
echo $address->address , "\n";
}

View Slide

Schema

View Slide

Powered by
CascadingAttribute.php

View Slide

use LazyRecord\Schema\SchemaDeclare;
class AddressSchema extends SchemaDeclare
{
function schema()
{
}
}

View Slide

{
function schema()
{
$this->column('address')
->varchar(128);
}
}

View Slide

{
function schema()
{
->integer();
}
}

View Slide

{
function schema()
{
->timestamp();
}
}

View Slide

Default value & builder

View Slide

$this->column('name')
->varchar(30)
->default('Default');

View Slide

->varchar(30)
->default( array('current_timestamp') );

View Slide

->varchar(30)
->defaultBuilder(function() {
return date('c');
})

View Slide

->varchar(30)
->default('Default')
->default( array('current_timestamp') )
->defaultBuilder(function() {
return date('c');
})

View Slide

Validator

View Slide

->varchar(30)
->validator('ValidatorClass')

View Slide

->varchar(30)
->validator( array('ValidatorClass','method') )

View Slide

->varchar(30)
->validator('function_name')

View Slide

->varchar(30)
->validator(function($val) { .... })

View Slide

Filter

View Slide

->varchar(30)
->filter( function($val) {
return preg_replace('#word#','zz',$val);
});

View Slide

Deﬂator / Inﬂator

View Slide

class NameSchema extends SchemaDeclare
{
function schema()
{
$this->column('created_on')
->date()
->isa('DateTime')
->deflator( function($val) {
if( is_a( $val, 'DateTime' ) )
return $val->format('Y-m-d');
elseif( is_integer($val) ) {
return strftime( '%Y-%m-%d' , $val );
}
return $val;
})
->inflator( function($val) {
return new \DateTime( $val );
});
}
}

View Slide

$name->created_on; // DateTime object
$name->created_on->format('Y-m-d');
$name->create([
'created_on' => new DateTime;
]);

View Slide

Mixin schema

View Slide

$this->mixin('MetadataMixinSchema');
$this->mixin('I18nMixinSchema');
$this->mixin('CommentMinxSchema');

View Slide

Multiple data source

View Slide

data_sources:
master:
dsn: 'mysql:host=localhost;dbname=lazy_test'
user: root
pass: 123123
database.yml

View Slide

data_sources:
master:
user: root
pass: 123123
slave:
dsn: 'mysql:dbname=lazy_test'
query_options: { quote_column: true, quote_table: true }
database.yml

View Slide

// data source for writing
$this->writeTo('master');
// data source for reading
$this->readFrom('slave');
data_sources:
master:
user: root
pass: 123123
slave:
dsn: 'mysql:dbname=lazy_test'
query_options: { quote_column: true, quote_table: true }
database.yml
schema

View Slide

拼裝時刻

View Slide

LazyBone
http://github.com/c9s/LazyBone.git

View Slide

LazyBone =

View Slide

LazyRecord
+ Roller Router
+ RESTful Plugin
+ Backbone.js

View Slide

Install LazyRecord

View Slide

sudo bash -c "$(curl -s -L https://raw.github.com/c9s/LazyRecord/master/install.sh)"

View Slide

Define config file

View Slide

---
bootstrap:
- bootstrap.php
schema:
paths:
- model
data_sources:
default:
dsn: 'sqlite:/tmp/todos.db'
conﬁg/database.yml

View Slide

$ lazy build-conf config/database.yml
Convert YAML to PHP.
$config = require '.lazy.php';
APC caches this automatically.

View Slide

Deﬁne model

View Slide

class TodoSchema extends LazyRecord\Schema\SchemaDeclare
{
function schema()
{
$this->column('id')
->primary()
->autoIncrement()
->integer();
$this->column('title')
->text();
$this->column('done')
->boolean()
->default(false);
$this->column('created_on')
->defaultBuilder( function() { return date('c'); } )
->timestamp();
}
function bootstrap($model)
{
$model->create(array(
'title' => 'Foo',
));
}
}

View Slide

Create static schema
ﬁles

View Slide


View Slide

$ lazy build-schema model/TodoSchema.php

View Slide

$ lazy build-schema model/TodoSchema.php
...
Classmap:
! TodoSchemaProxy => model/TodoSchemaProxy.php
! TodoBase => model/TodoBase.php
! Todo => model/Todo.php
! TodoCollectionBase => model/TodoCollectionBase.php
! TodoCollection => model/TodoCollection.php
Done

View Slide

Initialize database

View Slide


View Slide

$ lazy build-sql model/TodoSchema.php

View Slide

$ lazy build-sql model/TodoSchema.php
Building SQL for TodoSchema
--- SQL for TodoSchema
CREATE TABLE todos (
id integer primary key autoincrement,
title text,
done boolean default 0,
created_on timestamp
);

View Slide

Integrate with your
application

View Slide

use LazyRecord\ConfigLoader;
$config = new ConfigLoader;
$config->load( __DIR__ . '/.lazy.php');
$config->init();

View Slide

Deﬁne routes

View Slide

Roller Router
High performance router for PHP

View Slide

Roller Router
• APC cache
• FileSystem cache
• Use Array to store routes
• through PHP extension, can dispatch 1607% faster than
pure php version
• Annotation reader support
• RESTful plugin

View Slide

$router = new Roller\Router;
$router->get( '/blog/:id/:title' , function($id,$title) {
return 'Blog';
});
$router->post( '/blog/:year/:month/:id/:title',
array('Controller','method') );
$router->any( '/path/to/:year' , array('Callback','method') , array(
'year' => '\d+',
));

View Slide

$subroutes = new Roller\RouteSet;
$subroutes->add( '/subitem' , $cb );
$routes = new Roller\RouteSet;
$routes->mount( '/item' , $subroutes );
/item/subitem => $cb
RouteSet

View Slide

Dispatch
$r = $router->dispatch( isset($_SERVER['PATH_INFO'])
? $_SERVER['PATH_INFO']
: '/' );
if( $r ) {
echo $r();
} else {
die('Page not found');
}

View Slide

RESTful Plugin

View Slide

$router = new Roller\Router( null, array(
'cache_id' => 'router_demo'
));
$restful = new Roller\Plugin\RESTful(array(
'prefix' => '/=/restful' ));
$restful->setGenericHandler( 'MyGenericHandler' );
$router->addPlugin($restful);

View Slide

GET /=/restful/posts
GET /=/restful/posts.json
GET /=/restful/posts.yml
GET /=/restful/posts/23
GET /=/restful/posts/23.json
POST /=/restful/posts/23
DELETE /=/restful/posts/23
Auto-generated routes

View Slide

Deﬁne Your Resource
Handler

View Slide

use Roller\Plugin\RESTful\ResourceHandler;
use Roller\Plugin\RESTful\GenericHandler;
class MyGenericHandler extends GenericHandler
{
public function create($resource) {
}
public function load($resource,$id) {
}
public function update($resource,$id) {
}
public function delete($resource,$id) {
}
public function find($resource) {
}
}

View Slide

namespace LazyBone\Resource;
use Roller\Plugin\RESTful\ResourceHandler;
use Todo;
use TodoCollection;
class TodoResource extends ResourceHandler
{
public function create()
{
$vars = json_decode($this->readInput(),true);
$todo = new Todo;
$ret = $todo->create($vars);
return $todo->toArray();
}
$this->codeBadRequest();
return array( 'error' => $ret->message );
}
public function update($id)
{
$todo = new Todo( $id );
if( ! $todo->id ) {
return $this->codeNotFound();
}
$vars = json_decode($this->readInput(),true);
unset( $vars['created_on'] ); // lazy record bug
if($vars) {
$todo->update( $vars );
return $todo->toArray();
}
return $this->codeBadRequest();
}
....

View Slide

Backbone.js

View Slide

Todo = Backbone.Model.extend({
// Default attributes for the todo item.
defaults: function() {
return {
title: "empty todo...",
done: false
// order: Todos.nextOrder(),
};
},
// Toggle the `done` state of this todo item.
toggle: function() {
this.save({done: !this.get("done")});
},
clear: function() {
this.destroy();
}
});

View Slide

TodoList = Backbone.Collection.extend({
// Reference to this collection's model.
model: Todo,
url:"/=/todos",
done: function() {
return this.filter(function(todo){
return todo.get('done'); });
},
remaining: function() {
return this.without.apply(this, this.done());
},
});

View Slide


View Slide

Hacking
forks welcome!
http://github.com/c9s/LazyRecord.git

View Slide

Q & A ?

View Slide

LazyRecord: The Fast PHP ORM

LazyRecord: The Fast PHP ORM

Yo-An Lin

More Decks by Yo-An Lin

Other Decks in Programming

Featured

Transcript