X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=80aacf01d5a09992e2e7a52558868b1372cbe57f;hb=refs%2Ftags%2Fv0.01001;hp=292a40543896a53c8fdc8b56c75ae3f0ecc5cc36;hpb=3469b2435b72e296830195a12e2b3e1bc5b3cc9d;p=dbsrgits%2FDBIx-Class-UUIDColumns.git diff --git a/README b/README index 292a405..80aacf0 100644 --- a/README +++ b/README @@ -1,79 +1,79 @@ -NAME - DBIx::Class::UUIDColumns - Implicit uuid columns - -SYNOPSIS - In your DBIx::Class table class: - - __PACKAGE__->load_components(qw/UUIDColumns ... Core/); - __PACKAGE__->uuid_columns('artist_id'); - - Note: The component needs to be loaded *before* Core. - -DESCRIPTION - This DBIx::Class component resembles the behaviour of Class::DBI::UUID, - to make some columns implicitly created as uuid. - - When loaded, "UUIDColumns" will search for a suitable uuid generation - module from the following list of supported modules: - - Data::UUID - APR::UUID* - UUID - Win32::Guidgen - Win32API::GUID - - 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 "uuid_class": - - __PACKAGE__->uuid_class('::Data::UUID'); - __PACKAGE__->uuid_class('MyUUIDGenerator'); - -METHODS - get_uuid - Returns a uuid string from the current uuid_maker. - - insert - Inserts a new uuid string into each column in "uuid_columns". - - uuid_columns - Takes a list of columns to be filled with uuids during insert. - - __PACKAGE__->uuid_columns('artist_id'); - - 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: - - __PACKAGE__->uuid_class('CustomUUIDGenerator'); - # loads CustomeUUIDGenerator - - __PACKAGE__->uuid_class('::Data::UUID'); - # loads DBIx::Class::UUIDMaker::Data::UUID; - - Note that "uuid_class" checks to see that the specified class isa - DBIx::Class::UUIDColumns::UUIDMaker subclass and throws and exception if - it isn't. - - uuid_maker - Returns the current UUIDMaker instance for the given module. - - my $uuid = __PACKAGE__->uuid_maker->as_string; - -SEE ALSO - DBIx::Class::UUIDColumns::UUIDMaker - -AUTHOR - Chia-liang Kao - -CONTRIBUTERS - Chris Laco - -LICENSE - You may distribute this code under the same terms as Perl itself. - +NAME + DBIx::Class::UUIDColumns - Implicit uuid columns + +SYNOPSIS + In your DBIx::Class table class: + + __PACKAGE__->load_components(qw/UUIDColumns ... Core/); + __PACKAGE__->uuid_columns('artist_id'); + + Note: The component needs to be loaded *before* Core. + +DESCRIPTION + This DBIx::Class component resembles the behaviour of Class::DBI::UUID, + to make some columns implicitly created as uuid. + + When loaded, "UUIDColumns" will search for a suitable uuid generation + module from the following list of supported modules: + + Data::UUID + APR::UUID* + UUID + Win32::Guidgen + Win32API::GUID + + 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 "uuid_class": + + __PACKAGE__->uuid_class('::Data::UUID'); + __PACKAGE__->uuid_class('MyUUIDGenerator'); + +METHODS + get_uuid + Returns a uuid string from the current uuid_maker. + + insert + Inserts a new uuid string into each column in "uuid_columns". + + uuid_columns + Takes a list of columns to be filled with uuids during insert. + + __PACKAGE__->uuid_columns('artist_id'); + + 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: + + __PACKAGE__->uuid_class('CustomUUIDGenerator'); + # loads CustomeUUIDGenerator + + __PACKAGE__->uuid_class('::Data::UUID'); + # loads DBIx::Class::UUIDMaker::Data::UUID; + + Note that "uuid_class" checks to see that the specified class isa + DBIx::Class::UUIDColumns::UUIDMaker subclass and throws and exception if + it isn't. + + uuid_maker + Returns the current UUIDMaker instance for the given module. + + my $uuid = __PACKAGE__->uuid_maker->as_string; + +SEE ALSO + DBIx::Class::UUIDColumns::UUIDMaker + +AUTHOR + Chia-liang Kao + +CONTRIBUTERS + Chris Laco + +LICENSE + You may distribute this code under the same terms as Perl itself. +