use strict;
use warnings;
+use vars qw($VERSION);
use base qw/DBIx::Class/;
__PACKAGE__->mk_classdata( 'uuid_auto_columns' => [] );
__PACKAGE__->mk_classdata( 'uuid_maker' );
__PACKAGE__->uuid_class( __PACKAGE__->_find_uuid_module );
-# be compatible with Class::DBI::UUID
+# Always remember to do all digits for the version even if they're 0
+# i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
+# brain damage and presumably various other packaging systems too
+
+$VERSION = '0.01000';
+
sub uuid_columns {
my $self = shift;
for (@_) {
my ($self, $class) = @_;
if ($class) {
- $class = "DBIx::Class::UUIDMaker$class" if $class =~ /^::/;
+ $class = "DBIx::Class::UUIDColumns::UUIDMaker$class" if $class =~ /^::/;
if (!eval "require $class") {
$self->throw_exception("$class could not be loaded: $@");
- } elsif (!$class->isa('DBIx::Class::UUIDMaker')) {
+ } elsif (!$class->isa('DBIx::Class::UUIDColumns::UUIDMaker')) {
$self->throw_exception("$class is not a UUIDMaker subclass");
} else {
$self->uuid_maker($class->new);
=head1 SYNOPSIS
- package Artist;
- __PACKAGE__->load_components(qw/UUIDColumns Core DB/);
- __PACKAGE__->uuid_columns( 'artist_id' );
+In your L<DBIx::Class> table class:
+
+ __PACKAGE__->load_components(qw/UUIDColumns ... Core/);
+ __PACKAGE__->uuid_columns('artist_id');
+
+B<Note:> The component needs to be loaded I<before> Core.
=head1 DESCRIPTION
-This L<DBIx::Class> component resembles the behaviour of
-L<Class::DBI::UUID>, to make some columns implicitly created as uuid.
+This L<DBIx::Class> component resembles the behaviour of L<Class::DBI::UUID>,
+to make some columns implicitly created as uuid.
When loaded, C<UUIDColumns> will search for a suitable uuid generation module
from the following list of supported modules:
*APR::UUID will not be loaded under OpenBSD due to an as yet unidentified XS
issue.
-If you would like to use a specific module, you can set C<uuid_class>:
+If you would like to use a specific module, you can set L</uuid_class>:
__PACKAGE__->uuid_class('::Data::UUID');
__PACKAGE__->uuid_class('MyUUIDGenerator');
-Note that the component needs to be loaded before Core.
-
=head1 METHODS
-=head2 uuid_columns(@columns)
+=head2 get_uuid
+
+Returns a uuid string from the current uuid_maker.
+
+=head2 insert
+
+Inserts a new uuid string into each column in L</uuid_columns>.
+
+=head2 uuid_columns
Takes a list of columns to be filled with uuids during insert.
- __PACKAGE__->uuid_columns('id');
+ __PACKAGE__->uuid_columns('artist_id');
-=head2 uuid_class($classname)
+=head2 uuid_class
Takes the name of a UUIDMaker subclass to be used for uuid value generation.
This can be a fully qualified class name, or a shortcut name starting with ::
-that matches one of the available DBIx::Class::UUIDMaker subclasses:
+that matches one of the available L<DBIx::Class::UUIDColumns::UUIDMaker> subclasses:
__PACKAGE__->uuid_class('CustomUUIDGenerator');
# loads CustomeUUIDGenerator
- __PACKAGE->uuid_class('::Data::UUID');
+ __PACKAGE__->uuid_class('::Data::UUID');
# loads DBIx::Class::UUIDMaker::Data::UUID;
Note that C<uuid_class> chacks to see that the specified class isa
-DBIx::Class::UUIDMaker subbclass and throws and exception if it isn't.
+L<DBIx::Class::UUIDColumns::UUIDMaker> subbclass and throws and exception if it isn't.
=head2 uuid_maker
=head1 SEE ALSO
-L<DBIx::Class::UUIDMaker>
+L<DBIx::Class::UUIDColumns::UUIDMaker>
=head1 AUTHORS