Perl OR Mappers - DBIC / DOD / Fey

YAPC::Asia 2008 Tokyo

2008-05-16

始める前に

始める前に

• CDBIをメインで使ってる人

始める前に

• CDBIをメインで使ってる人
• DBICをメインで使ってる人

始める前に

• CDBIをメインで使ってる人
• DBICをメインで使ってる人
• DODをメインで使ってる人

始める前に

• CDBIをメインで使ってる人
• DBICをメインで使ってる人
• DODをメインで使ってる人
• Fey::ORMをメインで使ってる人

始める前に

• CDBIをメインで使ってる人
• DBICをメインで使ってる人
• DODをメインで使ってる人
• Fey::ORMをメインで使ってる人
• DBIx::MoCoをメインで使ってる人

始める前に

• CDBIをメインで使ってる人
• DBICをメインで使ってる人
• DODをメインで使ってる人
• Fey::ORMをメインで使ってる人
• DBIx::MoCoをメインで使ってる人
• Rose::DB::Objectをメインで使ってる人

agenda

• 本日紹介するもの
• DBIx::Class
• Data::ObjectDriver
• Fey::ORM
• 簡単な実例紹介
• DODとFey
• まとめ

DBIx::Class

DBIx::Class

• CDBIに変わってPerlのORマッパーのデファクトになった
• 弊社でもCDBIは昔の案件で残ってるだけ。新規案件は全てDBIC
• 2005/08/08にv0.01がリリース
• 現時点でv0.08010
• メソッドチェーンで検索条件をインクリメンタルに追加可能
• かなりの柔軟性でテーブルをJOINまつれる
• SQLを自分で書く事が通常ほとんどない
• PerlのHash構造がSQLにみえるようになってくる
• ドキュメントも豊富
• 最近では利用ユーザが多分一番多い（んじゃないかな
• 利用ユーザが多いので情報量が多い
• 逆にゴミも多い

Data::ObjectDriver

Data::ObjectDriver

• sixapart謹製のORマッパー
• 2005/10/11にv0.01がCPANにリリース
• 現時点でv0.05
• code.sixaprtのsvn HEADでは0.06
• Cache / Partitionに力をいれている
• sixapart以外で業務で使ってるのは不明とおもったら
• LDでも使い始めたらしい
• さいきんぼちぼちBlogとかで使おうとしている人を見かける
• SQL生成部分を自前で実装
• DOD::SQL
• これがかなりおもしろい

Fey::ORM

Fey::ORM

• Dave RolskyによるMooseベースのORマッパー
• 2008/02/09にv0.01がリリース
• 現時点でv0.05
• 最近日本のPerlHackerに大人気のMooseベース
• Fey(sql generator)をバックエンドに利用してSQLを生成
• ドキュメントがうそっぱち

簡単な実例

• Data::ObjectDriver
• Fey::ORM

DBICはみんな使ってるだろうから省略

Data::ObjectDriver

• 何も考えない使い方
• Cacheをきかせる使い方
• 簡単にパーティショニングさせる使い方

何も考えない使い方

DBに接続するDriverClassを作成:

package Proj::Driver;
use Data::ObjectDriver::Driver::DBI;
sub driver {
    Data::ObjectDriver::Driver::DBI->new(
        dsn      => 'dbi:mysql:proj',
        username => 'proj',
        password => 'passwd',
    )
}

テーブルにマッピングさせるClassを作成:

package Proj::Data::Todo;
use base 'Data::ObjectDriver::BaseObject';
use Proj::Driver;
__PACKAGE__->install_properties({
    columns     => [qw/id body delete_fg done_at created_on updated_on/],
    datasource  => 'todo',
    primary_key => 'id',
    driver      => Proj::Driver->driver,
});

let's play:

#! perl
use Proj::Data::Todo;
my $todo = Proj::Data::Todo->new;
$todo->body('learn DOD!');
$todo->save; # insert!

say $todo->body; # 'learn DOD!'

$todo->done_at(DateTime->now);
$todo->save # update!

Todo has many TodoTag. Tag has many TodoTag.

Tagテーブルの設定

package Proj::Data::Tag;
use base 'Data::ObjectDriver::BaseObject';
use Proj::Driver;
__PACKAGE__->install_properties({
    columns     => [qw/id name created_on updated_on/],
    datasource  => 'tag',
    primary_key => 'id',
    driver      => Proj::Driver->driver,
});

TodoTagテーブルの設定

package Proj::Data::TodoTag;
use base 'Data::ObjectDriver::BaseObject';
use Proj::Driver;
__PACKAGE__->install_properties({
    columns     => [qw/id todo_id tag_id created_on updated_on/],
    datasource  => 'todo_tag',
    primary_key => 'id',
    driver      => Proj::Driver->driver,
});

ここまでは一緒

リレーションの設定

package Proj::Data::TodoTag;
#..nop
__PACKAGE__->has_a({
    class  => 'Proj::Data::Todo',
    column => 'todo_id',
    method => 'todo',
    parent_method => 'tags',
});
__PACKAGE__->has_a({
    class  => 'Proj::Data::Tag',
    column => 'tag_id',
    method => 'tag',
    parent_method => 'todos',
});

• DODではhas_aの設定の時にhas_manyの設定もしてくれる。
• 当然といえば当然だが、DBICだと基本自分で書かないと行けない

• DODではhas_aの設定の時にhas_manyの設定もしてくれる。
• 当然といえば当然だが、DBICだと基本自分で書かないと行けない
• let's play:

• DODではhas_aの設定の時にhas_manyの設定もしてくれる。
• 当然といえば当然だが、DBICだと基本自分で書かないと行けない
• let's play:

#! perl
## primary key select
my $todo = Proj::Data::Todo->lookup(1);

## Todoに設定されているTagの取得
my @tags = map { $_->tag->name } $todo->tags;

• DODではResultSetを扱う事も可能

• DODではResultSetを扱う事も可能
• let's play:

• DODではResultSetを扱う事も可能
• let's play:

#! perl
my $rs = Proj::Data::Todo->result(
    {},
    {
        sort      => 'id',
        direction => 'descend',
    }
);
$rs->add_constraint({done_on => \'IS NOT NULL'});
while ( not $rs->is_finished ) {
    my $todo = $rs->next;
}

• DODではResultSetを扱う事も可能
• let's play:

   #! perl
   my $rs = Proj::Data::Todo->result(
       {},
       {
           sort      => 'id',
           direction => 'descend',
       }
   );
   $rs->add_constraint({done_on => \'IS NOT NULL'});
   while ( not $rs->is_finished ) {
       my $todo = $rs->next;
   }

add_constraintを呼び出してインクリメンタルに検索条件追加できる

Cacheをきかせる使い方

• 種類
• Apache pnotes
• memcached
• RAM
• Driverの書き方をちょっとかえるだけで簡単に可能

Driverクラスの書き方:

package Proj::Driver;
use Data::ObjectDriver::Driver::DBI;
use Data::ObjectDriver::Driver::Cache::Memcached; ## 追加
use Cache::Memcached;                             ## 追加
sub driver {
    Data::ObjectDriver::Driver::Cache::Memcached->new(
        ## Cacheの設定
        cache => Cache::Memcached->new({servers => ['127.0.0.1:11211']}),
        ## CacheにHitしなかった場合のDB接続設定
        fallback => Data::ObjectDriver::Driver::DBI->new(
            dsn      => 'dbi:mysql:proj',
            username => 'proj',
            password => 'passwd',
        ),
    );
}

Data::ObjectDriver::Driver::DBIの上に Data::ObjectDriver::Driver::Cache::Memcached がかぶさっただけ。 これだけで、自動的にキャッシュしてくれます。

簡単にパーティショニングさせる使い方

Driverクラスの書き方:

package Pro::Driver;
use Cache::Memcached;
use Data::ObjectDriver::Driver::Cache::Memcached;
use Data::ObjectDriver::Driver::Partition;
use Data::ObjectDriver::Driver::DBI;
sub driver {
    Data::ObjectDriver::Driver::Cache::Memcached->new(
        cache => Cache::Memcached->new({servers => ['127.0.0.1:11211']}),
        fallback => Data::ObjectDriver::Driver::Partition->new(
            get_driver => \&get_driver,
        ),
    ),
};

続き...:

package Proj::Driver;
# ...nop
sub get_driver {
    my($terms) = @_;
    ## some partitionning rule
    Data::ObjectDriver::Driver::DBI->new(
        dsn => 'dbi:SQLite:./dat/todo_' . $rule .'.dat',
        pk_generator => \&generate_pk,
    );
}
use Data::YUID::Generator;
sub generate_pk {
    my $obj = shift;
    $obj->id(Data::YUID::Generator->new->get_id);
}

• 独自にpartitionning ruleを考えられる。
• キャッシュをきかせながらDB自体はパーティショニング
• スケールさせるのが容易な構成
• テーブルごとにpartitionningさせるのかキャッシュさせるのかなどを決められる

DOD++

• DBICなどに比べてコンパクト
• ドキュメントもそれなりにそろってる
• 使ってみて特にはまらなかった
• test codeが一杯あるので参考になる
• Cacheが簡単に使えてうまうまー
• Partitionも簡単にできてうまうまー

DOD--

• Data::ObjectDriver::DriverとDriverが連呼されるのが気持ち悪い
• sixapartがmaster-masterな構成のため、master-slave構成だとちらほら問題があるかもとのこと
• LDがどのような構成で使ってるのかきいてみたい

Fey::ORM

• 簡単な使い方
• SQLをうまうまなかたちでうはうは

簡単な使い方

Schemaクラス:

package Proj::Schema;
use Fey::ORM::Schema;
use Fey::DBIManager::Source;
use Fey::Loader;
my $source = Fey::DBIManager::Source->new(
    dsn      => 'dbi:mysql:diary',
    username => 'diary',
    password => 'passwd'
);
my $schema = Fey::Loader->new( dbh => $source->dbh() )->make_schema();
has_schema $schema;
__PACKAGE__->DBIManager()->add_source($source);

Diaryテーブルのマッピング

package Proj::Schema::Diary;
use Proj::Schema;
use Fey::ORM::Table;
my $schema = Proj::Schema->new();
has_table( $schema->Schema()->table('diary') );

• これだけで、基本OK

• これだけで、基本OK
• let's play:

• これだけで、基本OK
• let's play:

#! perl
my $diary = Proj::Schema::Diary->insert(
    body       => 'nice day!',
    created_on => DateTime->now
);
say $diary->body; # nice day!

Diary has many DiaryTag. Tag has many DiaryTag.

• 各テーブルの基本設定は一緒:

package Proj::Schema::Tag;
use Proj::Schema;
use Fey::ORM::Table;
my $schema = Proj::Schema->new();
has_table( $schema->Schema()->table('tag') );

package Proj::Schema::DiaryTag;
use Proj::Schema;
use Fey::ORM::Table;
my $schema = Proj::Schema->new();
has_table $schema->Schema()->table('diary_tag');

リレーションの設定:

package Proj::Schema::Diary;
has_many diary_tags => (
    table => $schema->Schema()->table('diary_tag')
);

package Proj::Schema::DiaryTag;
has_one $schema->Schema()->table('diary');

• 外部キーの設定がしてある事
• 外部キーの設定が無い場合は独自でFey::FKの設定が必要

let's play:

my $diary = Proj::Schema::Diary->new(id => 1);
say $diary->id;   # 1
say $diary->body; # nice day!

my $diary_tags = $diary->diary_tags;
while (my $row = $diary_tags->next) {
    say $row->tag->name; # perl, life, some more tags...
}

SQLをうまうまなかたちでうはうは

package Proj::Schema::Diary;
use Fey::Object::Iterator;
sub perl_entries {
    my $class = shift;
    my $schema = $class->SchemaClass()->Schema();
    my $select = $class->SchemaClass()->SQLFactoryClass()->new_select();
    my ( $diary_t, $diary_tag_t, $tag_t ) =
        $schema->tables( 'diary', 'diary_tag', 'tag' );
    $select->select( $diary_t )
       ->from( $diary_t )->from( $diary_tag_t )->from( $tag_t )
       ->where(
           $diary_t->column('id'), '=', $diary_tag_t->column('diary_id')
       )->and(
           $diary_tag_t->column('tag_id'), '=', $tag_t->column('id')
       )->and(
           $tag_t->column('name'), '=', 'perl'
       );

続き:

    my $dbh = $class->_dbh($select);
    my $sth = $dbh->prepare( $select->sql($dbh) );
    return Fey::Object::Iterator->new(
        classes     => [
            $class->meta()->ClassForTable(
                $diary_t, $diary_tag_t, $tag_t
            )
        ],
        handle      => $sth,
        bind_params => [ $select->bind_params() ],
    );
}

let's play:

my $it = Prj::Schema::Diary->perl_entries;
while (my $row = $it->next) {
    say $row->body;
}

複雑なSQLを生成してイテレータオブジェクトにして利用可能

まとめ

Fey::ORMまとめ

• Fey::ORM軽くつかってみたがそれなりに使いやすい
• 使い方としては、
• 複雑なSQLをFey::SQLでくみ上げ
• Fey::Object::Iteratorでイテレーションさせる
• その一連の処理をSchema側にもたせて、メソッド呼び出しで完結させたい感じ
• MVC的には相性よさげ(単なるメソッド呼び出しになる為)
• ただ。。。
• ドキュメントが間違いまくってる
• SYNOPSISの通りにやってもうごかない
• Fey::Loaderで毎回DBからスキーマ情報を取得
• パフォーマンスがでないのではないか
• MooseベースなのでMooseに慣れてない人はつらい
• おいらはMoose使いじゃないのでつらい
• Mooseも遅いらしいし(数パーセント程度らしいが)
• まだまだベータバージョン

DODまとめ

• 個人的には好き
• スケールしやすくつくってあるので大規模サイト向き
• だたし、master-masterな構成推奨
• 6Aがmaster-master構成なため
• DOD::SQLが意外に高機能
• DOD::SQLでJOINまつったSQLをふがふがするDriverがあれば便利かもしれず
• Driverのレベルではやらない方が良い気もする
• 6A以外でのノウハウの蓄積がないので、もっと使われてほしい
• 私も色々つかってOutputします

DBICまとめ

• 当面不動一番利用されると思う
• ただ、いろいろ頑張ってるがゆえにごてごてしてる
• はっきりいってソース読むのしんどい
• やりたいことはできるんだけど、本当に理解して使ってる人すくないんじゃないかな
• 複雑な事やろうとすると変なSQLになることあるので注意
• キャッシュしにくい
• キャッシュする事をかんがえていないと思えるくらいキャッシュしにくい
• DBIx::Class::Cursor::Cachedってのがあるがこれは検索条件をもとにしてまるっとキャッシュ
• DODの用にプライマリーキーをもとにキャッシュさせるべき

結論

結論

• DBICはやっぱりべんりー

結論

• DBICはやっぱりべんりー
• でも、はっきりいってDBICみたいにネストまくったハッシュリファレンスは

結論

• DBICはやっぱりべんりー
• でも、はっきりいってDBICみたいにネストまくったハッシュリファレンスは
• 作った本人も数ヶ月後にみたらどんなSQLだっけかわからん

結論

• DBICはやっぱりべんりー
• でも、はっきりいってDBICみたいにネストまくったハッシュリファレンスは
• 作った本人も数ヶ月後にみたらどんなSQLだっけかわからん
• そういった意味での可読性はORマッパーではどうしても低くなる

結論

• DBICはやっぱりべんりー
• でも、はっきりいってDBICみたいにネストまくったハッシュリファレンスは
• 作った本人も数ヶ月後にみたらどんなSQLだっけかわからん
• そういった意味での可読性はORマッパーではどうしても低くなる
• 複雑なSQLに関してはDBI直接叩いた方がいいかとおもうます

結論

• DBICはやっぱりべんりー
• でも、はっきりいってDBICみたいにネストまくったハッシュリファレンスは
• 作った本人も数ヶ月後にみたらどんなSQLだっけかわからん
• そういった意味での可読性はORマッパーではどうしても低くなる
• 複雑なSQLに関してはDBI直接叩いた方がいいかとおもうます
• DOD::SQLやFeyのアプローチはGood

結論

• DBICはやっぱりべんりー
• でも、はっきりいってDBICみたいにネストまくったハッシュリファレンスは
• 作った本人も数ヶ月後にみたらどんなSQLだっけかわからん
• そういった意味での可読性はORマッパーではどうしても低くなる
• 複雑なSQLに関してはDBI直接叩いた方がいいかとおもうます
• DOD::SQLやFeyのアプローチはGood
• プログラマブルにSQLはやっぱり生成したいよね

結論

• DBICはやっぱりべんりー
• でも、はっきりいってDBICみたいにネストまくったハッシュリファレンスは
• 作った本人も数ヶ月後にみたらどんなSQLだっけかわからん
• そういった意味での可読性はORマッパーではどうしても低くなる
• 複雑なSQLに関してはDBI直接叩いた方がいいかとおもうます
• DOD::SQLやFeyのアプローチはGood
• プログラマブルにSQLはやっぱり生成したいよね
• 普通にHashを作ってマッパーに渡すよりは可読性が高くなる

結論

• DBICはやっぱりべんりー
• でも、はっきりいってDBICみたいにネストまくったハッシュリファレンスは
• 作った本人も数ヶ月後にみたらどんなSQLだっけかわからん
• そういった意味での可読性はORマッパーではどうしても低くなる
• 複雑なSQLに関してはDBI直接叩いた方がいいかとおもうます
• DOD::SQLやFeyのアプローチはGood
• プログラマブルにSQLはやっぱり生成したいよね
• 普通にHashを作ってマッパーに渡すよりは可読性が高くなる
• SQL::Abstract便利だけどDOD::SQLのようなスタンスのほうが後々わかりやすい

結論

• DBICはやっぱりべんりー
• でも、はっきりいってDBICみたいにネストまくったハッシュリファレンスは
• 作った本人も数ヶ月後にみたらどんなSQLだっけかわからん
• そういった意味での可読性はORマッパーではどうしても低くなる
• 複雑なSQLに関してはDBI直接叩いた方がいいかとおもうます
• DOD::SQLやFeyのアプローチはGood
• プログラマブルにSQLはやっぱり生成したいよね
• 普通にHashを作ってマッパーに渡すよりは可読性が高くなる
• SQL::Abstract便利だけどDOD::SQLのようなスタンスのほうが後々わかりやすい
• DBICでもそんな感じでできたらいいなー

ご清聴有り難うございました