NAME

Acme::CPANModules::UUID - Modules that can generate immutable universally unique identifier (UUIDs)

VERSION

This document describes version 0.007 of Acme::CPANModules::UUID (from Perl distribution Acme-CPANModules-UUID), released on 2021-01-20.

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 bencher or run bencher --help.

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 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 random/pseudo-random number; version 3 (v3) UUIDs from hashing a namespace using MD5; version 5 (v5) from hashing a namespace using SHA-1.

Data::UUID should be your first choice, and when you cannot install XS modules you can use UUID::Tiny instead.

Aside from the modules listed as entries below, there are also: App::UUIDUtils (containing CLIs to create/check UUID).

BENCHMARKED MODULES

Version numbers shown below are the versions used when running the sample benchmark.

Data::UUID 1.224

UUID::Tiny 1.04

UUID::Random 0.04

UUID::Random::PERLANCAR 0.005

UUID::Random::Secure 0.003

Crypt::Misc 0.069

BENCHMARK PARTICIPANTS

Data::UUID (perl_code)

Code template:

 my $u = Data::UUID->new; $u->create for 1..1000; $u->to_string($u->create)

UUID::Tiny (perl_code)

Code template:

 UUID::Tiny::create_uuid() for 1..1000; UUID::Tiny::uuid_to_string(UUID::Tiny::create_uuid())

UUID::Random (perl_code)

Code template:

 UUID::Random::generate() for 1..1000; ; UUID::Random::generate()

UUID::Random::PERLANCAR::generate (perl_code)

Code template:

 UUID::Random::PERLANCAR::generate() for 1..1000; UUID::Random::PERLANCAR::generate()

UUID::Random::PERLANCAR::generate_rfc (perl_code)

Code template:

 UUID::Random::PERLANCAR::generate_rfc() for 1..1000; UUID::Random::PERLANCAR::generate_rfc()

UUID::Random::Secure::generate (perl_code)

Code template:

 UUID::Random::Secure::generate() for 1..1000; UUID::Random::Secure::generate()

UUID::Random::Secure::generate_rfc (perl_code)

Code template:

 UUID::Random::Secure::generate_rfc() for 1..1000; UUID::Random::Secure::generate_rfc()

Crypt::Misc (perl_code)

Code template:

 Crypt::Misc::random_v4uuid() for 1..1000; Crypt::Misc::random_v4uuid()

SAMPLE BENCHMARK RESULTS

Run on: perl: v5.30.0, CPU: Intel(R) Core(TM) i5-7200U CPU @ 2.50GHz (2 cores), OS: GNU/Linux Ubuntu version 19.10, OS kernel: Linux version 5.3.0-64-generic.

Benchmark with default options (bencher --cpanmodules-module UUID):

 #table1#
 +---------------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
 | participant                           | rate (/s) | time (ms) | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors | samples |
 +---------------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+
 | UUID::Random::Secure::generate_rfc    |        47 |    21     |                 0.00% |              5170.91% | 4.4e-05 |      20 |
 | UUID::Random::Secure::generate        |        48 |    21     |                 1.57% |              5089.54% | 5.8e-05 |      20 |
 | UUID::Random                          |       110 |     8.7   |               144.09% |              2059.42% | 3.3e-05 |      20 |
 | UUID::Tiny                            |       150 |     6.9   |               209.41% |              1603.51% |   4e-05 |      20 |
 | Crypt::Misc                           |       280 |     3.5   |               502.44% |               774.93% | 2.1e-05 |      21 |
 | UUID::Random::PERLANCAR::generate_rfc |      1530 |     0.652 |              3171.61% |                61.11% | 1.6e-07 |      20 |
 | UUID::Random::PERLANCAR::generate     |      1860 |     0.538 |              3866.37% |                32.89% | 3.6e-07 |      21 |
 | Data::UUID                            |      2500 |     0.4   |              5170.91% |                 0.00% | 1.5e-06 |      20 |
 +---------------------------------------+-----------+-----------+-----------------------+-----------------------+---------+---------+

Benchmark module startup overhead (bencher --cpanmodules-module UUID --module-startup):

 #table2#
 +-------------------------+-----------+-------------------+-----------------------+-----------------------+-----------+---------+
 | participant             | time (ms) | mod_overhead_time | pct_faster_vs_slowest | pct_slower_vs_fastest |  errors   | samples |
 +-------------------------+-----------+-------------------+-----------------------+-----------------------+-----------+---------+
 | UUID::Random::Secure    |      90   |              83.3 |                 0.00% |              1241.53% |   0.00036 |      20 |
 | UUID::Tiny              |      24   |              17.3 |               275.89% |               256.89% | 8.1e-05   |      20 |
 | Crypt::Misc             |      18   |              11.3 |               393.94% |               171.60% | 8.1e-05   |      20 |
 | Data::UUID              |      15   |               8.3 |               506.49% |               121.19% | 6.8e-05   |      20 |
 | UUID::Random            |       8.9 |               2.2 |               917.54% |                31.84% | 5.4e-05   |      22 |
 | UUID::Random::PERLANCAR |       8.8 |               2.1 |               925.85% |                30.77% |   6e-05   |      20 |
 | perl -e1 (baseline)     |       6.7 |               0   |              1241.53% |                 0.00% | 3.8e-05   |      22 |
 +-------------------------+-----------+-------------------+-----------------------+-----------------------+-----------+---------+

To display as an interactive HTML table on a browser, you can add option --format html+datatables.

ACME::CPANMODULES FEATURE COMPARISON MATRIX

 +-------------------------+-----------+-----------+-----------+-----------+-----------+-------+-------+----------------+----------------------+
 | module                  | create_v1 | create_v2 | create_v3 | create_v4 | create_v5 | is_pp | is_xs | v4_rfc4122 *1) | v4_secure_random *2) |
 +-------------------------+-----------+-----------+-----------+-----------+-----------+-------+-------+----------------+----------------------+
 | Data::UUID              | yes       | yes       | no        | no        | no        | no    | yes   | N/A            | N/A                  |
 | UUID::Tiny              | yes       | no        | yes       | yes       | yes       | yes   | no    | yes            | no                   |
 | UUID::Random            | no        | no        | no        | yes       | no        | yes   | no    | no             | no                   |
 | UUID::Random::PERLANCAR | no        | no        | no        | yes       | no        | yes   | no    | yes            | no                   |
 | UUID::Random::Secure    | no        | no        | no        | yes       | no        | yes   | no    | yes            | yes                  |
 | Crypt::Misc             | no        | no        | no        | yes       | no        | yes   | no    | yes            | yes                  |
 +-------------------------+-----------+-----------+-----------+-----------+-----------+-------+-------+----------------+----------------------+

Notes:

1. v4_rfc4122: Whether the generated v4 UUID follows RFC 4122 specification (i.e. encodes variant and version information in M & N positions)
2. v4_secure_random: Whether the module uses cryptographically secure pseudo-random number generator for v4 UUIDs

ACME::MODULES ENTRIES

Data::UUID

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 UUID::Tiny instead.

The benchmark code creates 1000+1 v1 string UUIDs.
UUID::Tiny

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 that use Crypt::Misc.

The benchmark code creates 1000+1 v1 string UUIDs.

See also: Types::UUID which is a type library that uses Data::UUID as the backend.
UUID::Random

This module simply uses 32 calls to Perl's 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 Crypt::Misc.

The benchmark code creates 1000+1 v4 string UUIDs.
UUID::Random::PERLANCAR

Just another implementation of UUID::Random.

The benchmark code creates 1000+1 v4 string UUIDs.
UUID::Random::Secure

Just like UUID::Random, except it uses Math::Random::Secure's irand() to produce random numbers.

The benchmark code creates 1000+1 v4 string UUIDs.
Crypt::Misc

This module from the CryptX distribution has a function to create and check v4 UUIDs.

The benchmark code creates 1000+1 v4 string UUIDs.

FAQ

What is an Acme::CPANModules::* module?

An Acme::CPANModules::* module, like this module, contains just a list of module names that share a common characteristics. It is a way to categorize modules and document CPAN. See Acme::CPANModules for more details.

What are ways to use this Acme::CPANModules module?

Aside from reading this Acme::CPANModules module's POD documentation, you can install all the listed modules (entries) using cpanmodules CLI (from App::cpanmodules distribution):

    % cpanmodules ls-entries UUID | cpanm -n

or Acme::CM::Get:

    % perl -MAcme::CM::Get=UUID -E'say $_->{module} for @{ $LIST->{entries} }' | cpanm -n

or directly:

    % perl -MAcme::CPANModules::UUID -E'say $_->{module} for @{ $Acme::CPANModules::UUID::LIST->{entries} }' | cpanm -n

This Acme::CPANModules module contains benchmark instructions. You can run a benchmark for some/all the modules listed in this Acme::CPANModules module using the bencher CLI (from Bencher distribution):

    % bencher --cpanmodules-module UUID

This Acme::CPANModules module also helps lcpan produce a more meaningful result for lcpan related-mods command when it comes to finding related modules for the modules listed in this Acme::CPANModules module.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Acme-CPANModules-UUID.

SOURCE

Source repository is at https://github.com/perlancar/perl-Acme-CPANModules-UUID.

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/perlancar/perl-Acme-CPANModules-UUID/issues

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

To install Acme::CPANModules::UUID, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Acme::CPANModules::UUID

CPAN shell

perl -MCPAN -e shell
install Acme::CPANModules::UUID

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

BENCHMARKED MODULES

BENCHMARK PARTICIPANTS

SAMPLE BENCHMARK RESULTS

ACME::CPANMODULES FEATURE COMPARISON MATRIX

ACME::MODULES ENTRIES

FAQ

What is an Acme::CPANModules::* module?

What are ways to use this Acme::CPANModules module?

HOMEPAGE

SOURCE

BUGS

SEE ALSO

AUTHOR

COPYRIGHT AND LICENSE

Module Install Instructions