X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FUUIDColumns.pm;h=b4af9ba5390bf8467f9ee3f371bb0d0c16764d3f;hb=7408ffa3c76c0e4476c5a6a1f076a09a375de79b;hp=7eca6bb134049a359d5d7021f73cdfa883f6047d;hpb=773544fd3440aba91e3a5ea2246e7818b895ce30;p=dbsrgits%2FDBIx-Class-UUIDColumns.git diff --git a/lib/DBIx/Class/UUIDColumns.pm b/lib/DBIx/Class/UUIDColumns.pm index 7eca6bb..b4af9ba 100644 --- a/lib/DBIx/Class/UUIDColumns.pm +++ b/lib/DBIx/Class/UUIDColumns.pm @@ -14,9 +14,8 @@ __PACKAGE__->uuid_class( __PACKAGE__->_find_uuid_module ); # 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.06002'; +$VERSION = '0.01000'; -# be compatible with Class::DBI::UUID sub uuid_columns { my $self = shift; for (@_) { @@ -73,7 +72,7 @@ sub _find_uuid_module { } elsif (eval{require Win32API::GUID}) { return '::Win32API::GUID'; } else { - shift->throw_exception('no suitable uuid module could be found') + die 'no suitable uuid module could be found for use with DBIx::Class::UUIDColumns'; }; }; @@ -86,14 +85,17 @@ DBIx::Class::UUIDColumns - Implicit uuid columns =head1 SYNOPSIS - package Artist; - __PACKAGE__->load_components(qw/UUIDColumns Core DB/); - __PACKAGE__->uuid_columns( 'artist_id' ); +In your L table class: + + __PACKAGE__->load_components(qw/UUIDColumns ... Core/); + __PACKAGE__->uuid_columns('artist_id'); + +B The component needs to be loaded I Core. =head1 DESCRIPTION -This L component resembles the behaviour of -L, to make some columns implicitly created as uuid. +This L component resembles the behaviour of L, +to make some columns implicitly created as uuid. When loaded, C will search for a suitable uuid generation module from the following list of supported modules: @@ -109,35 +111,41 @@ If no supporting module can be found, an exception will be thrown. *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: +If you would like to use a specific module, you can set L: __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. + +=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::UUIDColumns::UUIDMaker subclasses: +that matches one of the available L 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 chacks to see that the specified class isa -DBIx::Class::UUIDColumns::UUIDMaker subbclass and throws and exception if it isn't. +L subbclass and throws and exception if it isn't. =head2 uuid_maker @@ -149,9 +157,12 @@ Returns the current UUIDMaker instance for the given module. L -=head1 AUTHORS +=head1 AUTHOR Chia-liang Kao + +=head1 CONTRIBUTERS + Chris Laco =head1 LICENSE