1 package DBIx::Class::UUIDColumns;
7 use base qw/DBIx::Class/;
9 __PACKAGE__->mk_classdata( 'uuid_auto_columns' => [] );
10 __PACKAGE__->mk_classdata( '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
22 $self->throw_exception("column $_ doesn't exist") unless $self->has_column($_);
24 $self->uuid_auto_columns(\@_);
28 my ($self, $class) = @_;
31 $class = "DBIx::Class::UUIDColumns::UUIDMaker$class" if $class =~ /^::/;
33 if (!eval "require $class") {
34 $self->throw_exception("$class could not be loaded: $@");
35 } elsif (!$class->isa('DBIx::Class::UUIDColumns::UUIDMaker')) {
36 $self->throw_exception("$class is not a UUIDMaker subclass");
38 $self->uuid_maker($class->new);
42 return ref $self->uuid_maker;
47 for my $column (@{$self->uuid_auto_columns}) {
48 $self->store_column( $column, $self->get_uuid )
49 unless defined $self->get_column( $column );
51 $self->next::method(@_);
55 return shift->uuid_maker->as_string;
58 sub _find_uuid_module {
59 if (eval{require Data::UUID}) {
60 return '::Data::UUID';
61 } elsif ($^O ne 'openbsd' && eval{require APR::UUID}) {
62 # APR::UUID on openbsd causes some as yet unfound nastiness for XS
64 } elsif (eval{require UUID}) {
67 # squelch the 'too late for INIT' warning in Win32::API::Type
69 require Win32::Guidgen;
71 return '::Win32::Guidgen';
72 } elsif (eval{require Win32API::GUID}) {
73 return '::Win32API::GUID';
75 shift->throw_exception('no suitable uuid module could be found')
84 DBIx::Class::UUIDColumns - Implicit uuid columns
88 In your L<DBIx::Class> table class:
90 __PACKAGE__->load_components(qw/UUIDColumns ... Core/);
91 __PACKAGE__->uuid_columns('artist_id');
93 B<Note:> The component needs to be loaded I<before> Core.
97 This L<DBIx::Class> component resembles the behaviour of L<Class::DBI::UUID>,
98 to make some columns implicitly created as uuid.
100 When loaded, C<UUIDColumns> will search for a suitable uuid generation module
101 from the following list of supported modules:
109 If no supporting module can be found, an exception will be thrown.
111 *APR::UUID will not be loaded under OpenBSD due to an as yet unidentified XS
114 If you would like to use a specific module, you can set L</uuid_class>:
116 __PACKAGE__->uuid_class('::Data::UUID');
117 __PACKAGE__->uuid_class('MyUUIDGenerator');
123 Returns a uuid string from the current uuid_maker.
127 Inserts a new uuid string into each column in L</uuid_columns>.
131 Takes a list of columns to be filled with uuids during insert.
133 __PACKAGE__->uuid_columns('artist_id');
137 Takes the name of a UUIDMaker subclass to be used for uuid value generation.
138 This can be a fully qualified class name, or a shortcut name starting with ::
139 that matches one of the available L<DBIx::Class::UUIDColumns::UUIDMaker> subclasses:
141 __PACKAGE__->uuid_class('CustomUUIDGenerator');
142 # loads CustomeUUIDGenerator
144 __PACKAGE__->uuid_class('::Data::UUID');
145 # loads DBIx::Class::UUIDMaker::Data::UUID;
147 Note that C<uuid_class> chacks to see that the specified class isa
148 L<DBIx::Class::UUIDColumns::UUIDMaker> subbclass and throws and exception if it isn't.
152 Returns the current UUIDMaker instance for the given module.
154 my $uuid = __PACKAGE__->uuid_maker->as_string;
158 L<DBIx::Class::UUIDColumns::UUIDMaker>
162 Chia-liang Kao <clkao@clkao.org>
166 Chris Laco <claco@chrislaco.com>
170 You may distribute this code under the same terms as Perl itself.