DBIx::Class is Copyright (c) 2005-2020 by mst, castaway, ribasushi, and others.

DBIx::Class is Copyright (c) 2005-2020 by mst, castaway, ribasushi, and others.
See AUTHORS and LICENSE included with this distribution. All rights reserved.

NAME
DBIx::Class - Extensible and flexible object <-> relational mapper.

WHERE TO START READING
See DBIx::Class::Manual::DocMap for an overview of the exhaustive
documentation. To get the most out of DBIx::Class with the least
confusion it is strongly recommended to read (at the very least) the
Manuals in the order presented there.

GETTING HELP/SUPPORT
Due to the sheer size of its problem domain, DBIx::Class is a relatively
complex framework. After you start using DBIx::Class questions will
inevitably arise. If you are stuck with a problem or have doubts about a
particular approach do not hesitate to contact us via any of the
following options (the list is sorted by "fastest response time"):

* RT Bug Tracker:
<https://rt.cpan.org/Public/Dist/Display.html?Name=DBIx-Class>

* Email: <mailto:[email protected]>

* Twitter:
<https://twitter.com/intent/tweet?text=%40ribasushi%20%23DBIC>

SYNOPSIS
For the very impatient: DBIx::Class::Manual::QuickStart

This code in the next step can be generated automatically from an
existing database, see dbicdump from the distribution
"DBIx-Class-Schema-Loader".

Schema classes preparation
Create a schema class called MyApp/Schema.pm:

package MyApp::Schema;
use base qw/DBIx::Class::Schema/;

__PACKAGE__->load_namespaces();

1;

Create a result class to represent artists, who have many CDs, in
MyApp/Schema/Result/Artist.pm:

See DBIx::Class::ResultSource for docs on defining result classes.

package MyApp::Schema::Result::Artist;
use base qw/DBIx::Class::Core/;

__PACKAGE__->table('artist');
__PACKAGE__->add_columns(qw/ artistid name /);
__PACKAGE__->set_primary_key('artistid');
__PACKAGE__->has_many(cds => 'MyApp::Schema::Result::CD', 'artistid');

1;

A result class to represent a CD, which belongs to an artist, in
MyApp/Schema/Result/CD.pm:

package MyApp::Schema::Result::CD;
use base qw/DBIx::Class::Core/;

__PACKAGE__->load_components(qw/InflateColumn::DateTime/);
__PACKAGE__->table('cd');
__PACKAGE__->add_columns(qw/ cdid artistid title year /);
__PACKAGE__->set_primary_key('cdid');
__PACKAGE__->belongs_to(artist => 'MyApp::Schema::Result::Artist', 'artistid');

1;

API usage
Then you can use these classes in your application's code:

# Connect to your database.
use MyApp::Schema;
my $schema = MyApp::Schema->connect($dbi_dsn, $user, $pass, \%dbi_params);

# Query for all artists and put them in an array,
# or retrieve them as a result set object.
# $schema->resultset returns a DBIx::Class::ResultSet
my @all_artists = $schema->resultset('Artist')->all;
my $all_artists_rs = $schema->resultset('Artist');

# Output all artists names
# $artist here is a DBIx::Class::Row, which has accessors
# for all its columns. Rows are also subclasses of your Result class.
foreach $artist (@all_artists) {
print $artist->name, "\n";
}

# Create a result set to search for artists.
# This does not query the DB.
my $johns_rs = $schema->resultset('Artist')->search(
# Build your WHERE using an SQL::Abstract::Classic-compatible structure:
{ name => { like => 'John%' } }
);

# Execute a joined query to get the cds.
my @all_john_cds = $johns_rs->search_related('cds')->all;

# Fetch the next available row.
my $first_john = $johns_rs->next;

# Specify ORDER BY on the query.
my $first_john_cds_by_title_rs = $first_john->cds(
undef,
{ order_by => 'title' }
);

# Create a result set that will fetch the artist data
# at the same time as it fetches CDs, using only one query.
my $millennium_cds_rs = $schema->resultset('CD')->search(
{ year => 2000 },
{ prefetch => 'artist' }
);

my $cd = $millennium_cds_rs->next; # SELECT ... FROM cds JOIN artists ...
my $cd_artist_name = $cd->artist->name; # Already has the data so no 2nd query

# new() makes a Result object but doesn't insert it into the DB.
# create() is the same as new() then insert().
my $new_cd = $schema->resultset('CD')->new({ title => 'Spoon' });
$new_cd->artist($cd->artist);
$new_cd->insert; # Auto-increment primary key filled in after INSERT
$new_cd->title('Fork');

$schema->txn_do(sub { $new_cd->update }); # Runs the update in a transaction

# change the year of all the millennium CDs at once
$millennium_cds_rs->update({ year => 2002 });

DESCRIPTION
This is an SQL to OO mapper with an object API inspired by Class::DBI
(with a compatibility layer as a springboard for porting) and a
resultset API that allows abstract encapsulation of database operations.
It aims to make representing queries in your code as perl-ish as
possible while still providing access to as many of the capabilities of
the database as possible, including retrieving related records from
multiple tables in a single query, "JOIN", "LEFT JOIN", "COUNT",
"DISTINCT", "GROUP BY", "ORDER BY" and "HAVING" support.

DBIx::Class can handle multi-column primary and foreign keys, complex
queries and database-level paging, and does its best to only query the
database in order to return something you've directly asked for. If a
resultset is used as an iterator it only fetches rows off the statement
handle as requested in order to minimise memory usage. It has
auto-increment support for SQLite, MySQL, PostgreSQL, Oracle, SQL Server
and DB2 and is known to be used in production on at least the first
four, and is fork- and thread-safe out of the box (although your DBD may
not be).

This project is still under rapid development, so large new features may
be marked experimental - such APIs are still usable but may have edge
bugs. Failing test cases are *always* welcome and point releases are put
out rapidly as bugs are found and fixed.

We do our best to maintain full backwards compatibility for published
APIs, since DBIx::Class is used in production in many organisations, and
even backwards incompatible changes to non-published APIs will be fixed
if they're reported and doing so doesn't cost the codebase anything.

The test suite is quite substantial, and several developer releases are
generally made to CPAN before the branch for the next release is merged
back to trunk for a major release.

HOW TO CONTRIBUTE
Contributions are always welcome, in all usable forms (we especially
welcome documentation improvements). The delivery methods include git-
or unified-diff formatted patches, GitHub pull requests, or plain bug
reports either via RT or the Mailing list. Do not hesitate to get in
touch with any further questions you may have.

This project is maintained in a git repository. The code and related
tools are accessible at the following locations:

* Current git repository: <https://github.com/Perl5/DBIx-Class>

* Travis-CI log:
<https://travis-ci.com/github/Perl5/DBIx-Class/branches>

AUTHORS
Even though a large portion of the source *appears* to be written by
just a handful of people, this library continues to remain a
collaborative effort - perhaps one of the most successful such projects
on CPAN <http://cpan.org>. It is important to remember that ideas do not
always result in a direct code contribution, but deserve acknowledgement
just the same. Time and time again the seemingly most insignificant
questions and suggestions have been shown to catalyze monumental
improvements in consistency, accuracy and performance.

List of the awesome contributors who made DBIC v0.082842 possible

abraxxa: Alexander Hartmaier <[email protected]>

acca: Alexander Kuznetsov <[email protected]>

acme: Leon Brocard <[email protected]>

aherzog: Adam Herzog <[email protected]>

Alexander Keusch <[email protected]>

alexrj: Alessandro Ranellucci <[email protected]>

alnewkirk: Al Newkirk <[email protected]>

Altreus: Alastair McGowan-Douglas <[email protected]>

amiri: Amiri Barksdale <[email protected]>

amoore: Andrew Moore <[email protected]>

Andrew Mehta <[email protected]>

andrewalker: Andre Walker <[email protected]>

andyg: Andy Grundman <[email protected]>

ank: Andres Kievsky <[email protected]>

arc: Aaron Crane <[email protected]>

arcanez: Justin Hunter <[email protected]>

ash: Ash Berlin <[email protected]>

bert: Norbert Csongrádi <[email protected]>

bfwg: Colin Newell <[email protected]>

blblack: Brandon L. Black <[email protected]>

bluefeet: Aran Deltac <[email protected]>

boghead: Bryan Beeley <[email protected]>

bphillips: Brian Phillips <[email protected]>

brd: Brad Davis <[email protected]>

Brian Kirkbride <[email protected]>

bricas: Brian Cassidy <[email protected]>

brunov: Bruno Vecchi <[email protected]>

caelum: Rafael Kitover <[email protected]>

caldrin: Maik Hentsche <[email protected]>

castaway: Jess Robinson <[email protected]>

chorny: Alexandr Ciornii <[email protected]>

cj: C.J. Adams-Collier <[email protected]>

claco: Christopher H. Laco <[email protected]>

clkao: CL Kao <[email protected]>

Ctrl-O <http://ctrlo.com/>

da5id: David Jack Olrik <[email protected]>

dams: Damien Krotkine <[email protected]>

dandv: Dan Dascalescu <[email protected]>

dariusj: Darius Jokilehto <[email protected]>

davewood: David Schmidt <[email protected]>

daxim: Lars Dɪᴇᴄᴋᴏᴡ 迪拉斯 <[email protected]>

dduncan: Darren Duncan <[email protected]>

debolaz: Anders Nor Berle <[email protected]>

dew: Dan Thomas <[email protected]>

dim0xff: Dmitry Latin <[email protected]>

dkubb: Dan Kubb <[email protected]>

dnm: Justin Wheeler <[email protected]>

dpetrov: Dimitar Petrov <[email protected]>

Dr^ZigMan: Robert Stone <[email protected]>

dsteinbrunner: David Steinbrunner <[email protected]>

duncan_dmg: Duncan Garland <[email protected]>

dwc: Daniel Westermann-Clark <[email protected]>

dyfrgi: Michael Leuchtenburg <[email protected]>

edenc: Eden Cardim <[email protected]>

Eligo <http://eligo.co.uk/>

ether: Karen Etheridge <[email protected]>

evdb: Edmund von der Burg <[email protected]>

faxm0dem: Fabien Wernli <[email protected]>

felliott: Fitz Elliott <[email protected]>

fgabolde: Fabrice Gabolde <[email protected]>

freetime: Bill Moseley <[email protected]>

frew: Arthur Axel "fREW" Schmidt <[email protected]>

gbjk: Gareth Kirwan <[email protected]>

geotheve: Georgina Thevenet <[email protected]>

Getty: Torsten Raudssus <[email protected]>

goraxe: Gordon Irving <[email protected]>

gphat: Cory G Watson <[email protected]>

Grant Street Group <http://www.grantstreet.com/>

gregoa: Gregor Herrmann <[email protected]>

groditi: Guillermo Roditi <[email protected]>

gshank: Gerda Shank <[email protected]>

guacamole: Fred Steinberg <[email protected]>

Haarg: Graham Knop <[email protected]>

hobbs: Andrew Rodland <[email protected]>

Ian Wells <[email protected]>

idn: Ian Norton <[email protected]>

ilmari: Dagfinn Ilmari Mannsåker <[email protected]>

ingy: Ingy döt Net <[email protected]>

initself: Mike Baas <[email protected]>

ironcamel: Naveed Massjouni <[email protected]>

jasonmay: Jason May <[email protected]>

jawnsy: Jonathan Yu <[email protected]>

jegade: Jens Gassmann <[email protected]>

jeneric: Eric A. Miller <[email protected]>

jesper: Jesper Krogh <[email protected]>

Jesse Sheidlower <[email protected]>

jgoulah: John Goulah <[email protected]>

jguenther: Justin Guenther <[email protected]>

jhannah: Jay Hannah <[email protected]>

jmac: Jason McIntosh <[email protected]>

jmmills: Jason M. Mills <[email protected]>

jnapiorkowski: John Napiorkowski <[email protected]>

Joe Carlson <[email protected]>

jon: Jon Schutz <[email protected]>

Jordan Metzmeier <[email protected]>

jshirley: J. Shirley <[email protected]>

kaare: Kaare Rasmussen

kd: Kieren Diment <[email protected]>

kentnl: Kent Fredric <[email protected]>

kkane: Kevin L. Kane <[email protected]>

konobi: Scott McWhirter <[email protected]>

lejeunerenard: Sean Zellmer <[email protected]>

littlesavage: Alexey Illarionov <[email protected]>

lukes: Luke Saunders <[email protected]>

marcus: Marcus Ramberg <[email protected]>

mateu: Mateu X. Hunter <[email protected]>

Matt LeBlanc <[email protected]>

Matt Sickler <[email protected]>

mattlaw: Matt Lawrence

mattp: Matt Phillips <[email protected]>

mdk: Mark Keating <[email protected]>

melo: Pedro Melo <[email protected]>

metaperl: Terrence Brannon <[email protected]>

michaelr: Michael Reddick <[email protected]>

milki: Jonathan Chu <[email protected]>

minty: Murray Walker <[email protected]>

mithaldu: Christian Walde <[email protected]>

mjemmeson: Michael Jemmeson <[email protected]>

mna: Maya

mo: Moritz Onken <[email protected]>

moltar: Roman Filippov <[email protected]>

moritz: Moritz Lenz <[email protected]>

mrf: Mike Francis <[email protected]>

mst: Matt S. Trout <[email protected]>

mstratman: Mark A. Stratman <[email protected]>

ned: Neil de Carteret <[email protected]>

nigel: Nigel Metheringham <[email protected]>

ningu: David Kamholz <[email protected]>

Nniuq: Ron "Quinn" Straight" <[email protected]>

norbi: Norbert Buchmuller <[email protected]>

nothingmuch: Yuval Kogman <[email protected]>

nuba: Nuba Princigalli <[email protected]>

Numa: Dan Sully <[email protected]>

oalders: Olaf Alders <[email protected]>

Olly Betts <[email protected]>

osfameron: Hakim Cassimally <[email protected]>

ovid: Curtis "Ovid" Poe <[email protected]>

oyse: Øystein Torget <[email protected]>

paulm: Paul Makepeace <[email protected]>

penguin: K J Cheetham <[email protected]>

perigrin: Chris Prather <[email protected]>

Peter Siklósi <[email protected]>

Peter Valdemar Mørch <[email protected]>

peter: Peter Collingbourne <[email protected]>

phaylon: Robert Sedlacek <[email protected]>

plu: Johannes Plunien <[email protected]>

pmooney: Paul Mooney <[email protected]>

Possum: Daniel LeWarne <[email protected]>

pplu: Jose Luis Martinez <[email protected]>

quicksilver: Jules Bean <[email protected]>

racke: Stefan Hornburg <[email protected]>

rafl: Florian Ragwitz <[email protected]>

rainboxx: Matthias Dietrich <[email protected]>

rbo: Robert Bohne <[email protected]>

rbuels: Robert Buels <[email protected]>

rdj: Ryan D Johnson <[email protected]>

Relequestual: Ben Hutton <[email protected]>

renormalist: Steffen Schwigon <[email protected]>

ribasushi: Peter Rabbitson <[email protected]>

rjbs: Ricardo Signes <[email protected]>

Robert Krimen <[email protected]>

Robert Olson <[email protected]>

robkinyon: Rob Kinyon <[email protected]>

Roman Ardern-Corris <[email protected]>

ruoso: Daniel Ruoso <[email protected]>

Sadrak: Felix Antonius Wilhelm Ostmann <[email protected]>

sc_: Just Another Perl Hacker

schwern: Michael G Schwern <[email protected]>

Scott R. Godin <[email protected]>

scotty: Scotty Allen <[email protected]>

semifor: Marc Mims <[email protected]>

Simon Elliott <[email protected]>

SineSwiper: Brendan Byrd <[email protected]>

skaufman: Samuel Kaufman <[email protected]>

solomon: Jared Johnson <[email protected]>

spb: Stephen Bennett <[email protected]>

Squeeks <[email protected]>

srezic: Slaven Rezic <[email protected]>

sszabo: Stephan Szabo <[email protected]>

Stephen Peters <[email protected]>

stonecolddevin: Devin Austin <[email protected]>

talexb: Alex Beamish <[email protected]>

tamias: Ronald J Kimball <[email protected]>

TBSliver: Tom Bloor <[email protected]>

teejay: Aaron Trevena <[email protected]>

theorbtwo: James Mastros <[email protected]>

Thomas Kratz <[email protected]>

timbunce: Tim Bunce <[email protected]>

tinita: Tina Mueller <[email protected]>

Todd Lipcon

Tom Hukins <[email protected]>

tommy: Tommy Butler <[email protected]>

tonvoon: Ton Voon <[email protected]>

triode: Pete Gamache <[email protected]>

typester: Daisuke Murase <[email protected]>

uree: Oriol Soriano <[email protected]>

uwe: Uwe Voelker <[email protected]>

vanstyn: Henry Van Styn <[email protected]>

victori: Victor Igumnov <[email protected]>

wdh: Will Hawes <[email protected]>

wesm: Wes Malone <[email protected]>

willert: Sebastian Willert <[email protected]>

wintermute: Toby Corkindale <[email protected]>

wreis: Wallace Reis <[email protected]>

x86-64 <[email protected]>

xenoterracide: Caleb Cushing <[email protected]>

xmikew: Mike Wisener <[email protected]>

yrlnry: Mark Jason Dominus <[email protected]>

zamolxes: Bogdan Lucaciu <[email protected]>

Zefram: Andrew Main <[email protected]>

The canonical source of authors and their details is the AUTHORS file at
the root of this distribution (or repository). The canonical source of
per-line authorship is the git repository history itself.

COPYRIGHT AND LICENSE
Copyright (c) 2005 by mst, castaway, ribasushi, and other DBIx::Class
"AUTHORS" as listed above and in AUTHORS.

This library is free software and may be distributed under the same
terms as perl5 itself. See LICENSE for the complete licensing terms.