VERSION
Version 1.001000
NAME
DBIx::Class::Fixtures
SYNOPSIS
use DBIx::Class::Fixtures;
...
my $fixtures = DBIx::Class::Fixtures->new({ config_dir => '/home/me/app/fixture_configs' });
$fixtures->dump({
config => 'set_config.json',
schema => $source_dbic_schema,
directory => '/home/me/app/fixtures'
});
$fixtures->populate({
directory => '/home/me/app/fixtures',
ddl => '/home/me/app/sql/ddl.sql',
connection_details => ['dbi:mysql:dbname=app_dev', 'me', 'password'],
post_ddl => '/home/me/app/sql/post_ddl.sql',
});DESCRIPTION
Dump fixtures from source database to filesystem then import to another database (with same schema) at any time. Use as a constant dataset for running tests against or for populating development databases when impractical to use production clones. Describe fixture set using relations and conditions based on your DBIx::Class schema.
DEFINE YOUR FIXTURE SET
Fixture sets are currently defined in .json files which must reside in your config_dir (e.g. /home/me/app/fixture_configs/a_fixture_set.json). They describe which data to pull and dump from the source database.
For example:
{
sets: [{
class: 'Artist',
ids: ['1', '3']
}, {
class: 'Producer',
ids: ['5'],
fetch: [{
rel: 'artists',
quantity: '2'
}]
}]
}This will fetch artists with primary keys 1 and 3, the producer with primary key 5 and two of producer 5's artists where 'artists' is a has_many DBIx::Class rel from Producer to Artist.
The top level attributes are as follows:
sets
Sets must be an array of hashes, as in the example given above. Each set defines a set of objects to be included in the fixtures. For details on valid set attributes see "SET ATTRIBUTES" below.
rules
Rules place general conditions on classes. For example if whenever an artist was dumped you also wanted all of their cds dumped too, then you could use a rule to specify this. For example:
{
sets: [{
class: 'Artist',
ids: ['1', '3']
}, {
class: 'Producer',
ids: ['5'],
fetch: [{
rel: 'artists',
quantity: '2'
}]
}],
rules: {
Artist: {
fetch: [{
rel: 'cds',
quantity: 'all'
}]
}
}
}In this case all the cds of artists 1, 3 and all producer 5's artists will be dumped as well. Note that 'cds' is a has_many DBIx::Class relation from Artist to CD. This is eqivalent to:
{
sets: [{
class: 'Artist',
ids: ['1', '3'],
fetch: [{
rel: 'cds',
quantity: 'all'
}]
}, {
class: 'Producer',
ids: ['5'],
fetch: [{
rel: 'artists',
quantity: '2',
fetch: [{
rel: 'cds',
quantity: 'all'
}]
}]
}]
}rules must be a hash keyed by class name.
includes
To prevent repetition between configs you can include other configs. For example:
{
sets: [{
class: 'Producer',
ids: ['5']
}],
includes: [{
file: 'base.json'
}]
}Includes must be an arrayref of hashrefs where the hashrefs have key 'file' which is the name of another config file in the same directory. The original config is merged with its includes using Hash::Merge.
datetime_relative
Only available for MySQL and PostgreSQL at the moment, must be a value that DateTime::Format::* can parse. For example:
{
sets: [{
class: 'RecentItems',
ids: ['9']
}],
datetime_relative : "2007-10-30 00:00:00"
}This will work when dumping from a MySQL database and will cause any datetime fields (where datatype => 'datetime' in the column def of the schema class) to be dumped as a DateTime::Duration object relative to the date specified in the datetime_relative value. For example if the RecentItem object had a date field set to 2007-10-25, then when the fixture is imported the field will be set to 5 days in the past relative to the current time.
might_have
Specifies whether to automatically dump might_have relationships. Should be a hash with one attribute - fetch. Set fetch to 1 or 0.
{
might_have: {
fetch: 1
},
sets: [{
class: 'Artist',
ids: ['1', '3']
}, {
class: 'Producer',
ids: ['5']
}]
}Note: belongs_to rels are automatically dumped whether you like it or not, this is to avoid FKs to nowhere when importing. General rules on has_many rels are not accepted at this top level, but you can turn them on for individual sets - see "SET ATTRIBUTES".
SET ATTRIBUTES
class
Required attribute. Specifies the DBIx::Class object class you wish to dump.
ids
Array of primary key ids to fetch, basically causing an $rs->find($_) for each. If the id is not in the source db then it just won't get dumped, no warnings or death.
quantity
Must be either an integer or the string 'all'. Specifying an integer will effectively set the 'rows' attribute on the resultset clause, specifying 'all' will cause the rows attribute to be left off and for all matching rows to be dumped. There's no randomising here, it's just the first x rows.
cond
A hash specifying the conditions dumped objects must match. Essentially this is a JSON representation of a DBIx::Class search clause. For example:
{
sets: [{
class: 'Artist',
quantiy: 'all',
cond: { name: 'Dave' }
}]
}This will dump all artists whose name is 'dave'. Essentially $artist_rs->search({ name => 'Dave' })->all.
Sometimes in a search clause it's useful to use scalar refs to do things like:
$artist_rs->search({ no1_singles => \'> no1_albums' })
This could be specified in the cond hash like so:
{
sets: [{
class: 'Artist',
quantiy: 'all',
cond: { no1_singles: '\> no1_albums' }
}]
}So if the value starts with a backslash the value is made a scalar ref before being passed to search.
join
An array of relationships to be used in the cond clause.
{
sets: [{
class: 'Artist',
quantiy: 'all',
cond: { 'cds.position': { '>': 4 } },
join: ['cds']
}]
}Fetch all artists who have cds with position greater than 4.
fetch
Must be an array of hashes. Specifies which rels to also dump. For example:
{
sets: [{
class: 'Artist',
ids: ['1', '3'],
fetch: [{
rel: 'cds',
quantity: '3',
cond: { position: '2' }
}]
}]
}Will cause the cds of artists 1 and 3 to be dumped where the cd position is 2.
Valid attributes are: 'rel', 'quantity', 'cond', 'has_many', 'might_have' and 'join'. rel is the name of the DBIx::Class rel to follow, the rest are the same as in the set attributes. quantity is necessary for has_many relationships, but not if using for belongs_to or might_have relationships.
has_many
Specifies whether to fetch has_many rels for this set. Must be a hash containing keys fetch and quantity.
Set fetch to 1 if you want to fetch them, and quantity to either 'all' or an integer.
Be careful here, dumping has_many rels can lead to a lot of data being dumped.
might_have
As with has_many but for might_have relationships. Quantity doesn't do anything in this case.
This value will be inherited by all fetches in this set. This is not true for the has_many attribute.
RULE ATTRIBUTES
cond
Same as with "SET ATTRIBUTES"
fetch
Same as with "SET ATTRIBUTES"
join
Same as with "SET ATTRIBUTES"
has_many
Same as with "SET ATTRIBUTES"
might_have
Same as with "SET ATTRIBUTES"
METHODS
new
Returns a new DBIx::Class::Fixture object. %attrs has only two valid keys at the moment - 'debug' which determines whether to be verbose and 'config_dir' which is required and much contain a valid path to the directory in which your .json configs reside.
my $fixtures = DBIx::Class::Fixtures->new({ config_dir => '/home/me/app/fixture_configs' });dump
$fixtures->dump({
config => 'set_config.json', # config file to use. must be in the config directory specified in the constructor
schema => $source_dbic_schema,
directory => '/home/me/app/fixtures' # output directory
});
or
$fixtures->dump({
all => 1, # just dump everything that's in the schema
schema => $source_dbic_schema,
directory => '/home/me/app/fixtures' # output directory
});In this case objects will be dumped to subdirectories in the specified directory. For example:
/home/me/app/fixtures/artist/1.fix
/home/me/app/fixtures/artist/3.fix
/home/me/app/fixtures/producer/5.fixschema and directory are required attributes. also, one of config or all must be specified.
populate
$fixtures->populate({
directory => '/home/me/app/fixtures', # directory to look for fixtures in, as specified to dump
ddl => '/home/me/app/sql/ddl.sql', # DDL to deploy
connection_details => ['dbi:mysql:dbname=app_dev', 'me', 'password'], # database to clear, deploy and then populate
post_ddl => '/home/me/app/sql/post_ddl.sql', # DDL to deploy after populating records, ie. FK constraints
cascade => 1, # use CASCADE option when dropping tables
});In this case the database app_dev will be cleared of all tables, then the specified DDL deployed to it, then finally all fixtures found in /home/me/app/fixtures will be added to it. populate will generate its own DBIx::Class schema from the DDL rather than being passed one to use. This is better as custom insert methods are avoided which can to get in the way. In some cases you might not have a DDL, and so this method will eventually allow a $schema object to be passed instead.
If needed, you can specify a post_ddl attribute which is a DDL to be applied after all the fixtures have been added to the database. A good use of this option would be to add foreign key constraints since databases like Postgresql cannot disable foreign key checks.
If your tables have foreign key constraints you may want to use the cascade attribute which will make the drop table functionality cascade, ie 'DROP TABLE $table CASCADE'.
directory, dll and connection_details are all required attributes.
AUTHOR
Luke Saunders <luke@shadowcatsystems.co.uk>
Initial development sponsored by and (c) Takkle, Inc. 2007CONTRIBUTORS
Ash Berlin <ash@shadowcatsystems.co.uk>
Matt S. Trout <mst@shadowcatsystems.co.uk>
Drew Taylor <taylor.andrew.j@gmail.com>LICENSE
This library is free software under the same license as perl itself