Acme-CPANModules-UUID
view release on metacpan or search on metacpan
lib/Acme/CPANModules/UUID.pm view on Meta::CPAN
package Acme::CPANModules::UUID;
use strict;
use warnings;
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2023-10-30'; # DATE
our $DIST = 'Acme-CPANModules-UUID'; # DIST
our $VERSION = '0.011'; # VERSION
our $LIST = {
summary => 'List of modules that can generate immutable universally unique identifier (UUIDs)',
description => <<'MARKDOWN',
UUIDs (Universally Unique Identifiers), sometimes also called GUIDs (Globally
Unique Identifiers), are 128-bit numbers that can be used as permanent IDs or
keys in databases. There are several standards that specify UUID, one of which
is RFC 4122 (2005), which we will follow in this document.
UUIDs are canonically represented as 32 hexadecimal digits in the form of:
xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
There are several variants of UUID. The variant information is encoded using 1-3
bits in the `N` position. RFC 4122 defines 4 variants (0 to 3), two of which (0
and 3) are for legacy UUIDs, so that leaves variants 1 and 2 as the current
specification.
There are 5 "versions" of UUID for both variants 1 & 2, each might be more
suitable than others in specific cases. The version information is encoded in
the M position. Version 1 (v1) UUIDs are generated from a time and a node ID
(usually the MAC address); version 2 (v2) UUIDs from an identifier (group/user
ID), a time, and a node ID; version 4 (v4) UUIDs from a rando/mpseudo-random
number; version 3 (v3) UUIDs from hashing a namespace using MD5; version 5 (v5)
from hashing a namespace using SHA-1.
<pm:Data::UUID> should be your first choice, and when you cannot install XS
modules you can use <pm:UUID::Tiny> instead.
Aside from the modules listed as entries below, there are also:
<pm:App::UUIDUtils> (containing CLIs to create/check UUID), <pm:Data::GUID>
(currently just a wrapper for Data::UUID).
MARKDOWN
entry_features => {
v4_rfc4122 => {summary => 'Whether the generated v4 UUID follows RFC 4122 specification (i.e. encodes variant and version information in M & N positions)'},
v4_secure_random => {summary => 'Whether the module uses cryptographically secure pseudo-random number generator for v4 UUIDs'},
},
entries => [
{
module => 'Data::UUID',
description => <<'MARKDOWN',
This module creates v1 and v2 UUIDs. Depending on the OS, for MAC address, it
usually uses a hash of hostname instead. This module is XS, so performance is
good. If you cannot use an XS module, try <pm:UUID::Tiny> instead.
The benchmark code creates 1000+1 v1 string UUIDs.
MARKDOWN
bench_code_template => 'my $u = Data::UUID->new; $u->create for 1..1000; $u->to_string($u->create)',
features => {
is_xs => 1,
is_pp => 0,
create_v1 => 1,
create_v2 => 1,
create_v3 => 0,
create_v4 => 0,
create_v5 => 0,
},
},
{
module => 'UUID::FFI',
description => <<'MARKDOWN',
This module provides access to libuuid via the FFI interface. It can create v1
as well as v4 (random) UUIDs. Note that Data::UUID (XS-based) is faster this
module (FFI-based).
The benchmark code creates 1000+1 v1 string UUIDs.
MARKDOWN
bench_code_template => 'UUID::FFI->new_time for 1..1000; UUID::FFI->new_time->as_hex',
features => {
is_xs => 1,
is_pp => 0,
create_v1 => 1,
create_v2 => 0,
create_v3 => 0,
create_v4 => 1,
v4_secure_random => 0,
v4_rfc4122 => 1,
create_v5 => 0,
},
},
{
module => 'UUID::Tiny',
description => <<'MARKDOWN',
This module should be your go-to choice if you cannot use an XS module. It can
create v1, v3, v4 UUIDs. However, the random v4 UUIDs are not cryptographically
secure; if you need cryptographically secure random UUIDs, use <pm:Crypt::Misc>.
The benchmark code creates 1000+1 v1 string UUIDs.
See also: <pm:Types::UUID> which is a type library that uses Data::UUID as the
backend.
MARKDOWN
bench_code_template => 'UUID::Tiny::create_uuid() for 1..1000; UUID::Tiny::uuid_to_string(UUID::Tiny::create_uuid())',
features => {
is_xs => 0,
is_pp => 1,
create_v1 => 1,
create_v2 => 0,
create_v3 => 1,
create_v4 => 1,
v4_secure_random => 0,
v4_rfc4122 => 1,
create_v5 => 1,
},
},
{
module => 'UUID::Random',
description => <<'MARKDOWN',
This module simply uses 32 calls to Perl's C<rand()> to construct each random
hexadecimal digits of the UUID (v4). Not really recommended, since perl's
default pseudo-random generator is neither cryptographically secure nor has 128
bit of entropy. It also does not produce v4 UUIDs that conform to RFC 4122 (no
encoding of variant & version information).
To create a cryptographically secure random UUIDs, use <pm:Crypt::Misc>.
The benchmark code creates 1000+1 v4 string UUIDs.
MARKDOWN
bench_code_template => 'UUID::Random::generate() for 1..1000; ; UUID::Random::generate()',
features => {
is_xs => 0,
is_pp => 1,
create_v1 => 0,
create_v2 => 0,
create_v3 => 0,
create_v4 => 1,
v4_secure_random => 0,
v4_rfc4122 => 0,
create_v5 => 0,
},
},
{
module => 'UUID::Random::PERLANCAR',
description => <<'MARKDOWN',
Just another implementation of <pm:UUID::Random>.
The benchmark code creates 1000+1 v4 string UUIDs.
MARKDOWN
features => {
is_xs => 0,
is_pp => 1,
create_v1 => 0,
create_v2 => 0,
create_v3 => 0,
create_v4 => 1,
v4_secure_random => 0,
v4_rfc4122 => 1,
create_v5 => 0,
},
functions => {
generate => {
bench_code_template => 'UUID::Random::PERLANCAR::generate() for 1..1000; UUID::Random::PERLANCAR::generate()',
},
generate_rfc => {
bench_code_template => 'UUID::Random::PERLANCAR::generate_rfc() for 1..1000; UUID::Random::PERLANCAR::generate_rfc()',
},
},
},
{
module => 'UUID::Random::Secure',
description => <<'MARKDOWN',
Just like <pm:UUID::Random>, except it uses <pm:Math::Random::Secure>'s
`irand()` to produce random numbers.
The benchmark code creates 1000+1 v4 string UUIDs.
MARKDOWN
features => {
is_xs => 0,
is_pp => 1,
create_v1 => 0,
create_v2 => 0,
create_v3 => 0,
create_v4 => 1,
v4_secure_random => 1,
v4_rfc4122 => 1,
create_v5 => 0,
},
functions => {
generate => {
bench_code_template => 'UUID::Random::Secure::generate() for 1..1000; UUID::Random::Secure::generate()',
},
generate_rfc => {
bench_code_template => 'UUID::Random::Secure::generate_rfc() for 1..1000; UUID::Random::Secure::generate_rfc()',
},
},
},
{
module => 'Crypt::Misc',
description => <<'MARKDOWN',
This module from the <pm:CryptX> distribution has a function to create and check
v4 UUIDs.
The benchmark code creates 1000+1 v4 string UUIDs.
MARKDOWN
bench_code_template => 'Crypt::Misc::random_v4uuid() for 1..1000; Crypt::Misc::random_v4uuid()',
features => {
is_xs => 0,
is_pp => 1,
create_v1 => 0,
create_v2 => 0,
create_v3 => 0,
create_v4 => 1,
v4_secure_random => 1,
v4_rfc4122 => 1,
create_v5 => 0,
},
},
{
module => 'UUID',
description => <<'MARKDOWN',
This module generates DCE-compatible UUIDs, which according to RFC belongs to
the legacy variants.
The benchmark creates 1000+1 random UUIDs.
MARKDOWN
bench_code_template => 'my $uuid; UUID::generate_random($uuid) for 1..1000; UUID::generate_random($uuid); $uuid',
features => {
is_xs => 1,
is_pp => 0,
create_v1 => 0,
create_v2 => 0,
create_v3 => 0,
create_v4 => 0,
v4_secure_random => 0,
v4_rfc4122 => 0,
create_v5 => 0,
create_legacy => 1,
},
},
],
};
1;
# ABSTRACT: List of modules that can generate immutable universally unique identifier (UUIDs)
__END__
=pod
=encoding UTF-8
=head1 NAME
Acme::CPANModules::UUID - List of modules that can generate immutable universally unique identifier (UUIDs)
=head1 VERSION
This document describes version 0.011 of Acme::CPANModules::UUID (from Perl distribution Acme-CPANModules-UUID), released on 2023-10-30.
=head1 SYNOPSIS
To run benchmark with default option:
% bencher --cpanmodules-module UUID
To run module startup overhead benchmark:
% bencher --module-startup --cpanmodules-module UUID
For more options (dump scenario, list/include/exclude/add participants, list/include/exclude/add datasets, etc), see L<bencher> or run C<bencher --help>.
=head1 DESCRIPTION
UUIDs (Universally Unique Identifiers), sometimes also called GUIDs (Globally
Unique Identifiers), are 128-bit numbers that can be used as permanent IDs or
keys in databases. There are several standards that specify UUID, one of which
is RFC 4122 (2005), which we will follow in this document.
UUIDs are canonically represented as 32 hexadecimal digits in the form of:
xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
There are several variants of UUID. The variant information is encoded using 1-3
bits in the C<N> position. RFC 4122 defines 4 variants (0 to 3), two of which (0
and 3) are for legacy UUIDs, so that leaves variants 1 and 2 as the current
specification.
lib/Acme/CPANModules/UUID.pm view on Meta::CPAN
benchmark for some/all the modules listed in this Acme::CPANModules module using
the L<bencher> CLI (from L<Bencher> distribution):
% bencher --cpanmodules-module UUID
This Acme::CPANModules module also helps L<lcpan> produce a more meaningful
result for C<lcpan related-mods> command when it comes to finding related
modules for the modules listed in this Acme::CPANModules module.
See L<App::lcpan::Cmd::related_mods> for more details on how "related modules"
are found.
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Acme-CPANModules-UUID>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-Acme-CPANModules-UUID>.
=head1 SEE ALSO
L<Acme::CPANModules> - about the Acme::CPANModules namespace
L<cpanmodules> - CLI tool to let you browse/view the lists
RFC 4122, L<https://tools.ietf.org/html/rfc4122>
L<https://en.wikipedia.org/wiki/Universally_unique_identifier>
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 CONTRIBUTING
To contribute, you can send patches by email/via RT, or send pull requests on
GitHub.
Most of the time, you don't need to build the distribution yourself. You can
simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your
system), you can install L<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<Pod::Weaver::PluginBundle::Author::PERLANCAR>, and sometimes one or two other
Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond
that are considered a bug and can be reported to me.
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2023, 2021, 2020 by perlancar <perlancar@cpan.org>.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Acme-CPANModules-UUID>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=cut
( run in 2.566 seconds using v1.01-cache-2.11-cpan-39bf76dae61 )