NAME DBIx::Mint - A light-weight ORM for Perl VERSION This documentation refers to DBIx::Mint 0.02 SYNOPSIS Define your classes, which will play the role DBIx::Mint::Table: package Bloodbowl::Team; use Moo; with 'DBIx::Mint::Table'; has id => (is => 'rw' ); has name => (is => 'rw' ); ... Nearby (probably in a module of its own), you define the schema for your classes: package Bloodbowl::Schema; my $schema = DBIx::Mint->instance->schema; $schema->add_class( class => 'Bloodbowl::Team', table => 'teams', pk => 'id', auto_pk => 1, ); $schema->add_class( class => 'Bloodbowl::Player', table => 'players', pk => 'id', auto_pk => 1, ); # This is a one-to-many relationship $schema->one_to_many( conditions => ['Bloodbowl::Team', { id => 'team'}, 'Bloodbowl::Player'], method => 'get_players', inverse_method => 'get_team', ); And in your your scripts: use DBIx::Mint; use My::Schema; # Connect to the database DBIx::Mint->connect( $dsn, $user, $passwd, { dbi => 'options'} ); my $team = Bloodbowl::Team->find(1); my @players = $team->get_players; # Database modification methods include insert, update, and delete. # They act on a single object when called as instance methods # but over the whole table if called as class methods: $team->name('Los Invencibles'); $team->update; Bloodbowl::Coach->update( { status => 'suspended' }, { password => 'blocked' }); To define a schema and to learn about data modification methods, look into DBIx::Mint::Schema and DBIx::Mint::Table. Declaring the schema allows you to modify the data. If you only need to query the database, no schema is needed. ResultSet objects build database queries and fetch the resulting records: my $rs = DBIx::Mint::ResultSet->new( table => 'coaches' ); # You can perform joins: my @team_players = $rs->search( { 'me.id' => 1 } ) ->inner_join( 'teams', { 'me.id' => 'coach' }) ->inner_join( 'players', { 'teams.id' => 'team' }) ->all; See the docs for DBIx::Mint::ResultSet for all the methods you can use to retrieve data. DESCRIPTION DBIx::Mint is an object-relational mapping module for Perl. Its goals are: * To be simple to understand and use * To provide flexible, chaineable methods to fetch data from a database * To provide a flexible, powerful way to build relationships between classes * To play nice with your own classes. In particular, DBIx::Mint is build using Moo and it does not clash with accessors defined in your classes by Moo (although we do treat your objects as hash references under the hood) * To be light on dependencies On the other side of the equation, it has some strong restrictions: * It supports a single database handle and a single database schema. It uses a Moo::Singleton to keep everything together. * While it uses roles (through Role::Tiny/Moo::Role), it does put a lot of methods on your namespace. See DBIx::Mint::Table for the list. DBIx::Mint::ResultSet does not mess with your namespace at all. There are many ORMs for Perl. Most notably, you should look at DBIx::Class and DBIx::DataModel. DBIx::Lite is a light-weight alternative to those two, roboust and proven ORMs. This module is in its infancy and it is very likely to change and (gasp) risk is high that it will go unmaintained. DOCUMENTATION The documentation is split into four parts: * This general view, which documents the umbrella class DBIx::Mint. This class defines a singleton that simply holds the SQL::Abstract::More object and the database connection and implements transactions. * DBIx::Mint::Schema documents relationships and the mapping between classes and database tables. Learn how to specify table names, primary keys and how to create associations between classes. * DBIx::Mint::Table is a role that implements methods that modify or fetch data from a single table. * DBIx::Mint::ResultSet builds database queries using chainable methods. It does not know about the schema, so it can be used without one. Internally, associations are implemented using ResultSet objects. SUBROUTINES/METHODS IMPLEMENTED BY DBIx::Mint This module offers a just a few starting methods: instance Returns an instance of DBIx::Mint. It is a singleton, so you can access it from anywhere and it will be the same. To make it useful you should tell it how to connect to the database. connect This is a class method that receives your database connection instructions and instantiates the DBIx::Connector object: DBIx::Mint->connect('dbi:SQLite:dbname=t/bloodbowl.db', '', '', { AutoCommit => 1, RaiseError => 1 }); The database connection will be available while the singleton is alive. connector This accessor will return the underlying DBIx::Connector object. dbh This method will simply return the database handle from DBIx::Connector, which is guaranteed to be alive. abstract This is the accessor/mutator for the SQL::Abstract::More subjacent object. You can choose to build your own object with the parameters you need and then simply stuff it into your DBIx::Mint instance: my $sql = SQL::Abstract::More->new(...); $mint->abstract($sql); You can also use the default object, which is created with the defaults of SQL::Abstract::More. schema This is simply a method that will return your DBIx::Mint::Schema instance: my $schema = $mint->schema; do_transaction This method will take a code reference and execute it within a transaction block. In case the transaction fails (your code dies) it is rolled back and a warning is thrown. In this case, do_transaction will return "undef". If successful, the transaction will be commited and the method will return a true value. $mint->do_transaction( $code_ref ) || die "Transaction failed!"; DEPENDENCIES This distribution depends on the following external, non-core modules: Moo MooX::Singleton SQL::Abstract::More DBI DBIx::Connector List::MoreUtils Clone BUGS AND LIMITATIONS There are no known bugs in this module (as it is too young). Testing is not complete; in particular, tests look mostly for the expected results and not for edge cases or plain incorrect input. Please report problems to the author. Patches are welcome. Tests are welcome also. ACKNOWLEDGEMENTS The ResultSet class was inspired by DBIx::Lite, by Alessandro Ranellucci. AUTHOR Julio Fraire, LICENCE AND COPYRIGHT Copyright (c) 2013, Julio Fraire. All rights reserved. LICENSE This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.