1 package DBIx::Class::UUIDColumns;
7 use base qw/DBIx::Class Class::Accessor::Grouped/;
9 __PACKAGE__->mk_group_accessors('inherited', qw/uuid_auto_columns uuid_maker/);
11 __PACKAGE__->uuid_class(__PACKAGE__->_find_uuid_module);
13 # Always remember to do all digits for the version even if they're 0
14 # i.e. first release of 0.XX *must* be 0.XX000. This avoids fBSD ports
15 # brain damage and presumably various other packaging systems too
24 $self->throw_exception("column $_ doesn't exist") unless $self->has_column($_);
26 $self->uuid_auto_columns(\@_);
29 return $self->uuid_auto_columns || [];
33 my ($self, $class) = @_;
36 $class = "DBIx::Class::UUIDColumns::UUIDMaker$class" if $class =~ /^::/;
38 if (!eval "require $class") {
39 $self->throw_exception("$class could not be loaded: $@");
40 } elsif (!$class->isa('DBIx::Class::UUIDColumns::UUIDMaker')) {
41 $self->throw_exception("$class is not a UUIDMaker subclass");
43 $self->uuid_maker($class->new);
47 return ref $self->uuid_maker;
52 for my $column (@{$self->uuid_columns}) {
53 $self->store_column( $column, $self->get_uuid )
54 unless defined $self->get_column( $column );
56 $self->next::method(@_);
60 return shift->uuid_maker->as_string;
63 sub _find_uuid_module {
64 if (eval{require Data::UUID}) {
65 return '::Data::UUID';
66 } elsif (eval{require Data::GUID}) {
67 return '::Data::GUID';
68 } elsif ($^O ne 'openbsd' && eval{require APR::UUID}) {
69 # APR::UUID on openbsd causes some as yet unfound nastiness for XS
71 } elsif (eval{require UUID}) {
74 # squelch the 'too late for INIT' warning in Win32::API::Type
76 require Win32::Guidgen;
78 return '::Win32::Guidgen';
79 } elsif (eval{require Win32API::GUID}) {
80 return '::Win32API::GUID';
81 } elsif (eval{require UUID::Random}) {
82 return '::UUID::Random';
84 die 'no suitable uuid module could be found for use with DBIx::Class::UUIDColumns';
93 DBIx::Class::UUIDColumns - Implicit uuid columns
97 In your L<DBIx::Class> table class:
99 __PACKAGE__->load_components(qw/UUIDColumns ... Core/);
100 __PACKAGE__->uuid_columns('artist_id');
102 B<Note:> The component needs to be loaded I<before> Core.
106 This L<DBIx::Class> component resembles the behaviour of L<Class::DBI::UUID>,
107 to make some columns implicitly created as uuid.
109 When loaded, C<UUIDColumns> will search for a suitable uuid generation module
110 from the following list of supported modules:
118 If no supporting module can be found, an exception will be thrown.
120 *APR::UUID will not be loaded under OpenBSD due to an as yet unidentified XS
123 If you would like to use a specific module, you can set L</uuid_class>:
125 __PACKAGE__->uuid_class('::Data::UUID');
126 __PACKAGE__->uuid_class('MyUUIDGenerator');
132 Returns a uuid string from the current uuid_maker.
136 Inserts a new uuid string into each column in L</uuid_columns>.
140 Gets/sets the list of columns to be filled with uuids during insert.
142 __PACKAGE__->uuid_columns('artist_id');
146 Takes the name of a UUIDMaker subclass to be used for uuid value generation.
147 This can be a fully qualified class name, or a shortcut name starting with ::
148 that matches one of the available L<DBIx::Class::UUIDColumns::UUIDMaker> subclasses:
150 __PACKAGE__->uuid_class('CustomUUIDGenerator');
151 # loads CustomeUUIDGenerator
153 __PACKAGE__->uuid_class('::Data::UUID');
154 # loads DBIx::Class::UUIDMaker::Data::UUID;
156 Note that C<uuid_class> checks to see that the specified class isa
157 L<DBIx::Class::UUIDColumns::UUIDMaker> subclass and throws and exception if it isn't.
161 Returns the current UUIDMaker instance for the given module.
163 my $uuid = __PACKAGE__->uuid_maker->as_string;
167 L<DBIx::Class::UUIDColumns::UUIDMaker>
171 Chia-liang Kao <clkao@clkao.org>
175 Chris Laco <claco@chrislaco.com>
179 You may distribute this code under the same terms as Perl itself.